.. heatrapy documentation master file, created by
   sphinx-quickstart on Sun Dec  1 09:39:29 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

heatrapy documentation
======================

Heatrapy stands for HEAt TRAnsfer in PYthon. It simulates dynamic 1D
and 2D heat transfer processes in solids using the finite difference
method. Heatrapy includes both the modeling of caloric effects and the
incorporation of phase transitions.

|icon_github|  `github repository <https://github.com/djsilva99/heatrapy>`_

|icon_heatrapy|  current version: v2.1.0

.. |icon_github| image:: https://github.githubassets.com/favicons/favicon.png
   :width: 25px

.. |icon_heatrapy| image:: https://raw.githubusercontent.com/djsilva99/heatrapy/refs/heads/master/img/heatrapy.png
   :width: 30px


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   info/installation
   info/thermal_object
   package/heatrapy.dimension_1
   package/heatrapy.dimension_2
   info/material_database
   info/visualization
   info/samples
   info/contribution
   info/license