[](https://travis-ci.com/ladybug-tools/dragonfly-core)
[](https://coveralls.io/github/ladybug-tools/dragonfly-core)
[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# dragonfly-core
Dragonfly is a collection of Python libraries to create representations of buildings
following [dragonfly-schema](https://github.com/ladybug-tools/dragonfly-schema/wiki).
It abstracts the capabilities of [honeybee-core](https://github.com/ladybug-tools/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](https://github.com/ladybug-tools/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](https://www.ladybug.tools/dragonfly-core/docs/)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/dragonfly-core.git
# or
git clone https://github.com/ladybug-tools/dragonfly-core.git
```
2. Install dependencies:
```console
cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
3. Run Tests:
```console
python -m pytests tests/
```
4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/dragonfly-core",
"name": "dragonfly-core",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/be/a5/2a208f219e61f6770c23ea138798396ee800a46fb527cd7a15e96ab20d8b/dragonfly-core-1.46.5.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/ladybug-tools/dragonfly-core)\n[](https://coveralls.io/github/ladybug-tools/dragonfly-core)\n\n[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# dragonfly-core\n\n\n\nDragonfly is a collection of Python libraries to create representations of buildings\nfollowing [dragonfly-schema](https://github.com/ladybug-tools/dragonfly-schema/wiki).\nIt abstracts the capabilities of [honeybee-core](https://github.com/ladybug-tools/honeybee-core/)\nto make it easier to construct and edit large models.\n\nThis repository is the core repository that provides dragonfly's common functionalities.\nTo extend these functionalities you should install available Dragonfly extensions or write\nyour own.\n\nHere are a number of frequently used extensions for Dragonfly:\n- [dragonfly-energy](https://github.com/ladybug-tools/dragonfly-energy): Adds Energy simulation to Dragonfly.\n\n## Installation\n\n`pip install -U dragonfly-core`\n\nTo check if Dragonfly command line interface is installed correctly use `dragonfly viz` and you\nshould get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!\n\n## [API Documentation](https://www.ladybug.tools/dragonfly-core/docs/)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-core.git\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-core.git\n```\n2. Install dependencies:\n```console\ncd dragonfly-core\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytests tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": ":dragon: dragonfly core library",
"version": "1.46.5",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/dragonfly-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9169d17c7657b17c72e8d5d4fba65bca52028ee3d2f6ffedb543e01fce0dc7d6",
"md5": "5521eaa32f57ff3d177fae7831b8344c",
"sha256": "552893b1dc4e56f1ac8fff6d849f25564eb3add6fed2a80e3fd42e9235e9b2ce"
},
"downloads": -1,
"filename": "dragonfly_core-1.46.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5521eaa32f57ff3d177fae7831b8344c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 174100,
"upload_time": "2024-04-23T15:48:28",
"upload_time_iso_8601": "2024-04-23T15:48:28.732651Z",
"url": "https://files.pythonhosted.org/packages/91/69/d17c7657b17c72e8d5d4fba65bca52028ee3d2f6ffedb543e01fce0dc7d6/dragonfly_core-1.46.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bea52a208f219e61f6770c23ea138798396ee800a46fb527cd7a15e96ab20d8b",
"md5": "ccc4986fe025bc806370356da8d3a735",
"sha256": "7669a7f6e1732e2f9e1442ea24f55f8ef8d11b89cc884a50de43fc5e8f330d15"
},
"downloads": -1,
"filename": "dragonfly-core-1.46.5.tar.gz",
"has_sig": false,
"md5_digest": "ccc4986fe025bc806370356da8d3a735",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 501969,
"upload_time": "2024-04-23T15:48:34",
"upload_time_iso_8601": "2024-04-23T15:48:34.270446Z",
"url": "https://files.pythonhosted.org/packages/be/a5/2a208f219e61f6770c23ea138798396ee800a46fb527cd7a15e96ab20d8b/dragonfly-core-1.46.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 15:48:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "dragonfly-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dragonfly-core"
}
JSON
