Data

Tools

Indexes

Applications

Experiments

Open Source Science

uwg

:city_sunrise: The Urban Weather Generator (uwg) is a Python application for modeling the urban heat island effect.

https://github.com/ladybug-tools/uwg

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary

Keywords from Contributors

action
Last synced: 11 months ago · JSON representation

Repository

:city_sunrise: The Urban Weather Generator (uwg) is a Python application for modeling the urban heat island effect.

Basic Info
Statistics
  • Stars: 65
  • Watchers: 6
  • Forks: 27
  • Open Issues: 24
  • Releases: 27
Created over 9 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

Build Status Coverage Status

Python 3.6 Python 2.7 IronPython

uwg

The Urban Weather Generator (uwg) is a Python application for modeling the urban heat island effect. Specifically, it morphs rural EnergyPlus weather (.epw) files 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 was developed by Bruno Bueno for his PhD thesis at MIT. Since this time, it has been validated 3 times and has been enhanced by Aiko Nakano. In 2016, Joseph Yang also improved the engine and added a range of building templates.

This repository is a Python translation of the original MATLAB Urban Weather Generator.

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.

epwpath = "resources/SGPSingapore.486980_IWEC.epw" # available in resources directory.

Initialize the UWG model by passing parameters as arguments, or relying on defaults

model = UWG.fromparamargs(epwpath=epwpath, 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

parampath = "initializesingapore.uwg" # available in resources directory.

model = UWG.fromparamfile(parampath, epwpath=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

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 ```

  1. Run Tests: console python -m pytest tests/

  2. Generate Documentation: console sphinx-apidoc -f -e -d 4 -o ./docs ./uwg sphinx-build -b html ./docs ./docs/_build/docs

Owner

  • Name: Ladybug Tools
  • Login: ladybug-tools
  • Kind: organization
  • Email: info@ladybug.tools
  • Location: Worldwide

Ladybug Tools is a collection of free computer applications that support environmentally-conscious design and simulation.

GitHub Events

Total
  • Issues event: 1
  • Watch event: 14
  • Issue comment event: 2
  • Push event: 2
  • Pull request event: 3
  • Fork event: 2
Last Year
  • Issues event: 1
  • Watch event: 14
  • Issue comment event: 2
  • Push event: 2
  • Pull request event: 3
  • Fork event: 2

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 536
  • Total Committers: 8
  • Avg Commits per committer: 67.0
  • Development Distribution Score (DDS): 0.304
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Saeran Vasanthakumar s****v@g****m 373
dependabot-preview[bot] 2****] 101
Chris Mackey c****s@l****s 35
AntoineDao a****1@g****m 13
semantic-release s****e 9
ladybugbot l****t 3
AntoineDao a****e@m****m 1
jumpyapple 7****e 1
Committer Domains (Top 20 + Academic)
mallzee.com: 1 ladybug.tools: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 68
  • Total pull requests: 222
  • Average time to close issues: 5 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 23
  • Total pull request authors: 7
  • Average comments per issue: 3.6
  • Average comments per pull request: 0.89
  • Merged pull requests: 199
  • Bot issues: 1
  • Bot pull requests: 119
Past Year
  • Issues: 2
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • saeranv (26)
  • chriswmackey (7)
  • simonmarti1992 (5)
  • gianlucamaracchini (5)
  • sercrp (2)
  • HibaHamdi09 (2)
  • AntoineDao (2)
  • aleksandraradecka1 (2)
  • frank984 (2)
  • Betterbuilt00 (2)
  • maririvo (1)
  • hughesdespond (1)
  • elelac (1)
  • danieldjewell (1)
  • biglimp (1)
Pull Request Authors
  • dependabot-preview[bot] (117)
  • saeranv (67)
  • chriswmackey (25)
  • AntoineDao (9)
  • dependabot[bot] (2)
  • mostaphaRoudsari (1)
  • jumpyapple (1)
Top Labels
Issue Labels
enhancement (10) bug (4) critical (3) question (3) help wanted (1) Future Capabilities (1)
Pull Request Labels
dependencies (125) released (107) bug (9) enhancement (2)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 5,464 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 54
  • Total maintainers: 1
proxy.golang.org: github.com/ladybug-tools/uwg
  • Versions: 28
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 11 months ago
pypi.org: uwg

Python application for modeling the urban heat island effect.

  • Versions: 26
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 5,464 Last month
Rankings
Dependent packages count: 2.1%
Downloads: 3.2%
Forks count: 7.8%
Average: 9.1%
Stargazers count: 10.3%
Dependent repos count: 22.1%
Maintainers (1)
ladybug-tools
Last synced: 11 months ago

Dependencies

cli-requirements.txt pypi
  • click ==7.1.2
  • uwg-schema ==0.2.10
dev-requirements.txt pypi
  • Sphinx ==3.3.1 development
  • Sphinx ==1.8.5 development
  • click ==7.1.2 development
  • coverage ==5.5 development
  • coveralls ==1.7.0 development
  • coveralls ==2.2.0 development
  • importlib-metadata ==2.0.0 development
  • importlib-metadata ==4.3.1 development
  • pytest ==6.2.4 development
  • pytest ==4.6.9 development
  • pytest-cov ==2.12.0 development
  • setuptools ==44.1.0 development
  • setuptools ==57.0.0 development
  • sphinx-bootstrap-theme ==0.7.1 development
  • sphinx-click ==2.7.1 development
  • sphinxcontrib-fulltoc ==1.2.0 development
  • sphinxcontrib-websupport ==1.1.2 development
  • sphinxcontrib-websupport ==1.2.4 development
  • twine ==3.4.1 development
  • twine ==1.13.0 development
  • uwg-schema ==0.2.8 development
  • wheel ==0.36.2 development
.github/workflows/ci.yaml actions
  • actions/checkout v2 composite
  • actions/setup-node v2.1.2 composite
  • actions/setup-python v2 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/dependency-release.yaml actions
  • actions/checkout v2 composite
requirements.txt pypi
setup.py pypi