[](https://github.com/ladybug-tools/dragonfly-uwg/actions)
[](https://coveralls.io/github/ladybug-tools/dragonfly-uwg)
[](https://www.python.org/downloads/release/python-3100/) (https://www.python.org/downloads/release/python-360/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# dragonfly-uwg
Dragonfly extension for urban heat island modeling.
Dragonfly-uwg uses the [Urban Weather Generator (uwg)](https://github.com/ladybug-tools/uwg)
to morph EPW files to account for the [urban heat island effect](https://en.wikipedia.org/wiki/Urban_heat_island).
## Installation
`pip install -U dragonfly-uwg`
## QuickStart
```console
import dragonfly_uwg
```
## [API Documentation](http://ladybug-tools.github.io/dragonfly-uwg/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/dragonfly-uwg
# or
git clone https://github.com/ladybug-tools/dragonfly-uwg
```
2. Install dependencies:
```
cd dragonfly-uwg
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_uwg
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/dragonfly-uwg",
"name": "dragonfly-uwg",
"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/e1/ee/ffce241c13106428d7e84af5f78a0eb1186b43b1563eab4412cd1fcce90c/dragonfly_uwg-0.5.619.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/ladybug-tools/dragonfly-uwg/actions)\n[](https://coveralls.io/github/ladybug-tools/dragonfly-uwg)\n\n[](https://www.python.org/downloads/release/python-3100/) (https://www.python.org/downloads/release/python-360/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# dragonfly-uwg\n\nDragonfly extension for urban heat island modeling.\n\nDragonfly-uwg uses the [Urban Weather Generator (uwg)](https://github.com/ladybug-tools/uwg)\nto morph EPW files to account for the [urban heat island effect](https://en.wikipedia.org/wiki/Urban_heat_island).\n\n## Installation\n\n`pip install -U dragonfly-uwg`\n\n## QuickStart\n\n```console\nimport dragonfly_uwg\n```\n\n## [API Documentation](http://ladybug-tools.github.io/dragonfly-uwg/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-uwg\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-uwg\n```\n2. Install dependencies:\n```\ncd dragonfly-uwg\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_uwg\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Dragonfly extension for the Urban Weather Generator (UWG).",
"version": "0.5.619",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/dragonfly-uwg"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f681964f761832d263036c3bbc9e4d39128e368fa1c735493daba91c4605bdf",
"md5": "876ce2dd6bf974022e8210daf59c9596",
"sha256": "56c48cfc5b5b078529f1debdcf9daecc964a925ed90b349be8f72be61da0e1ea"
},
"downloads": -1,
"filename": "dragonfly_uwg-0.5.619-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "876ce2dd6bf974022e8210daf59c9596",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 52326,
"upload_time": "2024-11-20T22:25:51",
"upload_time_iso_8601": "2024-11-20T22:25:51.247016Z",
"url": "https://files.pythonhosted.org/packages/5f/68/1964f761832d263036c3bbc9e4d39128e368fa1c735493daba91c4605bdf/dragonfly_uwg-0.5.619-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1eeffce241c13106428d7e84af5f78a0eb1186b43b1563eab4412cd1fcce90c",
"md5": "206faec723f51d4f4cd9a68a39b41cd8",
"sha256": "d2c88cdf0ec8ad6f0165690dfb745fdd380bf38b1e14974bbccebc3c5490ddb3"
},
"downloads": -1,
"filename": "dragonfly_uwg-0.5.619.tar.gz",
"has_sig": false,
"md5_digest": "206faec723f51d4f4cd9a68a39b41cd8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 501298,
"upload_time": "2024-11-20T22:25:53",
"upload_time_iso_8601": "2024-11-20T22:25:53.713316Z",
"url": "https://files.pythonhosted.org/packages/e1/ee/ffce241c13106428d7e84af5f78a0eb1186b43b1563eab4412cd1fcce90c/dragonfly_uwg-0.5.619.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 22:25:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "dragonfly-uwg",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dragonfly-uwg"
}
JSON
