The SUEWS model that speaks Python
Project description
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
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
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file supy-2026.4.3-cp314-cp314-win_amd64.whl.
File metadata
- Download URL: supy-2026.4.3-cp314-cp314-win_amd64.whl
- Upload date:
- Size: 13.0 MB
- Tags: CPython 3.14, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98ebc0881810747a28a284dc08a7b6c7484b637369570cea4ccac09e3fc53b16
|
|
| MD5 |
eb8d8e682daddc368b395388757906f2
|
|
| BLAKE2b-256 |
679c128c3aae7625b2699f1432883704d006bc0c2134b6e050682297852b4b86
|
File details
Details for the file supy-2026.4.3-cp314-cp314-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp314-cp314-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 8.8 MB
- Tags: CPython 3.14, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61500b58d4fb49ef9b2678444554b7228d8c983cd79e555fe3be7be361feb75b
|
|
| MD5 |
41402711e30376a881be61b653714c9b
|
|
| BLAKE2b-256 |
29db16e6825104addf95b18e782ce25497a9f873bec26dfe687ffea1ed9779da
|
File details
Details for the file supy-2026.4.3-cp314-cp314-macosx_15_0_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp314-cp314-macosx_15_0_x86_64.whl
- Upload date:
- Size: 8.6 MB
- Tags: CPython 3.14, macOS 15.0+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57d8cf2aa788805148cba9007937a641fae0142de3b54c3bf846e9090188ea5e
|
|
| MD5 |
18772c34513d2dd664a35fa835e05456
|
|
| BLAKE2b-256 |
22c962bbf752e547325933cae6b0ae51250055382c705963d074bfe69e27be16
|
File details
Details for the file supy-2026.4.3-cp314-cp314-macosx_15_0_arm64.whl.
File metadata
- Download URL: supy-2026.4.3-cp314-cp314-macosx_15_0_arm64.whl
- Upload date:
- Size: 7.4 MB
- Tags: CPython 3.14, macOS 15.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
97980beeee0ea96083961c603b14ec64326fbf4eb7f89924aea0940ecbb9a9d4
|
|
| MD5 |
82b47918e2343d32ccfe9caf4fa9c71f
|
|
| BLAKE2b-256 |
71f2b84d368cd35f8fc39a5f2b380d05cbe274489bba48c571bf6998943ddca2
|
File details
Details for the file supy-2026.4.3-cp313-cp313-win_amd64.whl.
File metadata
- Download URL: supy-2026.4.3-cp313-cp313-win_amd64.whl
- Upload date:
- Size: 12.7 MB
- Tags: CPython 3.13, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ea112c17d83e8aa29e2df4a64443989d1dea2054085f9403a24d4344a061b43
|
|
| MD5 |
85c93aea015300eb479a571db634c136
|
|
| BLAKE2b-256 |
3880eb30a7a232359186d63c8e7ecc6fbebb2a2979b97d144b032fd294519212
|
File details
Details for the file supy-2026.4.3-cp313-cp313-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp313-cp313-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 8.8 MB
- Tags: CPython 3.13, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
76a7a3835b8e9d0b36a6de86e0f08067623a768eea598cc87194bf64cad8d84e
|
|
| MD5 |
205ab74a7036a6de5b49af44ecb323d1
|
|
| BLAKE2b-256 |
f9a8587212d6c77704ac7aa53bcc05cfb2c49b98efebb02484f158d38fe61fdf
|
File details
Details for the file supy-2026.4.3-cp313-cp313-macosx_15_0_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp313-cp313-macosx_15_0_x86_64.whl
- Upload date:
- Size: 8.6 MB
- Tags: CPython 3.13, macOS 15.0+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44448f978c4119ab0f926cdad97947379fda792f1730c9cc7d6b77101ae0233a
|
|
| MD5 |
9c8d3245f0d2c0ad30584faac08c4e7e
|
|
| BLAKE2b-256 |
adb5d9c6f7026dd2be2603ac872f9fe31bba3d3193a26755a9e3df8994f818f8
|
File details
Details for the file supy-2026.4.3-cp313-cp313-macosx_15_0_arm64.whl.
File metadata
- Download URL: supy-2026.4.3-cp313-cp313-macosx_15_0_arm64.whl
- Upload date:
- Size: 7.4 MB
- Tags: CPython 3.13, macOS 15.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
18ee99556ee858d916121941a0c022cd0d5bbd7f2db8b97c8d788d4fcd2398b2
|
|
| MD5 |
fe42381953b69b4b954bbbce1af300aa
|
|
| BLAKE2b-256 |
7fcb6c6821c2a0f19796f98e385e326a5cf9a261ed4bf9cd7758b7200a5d586f
|
File details
Details for the file supy-2026.4.3-cp312-cp312-win_amd64.whl.
File metadata
- Download URL: supy-2026.4.3-cp312-cp312-win_amd64.whl
- Upload date:
- Size: 12.7 MB
- Tags: CPython 3.12, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
58ffee1162627f7699cf08e0d16d7a5040f500bf3dd53ed928b5fbe79ab7fb7f
|
|
| MD5 |
bd31754f64f77aedf69894a0915b7a60
|
|
| BLAKE2b-256 |
485d05fe4433810a304b844f29a3d11e54eda69728a1324aec4f020e58268cfa
|
File details
Details for the file supy-2026.4.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
- Upload date:
- Size: 8.7 MB
- Tags: CPython 3.12, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ea111036ac76dee52dff5672b5b5629ad54082f23f72747c9238cc8fc4ab356
|
|
| MD5 |
0d797c757a3d95cc91af1a2d46cfb0b4
|
|
| BLAKE2b-256 |
e7c9b113a6863a18e419c8fa3290c5b5b77b78dbd9bee91884b1f1ca16c5ba1e
|
File details
Details for the file supy-2026.4.3-cp312-cp312-macosx_15_0_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp312-cp312-macosx_15_0_x86_64.whl
- Upload date:
- Size: 8.6 MB
- Tags: CPython 3.12, macOS 15.0+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
777346d13579c3d6ac6fb9a46f422a0caae84dfaf06bee24d8a60d357618c586
|
|
| MD5 |
e552aba4637f8e321dabab35cdda7584
|
|
| BLAKE2b-256 |
9535c75ac9760b67259f4f1cc4b6d93a397a6a6e93bf39b683491a9cda88d719
|
File details
Details for the file supy-2026.4.3-cp312-cp312-macosx_15_0_arm64.whl.
File metadata
- Download URL: supy-2026.4.3-cp312-cp312-macosx_15_0_arm64.whl
- Upload date:
- Size: 7.4 MB
- Tags: CPython 3.12, macOS 15.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
79c88b3f4fdc8ae4fbcf10b9570470f7fdd1ee09206ddf332e06c622fa4d74dd
|
|
| MD5 |
a41caec2ab8031a739f2101d960869e0
|
|
| BLAKE2b-256 |
f076c2999642f290938e78221208def9124f47ba7161305931d2003894a278bd
|
File details
Details for the file supy-2026.4.3-cp311-cp311-win_amd64.whl.
File metadata
- Download URL: supy-2026.4.3-cp311-cp311-win_amd64.whl
- Upload date:
- Size: 12.7 MB
- Tags: CPython 3.11, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73ff60455252bb3110282e5b1e8c1e67cac7630b81155d2d8eeb85745e74a8a7
|
|
| MD5 |
a6e8e2ac84e46a70dc6ce435f4675efc
|
|
| BLAKE2b-256 |
1fcffd9e24551cb4b2b274976a04d364dace5a1ff72ea207df86cb937f7c9839
|
File details
Details for the file supy-2026.4.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
- Upload date:
- Size: 8.7 MB
- Tags: CPython 3.11, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b6c02968c9f643ca7927170c47deeb84ee153e62fe72ca6f0441a80167acb5c2
|
|
| MD5 |
fe283b5dbb26ad081b3b6a0c06c13581
|
|
| BLAKE2b-256 |
07dcd92b425c0e9b8eedf108e6866b341311efe5f3c5655ee50f870816197937
|
File details
Details for the file supy-2026.4.3-cp311-cp311-macosx_15_0_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp311-cp311-macosx_15_0_x86_64.whl
- Upload date:
- Size: 8.6 MB
- Tags: CPython 3.11, macOS 15.0+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
55ea2fe12009930e6ed546d28fe1c7b7508a073c83f23050194408253fd4d24c
|
|
| MD5 |
17733614328921d9b67cb57ad5c10390
|
|
| BLAKE2b-256 |
0ca0479e32f9e49d42fc7efbf5a6138b72cdf340b302b952641b2775d0539209
|
File details
Details for the file supy-2026.4.3-cp311-cp311-macosx_15_0_arm64.whl.
File metadata
- Download URL: supy-2026.4.3-cp311-cp311-macosx_15_0_arm64.whl
- Upload date:
- Size: 7.4 MB
- Tags: CPython 3.11, macOS 15.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52febdaeb57c37d6ed35c018a33552124c108018cd10ff2dd48c205b2c612b00
|
|
| MD5 |
e68a0b21483a035e7c71081d2b8c5c13
|
|
| BLAKE2b-256 |
3462fc2aae2ce54dc1fdaa8ef59a16ca87dfd516ba86b052854bdb1395512c83
|
File details
Details for the file supy-2026.4.3-cp310-cp310-win_amd64.whl.
File metadata
- Download URL: supy-2026.4.3-cp310-cp310-win_amd64.whl
- Upload date:
- Size: 12.7 MB
- Tags: CPython 3.10, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
34b17f97d1539b7ff1b3fc6839c88133e74482ce19320ad799e2bec7b63faf02
|
|
| MD5 |
c2fdf9c9951938172395bee38d312fb1
|
|
| BLAKE2b-256 |
ce1ded681eb73b1279b401276d0d66df4ed410d23b54411e7e3cbd7af4a43817
|
File details
Details for the file supy-2026.4.3-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
- Upload date:
- Size: 8.7 MB
- Tags: CPython 3.10, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb9013b6cb399f112c4b4bc3aa64bff1f2ed81355eb78a125af5870406b9a75d
|
|
| MD5 |
0225ab110ea7de545256eaf55a2b9223
|
|
| BLAKE2b-256 |
4b7a33b1cf843b9d9d35af493d07c6f28fbc24dbfe46847f935ec594f2440755
|
File details
Details for the file supy-2026.4.3-cp310-cp310-macosx_15_0_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp310-cp310-macosx_15_0_x86_64.whl
- Upload date:
- Size: 8.6 MB
- Tags: CPython 3.10, macOS 15.0+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6b84ffe0966d1d92ae37124963d63859846c226c53c68addd5c047b2bd2d27a
|
|
| MD5 |
7f2145c4b867663e4392e7c6c291a791
|
|
| BLAKE2b-256 |
2c5f1d3af4fc139139dbd95d56dac7760aaf766b3535017aa36586f07eb84181
|
File details
Details for the file supy-2026.4.3-cp310-cp310-macosx_15_0_arm64.whl.
File metadata
- Download URL: supy-2026.4.3-cp310-cp310-macosx_15_0_arm64.whl
- Upload date:
- Size: 7.4 MB
- Tags: CPython 3.10, macOS 15.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9a38cbaf86c8994b74c7a74fa3b458b04a83aeb3c0c5575c43511f69db8e2c7
|
|
| MD5 |
96bde5bb55006983950d202230f8608e
|
|
| BLAKE2b-256 |
5acb7de76a0f2f24c86def7a481e7e36530ceecad82d7f33039d05efe2ad6f3a
|
File details
Details for the file supy-2026.4.3-cp39-cp39-win_amd64.whl.
File metadata
- Download URL: supy-2026.4.3-cp39-cp39-win_amd64.whl
- Upload date:
- Size: 12.7 MB
- Tags: CPython 3.9, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd9d8575286ec3a5e88e1f23c2c66344bfc264fd722d91afe714f9f57ec1a9a0
|
|
| MD5 |
951ddfacc99f75bfd8eb8fd9690b6436
|
|
| BLAKE2b-256 |
2413c427fb9fc61a6989d4759f51a0afc4d4ce217e976018165a2b3d9567f5d9
|
File details
Details for the file supy-2026.4.3-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
- Upload date:
- Size: 8.7 MB
- Tags: CPython 3.9, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
51c8af56e296fdb2bd727c9fd1a3abbfbbb7fe06425141f697c94e81567c81e2
|
|
| MD5 |
a3aa78b76706992c57cf22acfc345c3d
|
|
| BLAKE2b-256 |
6a25c94e84810047db9a5554e8160dcc56f95948c9623a8e78874576fcc31fc5
|
File details
Details for the file supy-2026.4.3-cp39-cp39-macosx_15_0_x86_64.whl.
File metadata
- Download URL: supy-2026.4.3-cp39-cp39-macosx_15_0_x86_64.whl
- Upload date:
- Size: 8.6 MB
- Tags: CPython 3.9, macOS 15.0+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dec8d652a4b037a50965da35ad2afe56e974fd92b79414a95faba51f8d510e60
|
|
| MD5 |
9250dc6fb7ee83b2095df72741fd108b
|
|
| BLAKE2b-256 |
dae008a3485f2bc049133175de9f6e433e7566eb9cb0af77ee533205b88c1677
|
File details
Details for the file supy-2026.4.3-cp39-cp39-macosx_15_0_arm64.whl.
File metadata
- Download URL: supy-2026.4.3-cp39-cp39-macosx_15_0_arm64.whl
- Upload date:
- Size: 7.4 MB
- Tags: CPython 3.9, macOS 15.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c6db94713f9dd521e0fddec963d5068929732c4b162b051135eebc1517ba61a
|
|
| MD5 |
dfa9454105c79da39d1b3eb2dab8951b
|
|
| BLAKE2b-256 |
630121d098e337cb48b6befcb753e4aca1650e657d8bc5d9de4aeb7b0ca2293d
|