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 :doc:`getting_started`, then read
:doc:`versions_and_levels`.

.. toctree::
   :maxdepth: 2

   getting_started
   versions_and_levels
   scenarios
   building_scenarios
   advanced
   contributing