pywr.recorders.SeasonalFlowDurationCurveRecorder¶
-
class
pywr.recorders.
SeasonalFlowDurationCurveRecorder
¶ This recorder calculates a flow duration curve for each scenario for a given season specified in months.
Parameters: - model : pywr.core.Model
- node : pywr.core.Node
The node to record
- percentiles : array
The percentiles to use in the calculation of the flow duration curve. Values must be in the range 0-100.
- agg_func: str, optional
function used for aggregating the FDC across percentiles. Numpy style functions that support an axis argument are supported.
- fdc_agg_func: str, optional
optional different function for aggregating across scenarios.
- months: array
The numeric values of the months the flow duration curve should be calculated for.
-
__init__
($self, /, *args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
after
aggregated_value
before
finish
is_season
load
register
reset
setup
to_dataframe
Return a pandas.DataFrame of the recorder data unregister
values
Compute a value for each scenario using temporal_agg_func. Attributes
agg_func
children
comment
data
epsilon
fdc
ignore_nan
is_constraint
is_objective
model
name
node
parents
temporal_agg_func