https://github.com/djsilva99/heatrapy

Python library for simulating heat transfer processes
https://github.com/djsilva99/heatrapy

python-library thermal-objects

Last synced: 16 days ago
JSON representation

Python library for simulating heat transfer processes

• Host: GitHub
• URL: https://github.com/djsilva99/heatrapy
• Owner: djsilva99
• License: mit
• Created: 2017-07-03T11:00:33.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-08-22T23:52:34.000Z (7 months ago)
• Last Synced: 2026-02-14T20:21:12.001Z (23 days ago)
• Topics: python-library, thermal-objects
• Language: Python
• Homepage: https://djsilva99.github.io/heatrapy
• Size: 6.82 MB
• Stars: 94
• Watchers: 1
• Forks: 14
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
#  heatrapy

[![pypi](https://badge.fury.io/py/heatrapy.svg)](https://badge.fury.io/py/heatrapy)

[![Downloads](https://pepy.tech/badge/heatrapy)](https://pepy.tech/project/heatrapy)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/djsilva99/heatrapy/blob/master/LICENSE)

[![SoftwareX Paper](https://img.shields.io/badge/DOI-10.1016%2Fj.softx.2018.09.007-blue)](https://doi.org/10.1016/j.softx.2018.09.007)

[![Documentation Status](https://readthedocs.org/projects/heatrapy/badge/?version=latest)](https://heatrapy.readthedocs.io/en/latest/?badge=latest)

[![codecov](https://codecov.io/github/djsilva99/heatrapy/graph/badge.svg?token=5UKJZ8SPVI)](https://codecov.io/github/djsilva99/heatrapy)

Heatrapy is a lightweight Python framework for simulating heat transfer using

finite-difference methods, with built-in support for phase transitions and

caloric materials.

Features:

- ✅ Easy to learn

- ✅ Finite-difference heat transfer solver

- ✅ 1D and 2D thermal simulations

- ✅ Phase-change materials

- ✅ Caloric effects modeling

- ✅ Multi-material systems

- ✅ Real-time visualization

- ✅ Pure Python implementation

### 🚀 Why Heatrapy?

Heatrapy makes thermal simulations accessible without heavy FEM or CFD

frameworks.

Perfect for:

- Research prototypes

- Teaching heat transfer

- Rapid thermal modeling

- Solid-state cooling simulations

### 🎬 Example Simulation

![heatrapy-example](https://github.com/djsilva99/heatrapy/blob/master/img/example.gif)

### ⚡ Quick Installation

To install heatrapy use the pip package manager:

```bash

$ pip install heatrapy

```

To import the heatrapy module type in the python shell:

```python

>>> import heatrapy as htp

```

See the example above or explore the documentation for complete tutorials.

### 📖 Documentation

Full documentation available

[here](https://heatrapy.readthedocs.io/en/latest/index.html)

### 🤝 Contributions

Contributions of all kinds are welcome!

Please see the development workflow

[here](https://github.com/djsilva99/heatrapy/blob/master/CONTRIBUTING.md).

If heatrapy contributes to research that leads to a publication, please cite this

paper.

⭐ If you find heatrapy useful, consider starring the repository to support the

project.