![]() |
OpenSWMM Engine
6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
|
The Open-Source Storm Water Management Model (SWMM2D) — Next-Generation Computational Engine
OpenSWMM is an open-source hydrology, hydraulic, and water-quality engine built on EPA SWMM. It provides a reentrant C++20 implementation, a public C API, Python bindings, and a command-line solver. The legacy SWMM 5.x solver and output reader remain available alongside the new engine.
Engine documentation · Python documentation · SWMMVis GUI
The source version is 6.0.0-alpha.4. The following summarizes the implementation as of October 21, 2026; feature availability depends on the build and selected solver.
FLOW_ROUTING FV). Dynamic-wave extensions include semi-implicit node continuity, Anderson acceleration, and dynamic Preissmann slots. Street/inlet capture, variable-speed pumps and additional storage geometries are supported.Kokkos OpenMP, CUDA, HIP and SYCL surface-solver plugins load separately from the core engine. The default source build includes the OpenMP plugin; device backends need their matching toolchains. An optional host OpenMP operator computes raw CLOSED_FORM groundwater recharge; water, transport, reactions and heat retain CPU ownership. Other groundwater acceleration remains outstanding; backend support is not interchangeable. See the 2D CPU implementation and qualification.
Use a node ID from your model in place of J1. The Python guide covers model construction, parameter editing, runtime forcing, results and checkpointing. Published packages may lag the source implementation described above.
Requires CMake 3.21+, C17/C++20 compilers, Ninja for the Linux/macOS presets, and vcpkg. Dependencies and optional features are declared in vcpkg.json.
Use Darwin on macOS or Windows from a Visual Studio Developer Prompt; on Windows, bootstrap vcpkg with bootstrap-vcpkg.bat and set VCPKG_ROOT in that shell. Build folders follow the platform preset. The legacy executable is openswmm-legacy.
To build and run the test suite:
Platform presets also provide -debug and -tests-release variants. See CMakePresets.json and CMake options for optional 2D, GPU, GeoPackage, HDF5, Python and HydroCouple builds. For Python source builds, use pip install ./python.
Contributions are welcome — bug reports, fixes, new features, docs, tests, and benchmarks.
ctest) and Python (pytest) tests pass.develop.First-time contributors must sign the project CLA before a pull request can be merged. The CLA grants the project a perpetual, royalty-free copyright and patent license to your contributions and preserves the project's ability to relicense in the future; you retain full copyright ownership of your work.
Signing is automated through CLA Assistant — when you open your first PR, a bot comments with a one-click sign-in link. The CLA covers all subsequent contributions, so you only sign once. Corporate contributors should additionally submit a CCLA per CLA §6.
OpenSWMM Engine is developed by HydroCouple: https://github.com/HydroCouple/openswmm.engine.
If you use it in your work, please cite the version you used. GitHub's Cite this repository button, generated from CITATION.cff, gives APA and BibTeX entries.
Apache License, Version 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE). Original EPA SWMM material is in the public domain under 17 USC § 105 and is not subject to the Apache license grant.
OpenSWMM builds on the EPA Storm Water Management Model. See docs/authors.md for the full contributor list.