dragonfly-core 1.25.54

:dragon: dragonfly core library

dragonfly-core

Dragonfly is a collection of Python libraries to create representations of buildings following dragonfly-schema. It abstracts the capabilities of honeybee-core to make it easier to construct models on 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.

Installation

pip install -U dragonfly-core

If you want to also include the command line interface use:

pip install -U dragonfly-core[cli]

To check if Dragonfly command line is installed correctly use dragonfly viz and you should get a viiiiiiiiiiiiizzzzzzzzz! back in response!

API Documentation

Local Development

1. Clone this repo locally

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

# or

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

2. Install dependencies:

cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt

3. Run Tests:

python -m pytests tests/

4. Generate Documentation:

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