bulum.stats.swflo2s.swflo2s module

days_in_ecological_low_flow_periods(df: DataFrame, flow_threshold, duration_days, months=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], as_percentage=True)

ECOLOGICAL LOW FLOW PERIODS This EFO INDICATOR measures the occurance of undesirable low-flow periods, in certain months. The EFO says the percentage of days in ‘ecological asset low flow periods’ in certain months cannot increase above some given value. And it defines ‘ecological asset low flow periods’ as periods longer than some duration_days, when the flow was less than some flow_threshold.

Returns:

_description_

Return type:

_type_

days_in_no_flow_periods(df: DataFrame, flow_threshold=2, duration_days=60, as_percentage=True)

DAYS IN NO-FLOW PERIODS (WATERHOLES) This EFO INDICATOR measures the occurance of undesirable periods when the flow effectivley ceases (<=2ML/d) for longer than a given duration. The EFO says the percentage of days in ‘no flow periods’ cannot increase above some given value.

Returns:

_description_

Return type:

_type_

days_in_riffle_drown_out_periods(df: DataFrame, flow_threshold, as_percentage=True)

DAYS IN RIFFLE DROWN-OUT PERIODS This EFO INDICATOR measures the number of days in undesirable flow ranges above the riffle-drown-out threshold, when the water level is above the rocks and airation is less effective. This is used instead of “days_in_riffle_periods” used in some water plans.

Returns:

_description_

Return type:

_type_

days_in_riffle_periods(df: DataFrame, lower_threshold, upper_threshold, as_percentage=True)

DAYS IN RIFFLE PERIODS This EFO INDICATOR is about maintaining the number of days in desirable flow range beneficial to riffle habitat. There is an upper and lower threshold. There is no duration requirement, or seasonal component.

Returns:

_description_

Return type:

_type_

days_in_riparian_low_flow_periods(df: DataFrame, flow_threshold, duration_days=365, as_percentage=True)

DAYS IN RIPARIAN (OR FLOODPLAIN VEG) LOW FLOW PERIODS This EFO INDICATOR measures undesirable periods between the floods necessary for riparian and floodplain health. The plan defines these undesirable periods as periods longer than 1 year (duration_days=365) when the flow was less than some flow_threshold.

Returns:

_description_

Return type:

_type_

days_in_river_forming_periods(df: DataFrame, flow_threshold, as_percentage=True)

DAYS IN RIVER FORMING PERIODS This EFO INDICATOR measures the number of days in high-flow periods necessary for river forming processes. Note this is not exactly the same as “days_in_riffle_drown_out_periods” because that compares using ‘>=’ while this compares using ‘>’.

Returns:

_description_

Return type:

_type_

mean_annual_flow(df: DataFrame, wy_month=7)

MEAN ANNUAL FLOW This EFO INDICATOR is the mean flow in ML/y.

Returns:

_description_

Return type:

_type_