Output.system_result

Output.system_result(time, asframe=True)

For a given time, get all system attributes.

Parameters:

time: Union[str, int, datetime]

The datetime or simulation index.

asframe: bool

A switch to return an indexed DataFrame. Set to False to get an array of values only, defaults to True.

Returns:

Union[pd.DataFrame,np.ndarray]

A DataFrame of attribute values in each row for requested simulation time.

Examples

Pull all attributes at start of simulation

>>> from swmm.pandas import Output,example_out_path
>>> out = Output(example_out_path)
>>> out.system_result('1900-01-01')
                            result
    attribute
    air_temp               70.000000
    rainfall                0.030000
    snow_depth              0.000000
    evap_infil_loss         0.013983
    runoff_flow             0.000000
    dry_weather_inflow      0.801000
    gw_inflow               0.101807
    rdii_inflow             0.000000
    direct_inflow           0.000000
    total_lateral_inflow    0.902807
    flood_losses            0.000000
    outfall_flows           0.000000
    volume_stored         168.436996
    evap_rate               0.000000
    ptnl_evap_rate          0.000000