Skip to main content

The SUEWS model that speaks Python

Project description

SUEWS

Surface Urban Energy and Water Balance Scheme

PyPI Documentation License: MPL-2.0 CI DOI


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

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

Licence

Mozilla Public License 2.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

supy-2026.6.5-cp39-abi3-win_amd64.whl (13.8 MB view details)

Uploaded CPython 3.9+Windows x86-64

supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (10.3 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl (10.2 MB view details)

Uploaded CPython 3.9+macOS 15.0+ x86-64

supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl (9.0 MB view details)

Uploaded CPython 3.9+macOS 15.0+ ARM64

File details

Details for the file supy-2026.6.5-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: supy-2026.6.5-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 13.8 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for supy-2026.6.5-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 5914bae62a7223f22b0490c36a0a573d49acd3d066067eae20f2e508eab091f3
MD5 899997c8cdd14d2b213e37f873e6401f
BLAKE2b-256 63fa9baf7bf434aa43c5eeba055100dfd0b76493777b74663082c8011b1688a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for supy-2026.6.5-cp39-abi3-win_amd64.whl:

Publisher: build-publish_to_pypi.yml on UMEP-dev/SUEWS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 931664158b10edbeeffe6ecae9c919225d2dc4290d830471715f5310e9acf9ea
MD5 2ab32a0be6fb664a4b19cb56492640dc
BLAKE2b-256 1b9238a1703ae5a7902f723cc74988bdc4af014b21d6becea1915f094e8efee7

See more details on using hashes here.

Provenance

The following attestation bundles were made for supy-2026.6.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl:

Publisher: build-publish_to_pypi.yml on UMEP-dev/SUEWS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 52c1002fadddbad83c0c649b448d507bdeebb9b286dde815e1467b846bfc6ab2
MD5 a54ac90959a530cfa0bb1ac3e09d5ae0
BLAKE2b-256 6b4cc75587d164c3e1825e162c1db75df27725da2ce1dbb15fc5be00408cee71

See more details on using hashes here.

Provenance

The following attestation bundles were made for supy-2026.6.5-cp39-abi3-macosx_15_0_x86_64.whl:

Publisher: build-publish_to_pypi.yml on UMEP-dev/SUEWS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 6cbfc355a0694f92128cdaede7e23c78bff85275963901414020c34ecf9ec0ed
MD5 b73a381d0d3e4633e411465e9e35d7d7
BLAKE2b-256 2e550606a1451d7f7732547c1c32f5dd3c44969332d064834823294c1be0af0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for supy-2026.6.5-cp39-abi3-macosx_15_0_arm64.whl:

Publisher: build-publish_to_pypi.yml on UMEP-dev/SUEWS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page