Structure.floodEvents

Structure.floodEvents(inter_event_period=6, thresholdFood=0.01)

Bins flooding data into discrete events based on an inter-event period and threshold flooding rate. Maximum flooding rates and duration of each flooding event are returned in a DataFrame.

TODO: add in ponded depth when inp file is integrated. Ponded volume from out file is tough to interpret alone.

Parameters:

inter_event_period: float, optionalep

The period in hours of flooding less than or equal to thresholdFlood that demarks flow events, default to 6

thresholdFood: float, optional

The flooding rate in model flow units above which should be considered in calculations, default to 0.01

Returns:

pd.DataFrame

DataFrame with statistics on each flooding event