dragonfly-designbuilder 0.1.0

Dragonfly extension for the DOE-2 energy simulation engine.

Dragonfly extension for translation to/from DesignBuilder.

Translation is accomplished using XML files following the DesignBuilder DsbXML Schema. Files can be imported to DesignBuilder using the DsbXML Importer

Installation

pip install -U dragonfly-designbuilder

To check if the command line interface is installed correctly use dragonfly-designbuilder --help.

QuickStart

import dragonfly_designbuilder

API Documentation

Local Development

1. Clone this repo locally

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

# or

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

2. Install dependencies:

cd dragonfly-designbuilder
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 ./dragonfly_designbuilder
sphinx-build -b html ./docs ./docs/_build/docs