SystemSeries#

class SystemSeries(out_handle)[source]#

Get a system time series. New to PySWMM-v2!

Note: you can use pandas to convert dict to a pandas Series object with dict keys as index

Returns:

dict of attribute values with between start_index and end_index with reporting timesteps as keys

Return type:

dict {datetime : value}

Examples:

from pyswmm import Output, SystemSeries

with Output('tests/data/model_full_features.out') as out:
    ts1 = SystemSeries(out).air_temp
    ts2 = SystemSeries(out).rainfall
    ts3 = SystemSeries(out).snow_depth
    ts4 = SystemSeries(out).evap_infil_loss
    ts5 = SystemSeries(out).runoff_flow
    ts6 = SystemSeries(out).dry_weather_inflow
    ts7 = SystemSeries(out).gw_inflow
    ts8 = SystemSeries(out).rdii_inflow
    ts9 = SystemSeries(out).direct_inflow
    ts10 = SystemSeries(out).total_lateral_inflow
    ts11 = SystemSeries(out).flood_losses
    ts12 = SystemSeries(out).outfall_flows
    ts13 = SystemSeries(out).volume_stored
    ts14 = SystemSeries(out).evap_rate
    ts15 = SystemSeries(out).ptnl_evap_rate

Methods

Attributes

air_temp

rainfall

snow_depth

evap_infil_loss

runoff_flow

dry_weather_inflow

gw_inflow

rdii_inflow

direct_inflow

total_lateral_inflow

flood_losses

outfall_flows

volume_stored

evap_rate

ptnl_evap_rate