fairyfly-therm 0.1.0

Fairyfly extension for translating HBJSON files to INP files for eQuest

fairyfly-therm

Fairyfly extension for energy modeling with LBNL THERM.

THERM 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

import fairyfly_therm

API Documentation

Local Development

1. Clone this repo locally

git clone [e-mail]: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:

python -m pytest tests/

4. Generate Documentation:

sphinx-apidoc -f -e -d 4 -o ./docs ./fairyfly_therm
sphinx-build -b html ./docs ./docs/_build/docs