Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

pystorms

Simulation Sandbox for the Design and Evaluation of Stormwater Control Algorithms.
https://github.com/kLabUM/pystorms

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords from Contributors

hydrology swmm5

Last synced: about 16 hours ago
JSON representation

Repository metadata

Simulation Sandbox for the Design and Evaluation of Stormwater Control Algorithms

README.md

pystorms: simulation sandbox for the evaluation and design of stormwater control algorithms

pystorms
License: GPL v3
Code style: black

Overview

This library has been developed in an effort to systematize quantitative analysis of stormwater control algorithms.
It is a natural extension of the Open-Storm's mission to open up and ease access into the technical world of smart stormwater systems.
Our initial efforts allowed us to develop open source and free tools for anyone to be able to deploy flood sensors, measure green infrastructure, or even control storm or sewer systems.
Now we have developed a tool to be able to test the performance of algorithms used to coordinate these different sensing and control technologies that have been deployed throughout urban water systems.

For the motivation behind this effort, we refer the reader to our manuscript pystorms. In general, this repo provides a library of scenarios that are built to allow for systematic quantitative evaluation of stormwater control algorithms.

Getting Started

Installation

Requirements

  • PyYAML >= 5.3
  • numpy >= 18.4
  • pyswmm < 2.0.0
pip install pystorms

Please raise an issue on the repository or reach out if you run into any issues installing the package.

Example

Here is an example implementation on how you would use this library for evaluating the ability of a rule based control in maintaining the flows in a network below a desired threshold.

import pystorms 
import numpy as np

# Define your awesome controller 
def controller(state):
	actions = np.ones(len(state))
	for i in range(0, len(state)):
		if state[i] > 0.5:
			actions[i] = 1.0
	return actions 
	

env = pystorms.scenarios.theta() # Initialize scenario 

done = False
while not done:
	state = env.state()
	actions = controller(state)
	done = env.step(actions)

performance = env.performance()

Updated versions of theta, alpha, gamma, delta, and epsilon are accessible via a version keyword in the initialization command.

env = pystorms.scenarios.theta(version=version) # "1" is the default and original, "2" are the updated versions.

Sensor noise and actuator faults can also be enabled via the level keyword. The options are 1, 2, and 3 in ascending order of difficulty. Version or level or both can be specified.

env = pystorms.scenarios.theta(version=version, level=level) # "1" is the ideal, original, and default case. "2" is realistic and "3" is adverse.
env = pystorms.scenarios.theta(level=level) # also valid. This would load version 1 of the model.

More details on the updates are accessible at (preprint link). As of June 2025, these updates are only in the "dev" branch and have not yet been merged in "master."

Detailed documentation can be found on the webpage

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 164
Total Committers: 11
Avg Commits per committer: 14.909
Development Distribution Score (DDS): 0.39

Commits in past year: 1
Committers in past year: 1
Avg Commits per committer in past year: 1.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Abhiram a****m@u****u 100
Abhiram Mullapudi a****i@g****m 22
srimer s****r@a****v 13
rimersara s****r@g****m 12
Sara Troutman s****m@u****u 7
Sara Rimer s****r@C****n 3
stroutm s****n@x****m 2
Sara Rimer s****n@s****n 2
Travis Adrian Dantzer 4****t 1
Jeff Sadler j****2@g****m 1
Abhiram Mullapudi p****o@A****l 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 22
Total pull requests: 10
Average time to close issues: 9 months
Average time to close pull requests: 4 days
Total issue authors: 3
Total pull request authors: 3
Average comments per issue: 1.64
Average comments per pull request: 0.3
Merged pull request: 8
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 1
Past year pull request authors: 0
Past year average comments per issue: 2.0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/kLabUM/pystorms

Top Issue Authors

  • abhiramm7 (19)
  • Jiadalee (2)
  • gregjewi (1)

Top Pull Request Authors

  • abhiramm7 (8)
  • aakin4 (1)
  • jsadler2 (1)

Top Issue Labels

  • enhancement (11)
  • documentation (3)
  • bug (2)
  • qaqc (1)
  • clarification (1)

Top Pull Request Labels

Package metadata

proxy.golang.org: github.com/klabum/pystorms

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/klabum/pystorms#section-documentation
  • Licenses: gpl-3.0
  • Latest release: v1.0.0 (published over 3 years ago)
  • Last Synced: 2025-07-30T19:37:17.230Z (1 day ago)
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
proxy.golang.org: github.com/kLabUM/pystorms

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/kLabUM/pystorms#section-documentation
  • Licenses: gpl-3.0
  • Latest release: v1.0.0 (published over 3 years ago)
  • Last Synced: 2025-07-30T19:37:26.552Z (1 day ago)
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
pypi.org: pystorms

Simulation sandbox for stormwater control algorithms

  • Homepage: https://github.com/kLabUM/pystorms
  • Documentation: https://pystorms.readthedocs.io/
  • Licenses: GNU Lesser General Public License v3 (LGPLv3)
  • Latest release: 1.0.0 (published over 3 years ago)
  • Last Synced: 2025-07-30T19:37:17.225Z (1 day ago)
  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 103 Last month
  • Rankings:
    • Dependent packages count: 7.303%
    • Forks count: 9.144%
    • Stargazers count: 12.269%
    • Average: 17.525%
    • Dependent repos count: 22.068%
    • Downloads: 36.84%
  • Maintainers (1)

Dependencies

setup.py pypi
  • numpy >=1.18.4
  • pyswmm >=1.0.1
  • pyyaml >=5.3
.github/workflows/publish-to-test-pypi.yml actions
  • actions/checkout master composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/python-package.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi

Score: 10.635374561412004