[](https://github.com/ladybug-tools/dragonfly-display/actions)
[](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-display
Adds methods and a CLI to translate dragonfly objects to VisualizationSets.
## Installation
```console
pip install -U dragonfly-display
```
If you want to also include all dependencies needed to produce VTK visualizations
from dragonfly Models use.
```console
pip install -U dragonfly-display[full]
```
To check if the command line interface is installed correctly use `dragonfly-display --help`
## QuickStart
```python
import dragonfly_display
```
## [API Documentation](http://ladybug-tools.github.io/dragonfly-display/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/dragonfly-display
# or
git clone https://github.com/ladybug-tools/dragonfly-display
```
2. Install dependencies:
```console
cd dragonfly-display
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_display
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/dragonfly-display",
"name": "dragonfly-display",
"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/44/75/e9fc6b261ae1ad453f893ce918018e030beb3fdc97d5289b7c539c7c8264/dragonfly-display-0.2.0.tar.gz",
"platform": null,
"description": "[](https://github.com/ladybug-tools/dragonfly-display/actions)\n\n[](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-display\n\nAdds methods and a CLI to translate dragonfly objects to VisualizationSets.\n\n## Installation\n\n```console\npip install -U dragonfly-display\n```\n\nIf you want to also include all dependencies needed to produce VTK visualizations\nfrom dragonfly Models use.\n\n```console\npip install -U dragonfly-display[full]\n```\n\nTo check if the command line interface is installed correctly use `dragonfly-display --help`\n\n## QuickStart\n\n```python\nimport dragonfly_display\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/dragonfly-display/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-display\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-display\n```\n2. Install dependencies:\n```console\ncd dragonfly-display\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_display\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Adds methods to translate dragonfly objects to VisualizationSets.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/dragonfly-display"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aea28cc4c1091e0aa8da4a0142ea39289988afd3800a945112657eca205d11a5",
"md5": "346515e73a7748dc50e06c3679760819",
"sha256": "36da1b92cece2dcb569c3f3aad3d8ed897122ce2288a77ec6df6494065ae3e86"
},
"downloads": -1,
"filename": "dragonfly_display-0.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "346515e73a7748dc50e06c3679760819",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 21071,
"upload_time": "2024-07-09T02:35:16",
"upload_time_iso_8601": "2024-07-09T02:35:16.164729Z",
"url": "https://files.pythonhosted.org/packages/ae/a2/8cc4c1091e0aa8da4a0142ea39289988afd3800a945112657eca205d11a5/dragonfly_display-0.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4475e9fc6b261ae1ad453f893ce918018e030beb3fdc97d5289b7c539c7c8264",
"md5": "2c29936f1392ca4ab55753e66be8a02e",
"sha256": "d291e9bd5f69aaf57ea74a6c137b02587d08d8e2b6dc63c8fc665c27c59196a5"
},
"downloads": -1,
"filename": "dragonfly-display-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2c29936f1392ca4ab55753e66be8a02e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20333,
"upload_time": "2024-07-09T02:35:18",
"upload_time_iso_8601": "2024-07-09T02:35:18.203560Z",
"url": "https://files.pythonhosted.org/packages/44/75/e9fc6b261ae1ad453f893ce918018e030beb3fdc97d5289b7c539c7c8264/dragonfly-display-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 02:35:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "dragonfly-display",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dragonfly-display"
}
JSON
