| Name | uwg JSON |
| Version |
5.8.12
JSON |
| download |
| home_page | https://github.com/ladybug-tools/uwg |
| Summary | Python application for modeling the urban heat island effect. |
| upload_time | 2023-06-29 19:35:17 |
| maintainer | |
| docs_url | None |
| author | Ladybug Tools |
| requires_python | |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/ladybug-tools/uwg/actions)
[](https://coveralls.io/github/ladybug-tools/uwg)
[](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/)
# uwg
The Urban Weather Generator (uwg) is a Python application for modeling the [urban heat island effect](https://en.wikipedia.org/wiki/Urban_heat_island). Specifically, it morphs rural [EnergyPlus weather (.epw) files](http://www.ladybug.tools/epwmap/) to reflect average conditions within the urban canyon using a range of properties including:
* Building geometry (including building height, ground coverage, window:wall area, and facade:site area)
* Building use (including program type, HVAC systems, and occupancy/equipment scheduling)
* Cooling system heat rejection to the outdoors (for Summer)
* Indoor heat leakage to the outdoors (for Winter)
* Urban materials (including the thermal mass, albedo and emissivity of roads, walls, and roofs)
* Anthropogenic heat from traffic (including traffic schedules)
* Vegetation coverage (both trees and shrubs)
* Atmospheric heat transfer from urban boundary and canopy layers
The [original Urban Weather Generator](http://urbanmicroclimate.scripts.mit.edu/uwg.php) was developed by Bruno Bueno for [his PhD thesis at MIT](https://dspace.mit.edu/handle/1721.1/59107). Since this time, it has been validated 3 times and has been [enhanced by Aiko Nakano](https://dspace.mit.edu/handle/1721.1/108779). In 2016, Joseph Yang also [improved the engine and added a range of building templates](https://dspace.mit.edu/handle/1721.1/107347).
This repository is a Python translation of the original [MATLAB Urban Weather Generator](https://github.com/hansukyang/UWG_Matlab).
# Example
Here is a Python example that shows how to create and run an Urban Weather Generator object.
```python
from uwg import UWG
# Define the .epw, .uwg paths to create an uwg object.
epw_path = "resources/SGP_Singapore.486980_IWEC.epw" # available in resources directory.
# Initialize the UWG model by passing parameters as arguments, or relying on defaults
model = UWG.from_param_args(epw_path=epw_path, bldheight=10, blddensity=0.5,
vertohor=0.8, grasscover=0.1, treecover=0.1, zone='1A')
# Uncomment these lines to initialize the UWG model using a .uwg parameter file
# param_path = "initialize_singapore.uwg" # available in resources directory.
# model = UWG.from_param_file(param_path, epw_path=epw_path)
model.generate()
model.simulate()
# Write the simulation result to a file.
model.write_epw()
```
## Installation
```console
pip install uwg
```
## QuickStart
```python
import uwg
```
## [API Documentation](http://ladybug-tools.github.io/uwg/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/uwg
# or
git clone https://github.com/ladybug-tools/uwg
```
2. Install dependencies:
```console
cd 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 ./uwg
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/uwg",
"name": "uwg",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/68/8f/d382d217135fccb5a298a5616b3021b389104b4ea005149c4176f3d1ca85/uwg-5.8.12.tar.gz",
"platform": null,
"description": "[](https://github.com/ladybug-tools/uwg/actions)\n[](https://coveralls.io/github/ladybug-tools/uwg)\n\n[](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# uwg\n\nThe Urban Weather Generator (uwg) is a Python application for modeling the [urban heat island effect](https://en.wikipedia.org/wiki/Urban_heat_island). Specifically, it morphs rural [EnergyPlus weather (.epw) files](http://www.ladybug.tools/epwmap/) to reflect average conditions within the urban canyon using a range of properties including:\n\n* Building geometry (including building height, ground coverage, window:wall area, and facade:site area)\n* Building use (including program type, HVAC systems, and occupancy/equipment scheduling)\n* Cooling system heat rejection to the outdoors (for Summer)\n* Indoor heat leakage to the outdoors (for Winter)\n* Urban materials (including the thermal mass, albedo and emissivity of roads, walls, and roofs)\n* Anthropogenic heat from traffic (including traffic schedules)\n* Vegetation coverage (both trees and shrubs)\n* Atmospheric heat transfer from urban boundary and canopy layers\n\nThe [original Urban Weather Generator](http://urbanmicroclimate.scripts.mit.edu/uwg.php) was developed by Bruno Bueno for [his PhD thesis at MIT](https://dspace.mit.edu/handle/1721.1/59107). Since this time, it has been validated 3 times and has been [enhanced by Aiko Nakano](https://dspace.mit.edu/handle/1721.1/108779). In 2016, Joseph Yang also [improved the engine and added a range of building templates](https://dspace.mit.edu/handle/1721.1/107347).\n\nThis repository is a Python translation of the original [MATLAB Urban Weather Generator](https://github.com/hansukyang/UWG_Matlab).\n\n# Example\nHere is a Python example that shows how to create and run an Urban Weather Generator object.\n\n```python\nfrom uwg import UWG\n\n# Define the .epw, .uwg paths to create an uwg object.\nepw_path = \"resources/SGP_Singapore.486980_IWEC.epw\" # available in resources directory.\n\n\n# Initialize the UWG model by passing parameters as arguments, or relying on defaults\nmodel = UWG.from_param_args(epw_path=epw_path, bldheight=10, blddensity=0.5,\n vertohor=0.8, grasscover=0.1, treecover=0.1, zone='1A')\n\n# Uncomment these lines to initialize the UWG model using a .uwg parameter file\n# param_path = \"initialize_singapore.uwg\" # available in resources directory.\n# model = UWG.from_param_file(param_path, epw_path=epw_path)\n\nmodel.generate()\nmodel.simulate()\n\n# Write the simulation result to a file.\nmodel.write_epw()\n```\n\n## Installation\n```console\npip install uwg\n```\n\n## QuickStart\n```python\nimport uwg\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/uwg/docs)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/uwg\n\n# or\n\ngit clone https://github.com/ladybug-tools/uwg\n```\n2. Install dependencies:\n```console\ncd 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 ./uwg\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Python application for modeling the urban heat island effect.",
"version": "5.8.12",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/uwg"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7f62319bfa767586e69f940e4d0e4079dcb4fca122a7a5d00c4f2581ef00e66",
"md5": "f15eacbdda78b45e2bc71cf9cbc12a52",
"sha256": "96cdf82dc9663fd7e9a89a2fd31f8b753ef10107929deded8ff619e852b22847"
},
"downloads": -1,
"filename": "uwg-5.8.12-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f15eacbdda78b45e2bc71cf9cbc12a52",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 267918,
"upload_time": "2023-06-29T19:35:14",
"upload_time_iso_8601": "2023-06-29T19:35:14.588388Z",
"url": "https://files.pythonhosted.org/packages/b7/f6/2319bfa767586e69f940e4d0e4079dcb4fca122a7a5d00c4f2581ef00e66/uwg-5.8.12-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "688fd382d217135fccb5a298a5616b3021b389104b4ea005149c4176f3d1ca85",
"md5": "f518fb1d10eaf3776290cfd585dc509c",
"sha256": "09dbe8a5d93d35a9d504b521fe09b1105b5173793a551a4304fa2612aa3fce20"
},
"downloads": -1,
"filename": "uwg-5.8.12.tar.gz",
"has_sig": false,
"md5_digest": "f518fb1d10eaf3776290cfd585dc509c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12250505,
"upload_time": "2023-06-29T19:35:17",
"upload_time_iso_8601": "2023-06-29T19:35:17.078939Z",
"url": "https://files.pythonhosted.org/packages/68/8f/d382d217135fccb5a298a5616b3021b389104b4ea005149c4176f3d1ca85/uwg-5.8.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 19:35:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "uwg",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "uwg"
}
