dragonfly-display
Adds methods and a CLI to translate dragonfly objects to VisualizationSets.
Installation
pip install -U dragonfly-display
If you want to also include all dependencies needed to produce VTK visualizations
from dragonfly Models use.
pip install -U dragonfly-display[full]
To check if the command line interface is installed correctly use dragonfly-display --help
QuickStart
import dragonfly_display
Local Development
- Clone this repo locally
git clone git@github.com:ladybug-tools/dragonfly-display
# or
git clone https://github.com/ladybug-tools/dragonfly-display
- Install dependencies:
cd dragonfly-display
pip install -r dev-requirements.txt
pip install -r requirements.txt
- Run Tests:
python -m pytest tests/
- Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_display
sphinx-build -b html ./docs ./docs/_build/docs