dragonfly-uwg


Namedragonfly-uwg JSON
Version 0.5.605 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/dragonfly-uwg
SummaryDragonfly extension for the Urban Weather Generator (UWG).
upload_time2024-11-01 22:03:47
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png)

[![Build Status](https://github.com/ladybug-tools/dragonfly-uwg/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-uwg/actions)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-uwg/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-uwg)

[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) ![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)(https://www.python.org/downloads/release/python-360/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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/cc/25/bf99bb51af4f2058c1ca296a178d512a01fe3db1cbbeb492dac53fdd20b1/dragonfly_uwg-0.5.605.tar.gz",
    "platform": null,
    "description": "![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png)\n\n[![Build Status](https://github.com/ladybug-tools/dragonfly-uwg/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-uwg/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-uwg/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-uwg)\n\n[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) ![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)(https://www.python.org/downloads/release/python-360/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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.605",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/dragonfly-uwg"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a31aadda2f1e63e8275b8fcc6139c247b22ca4435fda615ecd429c43b1881ba",
                "md5": "cefa4e5bddbdb3449f6a6bdb359019ed",
                "sha256": "8ede100b044982c54a8e06a13d872a2dfc6d5b80954c8b35b534ba76cab10fc0"
            },
            "downloads": -1,
            "filename": "dragonfly_uwg-0.5.605-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cefa4e5bddbdb3449f6a6bdb359019ed",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 52316,
            "upload_time": "2024-11-01T22:03:45",
            "upload_time_iso_8601": "2024-11-01T22:03:45.400269Z",
            "url": "https://files.pythonhosted.org/packages/4a/31/aadda2f1e63e8275b8fcc6139c247b22ca4435fda615ecd429c43b1881ba/dragonfly_uwg-0.5.605-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cc25bf99bb51af4f2058c1ca296a178d512a01fe3db1cbbeb492dac53fdd20b1",
                "md5": "4796e524afee873e128f8dbcbf4419d0",
                "sha256": "adee067326ee8e11f15cd249dca3eed6c593f6ef6497cf73b9d2b088ce0c87dd"
            },
            "downloads": -1,
            "filename": "dragonfly_uwg-0.5.605.tar.gz",
            "has_sig": false,
            "md5_digest": "4796e524afee873e128f8dbcbf4419d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 501301,
            "upload_time": "2024-11-01T22:03:47",
            "upload_time_iso_8601": "2024-11-01T22:03:47.211680Z",
            "url": "https://files.pythonhosted.org/packages/cc/25/bf99bb51af4f2058c1ca296a178d512a01fe3db1cbbeb492dac53fdd20b1/dragonfly_uwg-0.5.605.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-01 22:03:47",
    "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"
}
Ladybug Tools
Elapsed time: 0.43459s