Quickstart

SWMManywhere is a Python tool to synthesise Urban Drainage Models (UDM) anywhere in the world. It handles everything from data acquisition to running the UDM in the SWMM software.

Install SWMManywhere

Install SWMManywhere:

pip install swmmanywhere

Run SWMManywhere

The intended use of SWMManywhere is via a Command Line Interface (CLI) that receives the path to a configuration file. You can copy the minimum viable configuration file and run SWMManywhere with the command below:

python -m swmmanywhere --config_path=/path/to/file.yml

which will create a SWMM input file (.inp) at the file location:

<base_dir>/<project>/bbox_1/model_1/model_1.inp

Use your model

If you prefer GUIs then the easiest thing now is to download the SWMM software and load your model in there. The example above looks as follows:

From here you can run or edit your model.

If you want to investigate your model in GIS, then the geospatial data that was formatted into the model file (model_1.inp) is also available at:

<base_dir>/<project>/bbox_1/model_1/nodes.geojson
<base_dir>/<project>/bbox_1/model_1/edges.geojson
<base_dir>/<project>/bbox_1/model_1/subcatchments.geojson

Not happy with your model?

Then it sounds like you want to explore the wide range of customisability that SWMManywhere offers! See our guides to understand what is going on in greater detail and how to create better synthetic UDMs.