Skip to content

ladybug-tools/dragonfly-doe2

Repository files navigation

Dragonfly

Build Status Coverage Status

Python 3.7

dragonfly-doe2

Dragonfly extension for energy modeling with the DOE-2 engine.

DOE-2 is a widely used and accepted freeware building energy analysis program that can predict the energy use and cost for all types of buildings.

Installation

pip install -U dragonfly-doe2

QuickStart

import dragonfly_doe2

Local Development

  1. Clone this repo locally
git clone git@github.com:ladybug-tools/dragonfly-doe2

# or

git clone https://github.com/ladybug-tools/dragonfly-doe2
  1. Install dependencies:
cd dragonfly-doe2
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest tests/
  1. Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_doe2
sphinx-build -b html ./docs ./docs/_build/docs