Skip to main content

PySWMM

Projects involved it PySWMM:

  • PySWMM
  • SWMM-Toolkit

Both of these can be installed with a pip package.

Note * The Swmm pip package is not required. Therefore we do not want to install it. This has been proven by it not being installed on linux machine and by removing it from a windows machine then running Generate Chama Inputs command in Chama. This is the chama command that runs PySwmm.

Open Water Analytics​

It looks like OWA is removing there SWMM Documentation. This along with PySWMM new documentation is concerning for OWA. Currently when you go to Open Water Analytics and look for there open source SWMM. The link for the documentation goes to a 404 and the Link to the Repository goes to the current repo on Git. Some of the Documentation in the repo still references OWA but links redirect to current repos.

A note about OWA website. It looks bad. A header a paragraph and a 2 sets of built points it does not look like a professional page. I don't think it looked like this when I was looking at EPANET what like 2 months ago.

Current Locations for Repos​

Current Documentation​

Looking at the website the people contributing to the PySwmm on the new website are familiar names including Katherine Ratliff.

What does PySwmm Require?​

When Installing PySWMM from pip on a clean Virtual environment the following are installed.

  • swmm-toolkit >= 0.9.0
  • julian >= 0.14
  • aenum >= 3.1.11

According to docs it requires Python 3.6 or Higher (64-bit x86-64)

Open Water analytics swmm toolkit​

They are currently on version 14.2 of the SWMM-Toolkit. All releases are here https://github.com/pyswmm/swmm-python/tags (Python) The best way to see the versions of the toolkit for what they are is to look at the

The minor releases happen any time there is a bug fix the major are all about SWMM versions. Not EPA SWMM but the Swmm found under PySWMM https://github.com/pyswmm/Stormwater-Management-Model/releases (C project)

This is the new location of OWA SWMM. So when a new version of OWA SWMM is released a New Toolkit update is released.

For Chama​

PySWMM​

The version of PySWMM we are currently using is 1.2.0

According to Documentation Version 1.2.0 is our best version of pyswmm yet. In this release, we have added the feature for updating pollutants during a simulation. This feature unlocks a new avenue of water quality modeling in SWMM. We are no longer restricted to the default pollutant models in SWMM. We can now represent almost any pollutant model in SWMM via Python 🥳.

Furthermore, this feature extends pollutant modeling to Links as well. This feature would let us model water quality dynamics like sediment resuspension in channels. We are excited to see all the amazing things the community will do with this new version of pyswmm 😁.

We have also improved the robustness of pyswmm and addressed a few 🐛 in this release.

SwmmToolkit​

The version we have of SWMM toolkit for chama is 0.9.0 is the toolkit for

OWA SWMM Pollutant Mod Support; OWA SWMM v.5.1.14 In this release, swmm-python adds support for updating pollutant mid-simulation! 🎉 . This feature should allow the users to use python and model almost any pollutant treatment. This feature has been a while in the making, and it is finally here. Kudos to @bemason and @karosc for their work in this release. Thanks to @jennwuu @michaeltryby for their continued effort in maintaining swmm-python

In v.0.9.0, we have included an updated version of OWA SWMM, v.5.1.14. We have also addressed build issues conda wheels, more robust testing, and several other refinements.

May your simulations always converge, and you never encounter dependency issues ☮️

Current Version​

Current PySWMM​

The Current PySWMM version is 1.4.0

Changes made to the version are as follows according to documentation.

(version 1.3.0) Issues Closed Bugs fixed Issue 360 - node hrt accessor fixed Pull Requests Merged Unit test with OWA SWMM 5.1.15 PR 374 - debug LID tutorial code PR 377 - updates to readme.md for pyswmm.org website PR 393 - updates to readme.md for pyswmm youtube channel PR 392 - overhaul pyswmm sphinx docs

(version 1.4.0) New Features added pip extras to enable easily installing pyswmm with different versions of swmm-toolkit/OWA SWMM

Current SwmmToolkit​

The Current SWMM toolkit is 14.0 is OWA SWMM v5.2.3; drain inlet support

Last updated on by Viraj