Skip to main content

:dragon: dragonfly core library

Project description

Build Status Coverage Status

Python 2.7 Python 3.6

dragonfly-core

Screenshot

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.

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:

Installation

pip install -U dragonfly-core

If you want to also include the command line interface use:

pip install -U dragonfly-core[cli]

To check if Dragonfly command line is installed correctly use dragonfly viz and you should get a viiiiiiiiiiiiizzzzzzzzz! back in response!

API Documentation

Local Development

  1. 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
  1. Install dependencies:
cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytests tests/
  1. 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

dragonfly-core-1.26.0.tar.gz (108.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dragonfly_core-1.26.0-py2.py3-none-any.whl (86.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file dragonfly-core-1.26.0.tar.gz.

File metadata

  • Download URL: dragonfly-core-1.26.0.tar.gz
  • Upload date:
  • Size: 108.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for dragonfly-core-1.26.0.tar.gz
Algorithm Hash digest
SHA256 45747691606ab73b39b2b76ec877a1ba952db18ba9294e05224177d978aa7a06
MD5 47ba42074448d3886a12196de9bb647a
BLAKE2b-256 2ff9365403b481e1305c85672513a7fab1e925428c10a9a2464e5a4008ac939b

See more details on using hashes here.

File details

Details for the file dragonfly_core-1.26.0-py2.py3-none-any.whl.

File metadata

  • Download URL: dragonfly_core-1.26.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 86.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for dragonfly_core-1.26.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d6f2c7e0fe6278e38eb99950650663994aef236184eb42f9ee57bd9db138393e
MD5 21b29ee0b48738b7b2d2d77fcf50892c
BLAKE2b-256 a8e58adc4e202bd295836d17e45d15e393060e7435a3f1d05426b86738d2d7aa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page