pystorms documentation

pystorms is a simulation sandbox for developing and evaluating stormwater control algorithms. It ships a set of anonymized, real world inspired stormwater networks, each paired with a driving event and a control objective, behind a small programming interface that hides the simulation engine.

Version 2.0 adds a harder version of five of the scenarios and three level settings that degrade the sensors and actuators the controller has to work with. Start with pystorms, then read Versions and levels.

• pystorms
  • Installation
  • Getting Started
  • Closing a scenario
  • Background
  • Citation
  • License
• Versions and levels
  • Scenario versions
  • Difficulty levels
  • Changes to reported numbers in 2.0
• Scenarios
  • Scenarios in pystorms
  • Jupyter Notebooks
  • Example: Scenario Theta
• Building Custom Scenarios
  • Anonymize the stormwater network
  • Event driver
  • Control objective and performance metric
  • Choose the state and action space
  • Building the pystorms scenario class
• Advanced
  • Multi-processing
  • pyswmm functionality
  • Defining States
• Contributing
  • Steps for contributing
  • Addressing a bug fix
  • Testing
  • Details on where to include what