:dragon: dragonfly core library
Project description
dragonfly-core
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 and edit large models.
This repository is the core repository that provides dragonfly's common functionalities. To extend these functionalities you should install available Dragonfly extensions or write your own.
Here are a number of frequently used extensions for Dragonfly:
- dragonfly-energy: Adds Energy simulation to Dragonfly.
Installation
pip install -U dragonfly-core
To check if Dragonfly command line interface is installed correctly use dragonfly viz
and you
should get a viiiiiiiiiiiiizzzzzzzzz!
back in response!
API Documentation
Local Development
- Clone this repo locally
git clone git@github.com:ladybug-tools/dragonfly-core.git
# or
git clone https://github.com/ladybug-tools/dragonfly-core.git
- Install dependencies:
cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
- Run Tests:
python -m pytests tests/
- Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly
sphinx-build -b html ./docs ./docs/_build/docs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file dragonfly_core-1.57.5.tar.gz
.
File metadata
- Download URL: dragonfly_core-1.57.5.tar.gz
- Upload date:
- Size: 728.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97cb6b096e70754d494e8f362ed65ab4097691f5e63f3227ecc730f207ede3f8 |
|
MD5 | 02d8f6589253c7c748df1be9b556ae83 |
|
BLAKE2b-256 | cf81d7aff09644bbb246728856c52956c5f714df5edbea71fefa2d1986cc8929 |
File details
Details for the file dragonfly_core-1.57.5-py2.py3-none-any.whl
.
File metadata
- Download URL: dragonfly_core-1.57.5-py2.py3-none-any.whl
- Upload date:
- Size: 204.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cf5212ab8fd534e0faba66c16556e43d2fe30b7901fc4bafb7a557c081e0f83 |
|
MD5 | 7522432cc859d791ce9dd247a5d74db2 |
|
BLAKE2b-256 | 767780636adf815f9e00d9c71f436148b05d4589ae7f9a84d9ea3642001dd8c4 |