Welcome to Dragonfly’s documentation!¶
Dragonfly is a collection of Python libraries to create representations of buildings following dragonfly-schema. It abstracts the capabilities of honeybee-core to make it easier to construct models on the urban scale.
Installation¶
To install the core library use pip install -U dragonfly-core.
To check if the Dragonfly command line interface is installed correctly use dragonfly viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response!
Documentation¶
This document includes Dragonfly API documentation and
Dragonfly Command Line Interface documentation for dragonfly core and does
not include the documentation for dragonfly extensions. For each extension refer to
extension’s documentation page.
Here are a number of popular Dragonfly extensions:
CLI Docs¶
For command line interface documentation and API documentation see the pages below.
dragonfly¶
- dragonfly
- dragonfly package
- Subpackages
- Submodules
- dragonfly.building module
- dragonfly.colorobj module
- dragonfly.config module
- dragonfly.context module
- dragonfly.dictutil module
- dragonfly.extensionutil module
- dragonfly.model module
- dragonfly.projection module
- dragonfly.properties module
- dragonfly.roof module
- dragonfly.room2d module
- dragonfly.shadingparameter module
- dragonfly.skylightparameter module
- dragonfly.story module
- dragonfly.subdivide module
- dragonfly.windowparameter module
- Module contents
- dragonfly package