Skip to content

ladybug-tools/dragonfly-uwg

Repository files navigation

Dragonfly

Build Status Coverage Status

Python 3.10 Python 3.7(https://www.python.org/downloads/release/python-360/) Python 2.7 IronPython

dragonfly-uwg

Dragonfly extension for urban heat island modeling.

Dragonfly-uwg uses the Urban Weather Generator (uwg) to morph EPW files to account for the urban heat island effect.

Installation

pip install -U dragonfly-uwg

QuickStart

import dragonfly_uwg

Local Development

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

# or

git clone https://github.com/ladybug-tools/dragonfly-uwg
  1. Install dependencies:
cd dragonfly-uwg
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_uwg
sphinx-build -b html ./docs ./docs/_build/docs