https://github.com/ladybug-tools/fairyfly-therm

:ant: :rainbow: Fairyfly extension for THERM simulation
https://github.com/ladybug-tools/fairyfly-therm

Last synced: 4 months ago
JSON representation

:ant: :rainbow: Fairyfly extension for THERM simulation

• Host: GitHub
• URL: https://github.com/ladybug-tools/fairyfly-therm
• Owner: ladybug-tools
• License: agpl-3.0
• Created: 2025-12-20T00:03:05.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2026-02-12T23:48:09.000Z (4 months ago)
• Last Synced: 2026-02-13T09:12:05.057Z (4 months ago)
• Language: Python
• Homepage: https://www.ladybug.tools/fairyfly-therm/docs/
• Size: 1.11 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![Fairyfly](https://raw.githubusercontent.com/ladybug-tools/artwork/refs/heads/master/icons_bugs/png/fairyfly-small.png)



[![Build Status](https://github.com/ladybug-tools/fairyfly-therm/workflows/CI/badge.svg)](https://github.com/ladybug-tools/fairyfly-therm/actions)

[![Python 3.10](https://img.shields.io/badge/python-3.10-pink.svg)](https://www.python.org/downloads/release/python-3100/)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)

[![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/)

[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

# fairyfly-therm

Fairyfly extension for energy modeling with LBNL THERM.

[THERM](https://windows.lbl.gov/software-tools#therm-heading) is a widely used and accepted freeware for modeling two-dimensional heat-transfer in building components such as windows, walls, foundations, etc.

## Installation

`pip install -U fairyfly-therm`

## QuickStart

```console

import fairyfly_therm

```

## [API Documentation](http://ladybug-tools.github.io/fairyfly-therm/docs)

## Local Development

1. Clone this repo locally

```console

git clone git@github.com:ladybug-tools/fairyfly-therm

# or

git clone https://github.com/ladybug-tools/fairyfly-therm

```

2. Install dependencies:

```

cd fairyfly-therm

pip install -r dev-requirements.txt

pip install -r requirements.txt

```

3. Run Tests:

```console

python -m pytest tests/

```

4. Generate Documentation:

```console

sphinx-apidoc -f -e -d 4 -o ./docs ./fairyfly_therm

sphinx-build -b html ./docs ./docs/_build/docs

```