System Module#

System module for the pythonic interface to SWMM5.

class SystemStats(model)[source]#

Bases: object

System-Wide Flow and Runoff Routing Accumulation Volume Methods.

Parameters:

model (object) – Open Model Instance

Examples:

>>> from pyswmm import Simulation, SystemStats
>>>
>>> with Simulation('tests/data/TestModel1_weirSetting.inp') as sim:
...     system_routing = SystemStats(sim)
...
...     for step in sim:
...         print(system_routing.routing_stats)
...         print(system_routing.runoff_stats)
property routing_stats#

Get rolling/cumulative routing stats. Follow Data are returned:

dry_weather_inflow

wet_weather_inflow

groundwater_inflow

II_inflow

external_inflow

flooding

outflow

evaporation_loss

seepage_loss

reacted

initial_storage

final_storage

routing_error

Returns:

Statistics

Return type:

dict

property runoff_stats#

Get rolling/cumulative runoff stats. Follow Data are returned:

rainfall

evaporation

infiltration

runoff

drains

runon

init_storage

final_storage

init_snow_cover

final_snow_cover

snow_removed

routing_error

Returns:

Statistics

Return type:

dict