How umep-dev/umep-core works
Project type and purpose
• This is a Python-based scientific library (“UMEP Core”) for urban climate and thermal comfort calculations.
• It exposes a set of algorithms (shadow, sky-view factor, SOLWEIG) in a headless library, driven by scripts in the demos/ folder.
• It is packaged with pyproject.toml, tested under tests/, and released via GitHub Actions to PyPI.
File structure
Top level:
• .github/workflows/python-publish.yml – CI/CD pipeline for building and publishing
• pyproject.toml – package metadata, dependencies, entry points
• umep/ – the core library module
– functions/ – SOLWEIG and related thermal-radiation algorithms (COMFA, PET, etc.)
– shadow_generator_algorithm.py, skyviewfactor_algorithm.py, solweig_algorithm.py, wall_heightaspect_algorithm.py – pre-processing and solver entrypoints
– class_configs.py, common.py, parametersforsolweig.json, configsolweig.ini – configuration and common utilities
– util/ – vendor code from SEBESOLWEIGCommonFiles and other misc utilities
• demos/ – example Python scripts plus demo datasets (GeoTIFF, shapefiles, EPW weather files)
• tests/ – unit tests for core calculations
• deprecated/ – legacy code kept for reference
README insights
• Headless Python workflows (no QGIS dependency)
• Demo scripts at /demos and testing workflows
• Upstream origin from UMEP-processing and GPLv3 license
Capturing essential elements
• Tests as a parallel validation flow fed from Core Solver outputs back to tests/.