Dragonfly is collection of libraries to model and analyze urban climate, energy use, and daylight. It extends the capabilites of honeybee-core for the urban scale.
This repository is the core repository that provides dragonfly's common functionalities. To extend these functionalities you should install available Dragonfly extensions or write your own.
Here are a number of frequently used extensions for Dragonfly:
- dragonfly-energy: Adds Energy simulation to Dragonfly.
pip install -U dragonfly-core
If you want to also include the command line interface try:
pip install -U dragonfly-core[cli]
To check if Dragonfly command line is installed correctly try dragonfly viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response!
- Clone this repo locally
git clone git@github.com:ladybug-tools/dragonfly-core.git
# or
git clone https://github.com/ladybug-tools/dragonfly-core.git- Install dependencies:
cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt- Run Tests:
python -m pytests tests/- Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly
sphinx-build -b html ./docs ./docs/_build/docs