Surface Urban Energy and Water Balance Scheme
What is SUEWS?
SUEWS is a neighbourhood/local-scale urban land surface model that simulates the urban radiation, energy and water balances using commonly measured meteorological variables and surface cover information. It uses an evaporation-interception approach (Grimmond and Oke, 1991), similar to that used in forests, to model evaporation from urban surfaces.
The model represents seven surface types -- paved, buildings, evergreen trees/shrubs, deciduous trees/shrubs, grass, bare soil and water -- and tracks the running water balance of the canopy, soil moisture, and horizontal water movement above and below ground.
SuPy (SUEWS in Python) provides the modern interface, wrapping a Fortran physics engine and integrating with the scientific Python ecosystem (pandas, NumPy, matplotlib).
Key Features
- Energy balance: net all-wave radiation, sensible and latent heat fluxes, storage heat flux, anthropogenic heat
- Water balance: soil moisture, infiltration, runoff, drainage, irrigation demand
- Radiation schemes: NARP, SPARTACUS-Surface (3D), BEERS (mean radiant temperature)
- Storage heat schemes: OHM, AnOHM, ESTM, EHC (explicit heat conduction)
- Building energy: STEBBS (Simple Thermal Energy Balance for Building Scheme)
- Python API: YAML configuration, pandas DataFrames, programmatic simulations
- CLI tools:
suews-run,suews-validate,suews-convert,suews-schema
Quick Start
pip install supy
Run from the command line:
suews-run /path/to/config.yml
Or use the Python API:
from supy import SUEWSSimulation
sim = SUEWSSimulation.from_sample_data()
sim.run()
print(sim.output.summary())
Full documentation: docs.suews.io
Documentation
- Getting Started -- installation and first simulation
- Tutorials -- hands-on guides with sample data
- Input/Output Reference -- configuration and data formats
- Scientific Background -- physics schemes and parameterisations
- Community Forum -- questions, discussion, and support
Citation
If you use SUEWS in your research, please cite:
- Jarvi L, Grimmond CSB, Christen A (2011) The Surface Urban Energy and Water Balance Scheme (SUEWS): Evaluation in Los Angeles and Vancouver. J. Hydrol., 411, 219-237.
- Ward HC, Kotthaus S, Jarvi L, Grimmond CSB (2016) Surface Urban Energy and Water Balance Scheme (SUEWS): Development and evaluation at two UK sites. Urban Climate, 18, 1-32.
See CITATION.cff for machine-readable citation metadata.
Contributing
We welcome contributions from people who engage with the project. See CONTRIBUTING.md for guidelines. New contributors are encouraged to start on the Community Forum.
Development
git clone https://github.com/UMEP-dev/SUEWS.git && cd SUEWS
uv venv && source .venv/bin/activate
make dev && make test
- Onboarding Guide -- developer workflow and best practices
- Building Locally -- prerequisites, build commands, project structure
- Coding Guidelines -- style conventions and formatting tools
Licence
Metadata
Release files for supy 2026.6.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| supy-2026.6.5-cp39-abi3-win_amd64.whl | CPython 3.9 | abi3 | Windows x86-64 | Details for supy-2026.6.5-cp39-abi3-win_amd64.whl |
| supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl | CPython 3.9 | abi3 | Linux glibc 2.17+ x86-64 | Details for supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
| supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl | CPython 3.9 | abi3 | macOS 15.0+ x86-64 | Details for supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl |
| supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl | CPython 3.9 | abi3 | macOS 15.0+ ARM64 | Details for supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl |
Total release size: 43.3 MB
Release files / supy-2026.6.5-cp39-abi3-win_amd64.whl
| Download URL | supy-2026.6.5-cp39-abi3-win_amd64.whl |
|---|---|
| Size | 13.8 MB |
| Tags | CPython 3.9 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
5914bae62a7223f22b0490c36a0a573d49acd3d066067eae20f2e508eab091f3
|
|
BLAKE2b-256 checksum How to use checksums |
63fa9baf7bf434aa43c5eeba055100dfd0b76493777b74663082c8011b1688a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.
Transparency logRelease files / supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
931664158b10edbeeffe6ecae9c919225d2dc4290d830471715f5310e9acf9ea
|
|
BLAKE2b-256 checksum How to use checksums |
1b9238a1703ae5a7902f723cc74988bdc4af014b21d6becea1915f094e8efee7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.
Transparency logRelease files / supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl
| Download URL | supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl |
|---|---|
| Size | 10.2 MB |
| Tags | CPython 3.9 abi3 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
52c1002fadddbad83c0c649b448d507bdeebb9b286dde815e1467b846bfc6ab2
|
|
BLAKE2b-256 checksum How to use checksums |
6b4cc75587d164c3e1825e162c1db75df27725da2ce1dbb15fc5be00408cee71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.
Transparency logRelease files / supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl
| Download URL | supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl |
|---|---|
| Size | 9.0 MB |
| Tags | CPython 3.9 abi3 macOS 15.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
6cbfc355a0694f92128cdaede7e23c78bff85275963901414020c34ecf9ec0ed
|
|
BLAKE2b-256 checksum How to use checksums |
2e550606a1451d7f7732547c1c32f5dd3c44969332d064834823294c1be0af0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.
Transparency logSecurity for supy 2026.6.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 4 files in this release have been uploaded with provenance metadata.
Attestation for supy-2026.6.5-cp39-abi3-win_amd64.whl
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.