{"id":13948852,"url":"https://github.com/ladybug-tools/uwg","last_synced_at":"2025-09-08T22:06:44.422Z","repository":{"id":20030991,"uuid":"88577732","full_name":"ladybug-tools/uwg","owner":"ladybug-tools","description":":city_sunrise: The Urban Weather Generator (uwg) is a Python application for modeling the urban heat island effect.","archived":false,"fork":false,"pushed_at":"2024-10-15T22:25:39.000Z","size":30360,"stargazers_count":65,"open_issues_count":24,"forks_count":27,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-02T11:44:45.557Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.ladybug.tools/uwg/docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ladybug-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-18T03:32:01.000Z","updated_at":"2025-08-19T03:14:43.000Z","dependencies_parsed_at":"2023-09-21T19:08:26.237Z","dependency_job_id":"f363e2d3-ac02-4939-b098-9091c7693690","html_url":"https://github.com/ladybug-tools/uwg","commit_stats":{"total_commits":536,"total_committers":8,"mean_commits":67.0,"dds":"0.30410447761194026","last_synced_commit":"ddedeac65df06126eb8edc0d2f150b30ff399ea2"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/ladybug-tools/uwg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fuwg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fuwg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fuwg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fuwg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladybug-tools","download_url":"https://codeload.github.com/ladybug-tools/uwg/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fuwg/sbom","scorecard":{"id":576907,"data":{"date":"2025-08-11","repo":{"name":"github.com/ladybug-tools/uwg","commit":"ddedeac65df06126eb8edc0d2f150b30ff399ea2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yaml:1","Warn: no topLevel permission defined: .github/workflows/dependency-release.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependency-release.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/uwg/dependency-release.yaml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:24","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:25","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:26","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:47","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:48","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:49","Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:53","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:91","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:92","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:93","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   9 pipCommand dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/ci.yaml:30"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2013-22 / GHSA-27x4-j476-jp5f","Warn: Project is vulnerable to: PYSEC-2025-49 / GHSA-5rjg-fvgr-3xxf","Warn: Project is vulnerable to: GHSA-cx63-2mw6-8hw5","Warn: Project is vulnerable to: PYSEC-2022-43012 / GHSA-r9hx-vwmv-q579","Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T18:05:49.511Z","repository_id":20030991,"created_at":"2025-08-20T18:05:49.511Z","updated_at":"2025-08-20T18:05:49.511Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273609917,"owners_count":25136665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-08T05:01:32.594Z","updated_at":"2025-09-08T22:06:44.389Z","avatar_url":"https://github.com/ladybug-tools.png","language":"Python","funding_links":[],"categories":["Climate Change","Python"],"sub_categories":["Earth and Climate Modeling"],"readme":"[![Build Status](https://github.com/ladybug-tools/uwg/workflows/CI/badge.svg)](https://github.com/ladybug-tools/uwg/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/uwg/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/uwg)\n\n[![Python 3.6](https://img.shields.io/badge/python-3.6-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# 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fuwg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladybug-tools%2Fuwg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fuwg/lists"}