dragonfly-openstudio 0.1.0

Dragonfly extension for translating dragonfly-energy objects to OpenStudio.

dragonfly-openstudio

Dragonfly extension for translation to OpenStudio.

Specifically, this package leverages honeybee-openstudio te extend dragonfly-energy to perform translations to OpenStudio using the OpenStudio SDK. Translation capabilities include translating dragonfly-energy District Energy Systems (DES) to OpenStudio models of the plant.

Installation

pip install -U dragonfly-openstudio

QuickStart

import dragonfly_openstudio

API Documentation

Local Development

1. Clone this repo locally

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

# or

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

2. Install dependencies:

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