fairyfly-core 0.2.5

A library to represent construction detail geometry for environmental simulation.

fairyfly-core

Fairyfly is a collection of Python libraries to create representations of construction details following fairyfly-schema.

This package is the core library that provides fairyfly's common functionalities. To extend these functionalities you should install available Fairyfly extensions or write your own.

Here are a number of frequently used extensions for Fairyfly:

• fairyfly-therm: Adds LBNL THERM simulation to Fairyfly.

Installation

To install the core library use:

pip install -U fairyfly-core

To check if Fairyfly command line interface is installed correctly use fairyfly viz and you should get a viiiiiiiiiiiiizzzzzzzzz! back in response! :bee:

API Documentation

Local Development

1. Clone this repo locally

git clone [e-mail]:ladybug-tools/fairyfly-core.git

# or

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

2. Install dependencies:

cd fairyfly-core
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
sphinx-build -b html ./docs ./docs/_build/docs