pystorms
Simulation Sandbox for the Design and Evaluation of Stormwater Control Algorithms
Science Score: 46.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: acm.org -
✓Committers with academic emails
3 of 11 committers (27.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.5%) to scientific vocabulary
Repository
Simulation Sandbox for the Design and Evaluation of Stormwater Control Algorithms
Basic Info
- Host: GitHub
- Owner: kLabUM
- License: gpl-3.0
- Language: Jupyter Notebook
- Default Branch: master
- Homepage: https://pystorms.netlify.app
- Size: 436 MB
Statistics
- Stars: 33
- Watchers: 8
- Forks: 16
- Open Issues: 3
- Releases: 5
Metadata Files
README.md
pystorms: simulation sandbox for the evaluation and design of stormwater control algorithms
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
bash
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.
```python 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.
python
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.
python
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
- Name: Real-time water systems lab
- Login: kLabUM
- Kind: organization
- Repositories: 28
- Profile: https://github.com/kLabUM
GitHub Events
Total
- Issues event: 1
- Watch event: 7
- Push event: 26
- Create event: 1
Last Year
- Issues event: 1
- Watch event: 7
- Push event: 26
- Create event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- 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 requests: 8
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 2.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- abhiramm7 (19)
- Jiadalee (2)
- gregjewi (1)
Pull Request Authors
- abhiramm7 (8)
- jsadler2 (1)
- aakin4 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 107 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 27
- Total maintainers: 1
proxy.golang.org: github.com/kLabUM/pystorms
- Documentation: https://pkg.go.dev/github.com/kLabUM/pystorms#section-documentation
- License: gpl-3.0
-
Latest release: v1.0.0
published about 4 years ago
Rankings
proxy.golang.org: github.com/klabum/pystorms
- Documentation: https://pkg.go.dev/github.com/klabum/pystorms#section-documentation
- License: gpl-3.0
-
Latest release: v1.0.0
published about 4 years ago
Rankings
pypi.org: pystorms
Simulation sandbox for stormwater control algorithms
- Homepage: https://github.com/kLabUM/pystorms
- Documentation: https://pystorms.readthedocs.io/
- License: GNU Lesser General Public License v3 (LGPLv3)
-
Latest release: 1.0.0
published almost 4 years ago
Rankings
Maintainers (1)
Dependencies
- numpy >=1.18.4
- pyswmm >=1.0.1
- pyyaml >=5.3
- actions/checkout master composite
- actions/setup-python v2 composite
- pypa/gh-action-pypi-publish master composite
- actions/checkout v2 composite
- actions/setup-python v2 composite