pywr.recorders.SeasonalFlowDurationCurveRecorder

class pywr.recorders.SeasonalFlowDurationCurveRecorder(model, AbstractNode node, percentiles, months, **kwargs)

This recorder calculates a flow duration curve for each scenario for a given season specified in months.

Parameters:
modelpywr.core.Model
nodepywr.core.Node

The node to record

percentilesarray

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__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

after(self)

aggregated_value(self)

before(self)

finish(self)

is_constraint_violated(self)

Returns true if the value from this Recorder violates its constraint bounds.

is_season(self, x)

load(cls, model, data)

register(cls)

reset(self)

setup(self)

to_dataframe(self)

Return a pandas.DataFrame of the recorder data

unregister(cls)

values(self)

Compute a value for each scenario using temporal_agg_func.

Attributes

agg_func

children

comment

comment: unicode

constraint_lower_bounds

constraint_upper_bounds

data

epsilon

epsilon: 'double'

factor

factor: 'float'

fdc

ignore_nan

ignore_nan: 'bool'

is_constraint

Returns true if either upper or lower constraint bounds is defined.

is_double_bounded_constraint

Returns true if upper and lower constraint bounds are both defined and not-equal to one another.

is_equality_constraint

Returns true if upper and lower constraint bounds are both defined and equal to one another.

is_lower_bounded_constraint

Returns true if lower constraint bounds is defined and upper constraint bounds is not.

is_objective

is_upper_bounded_constraint

Returns true if upper constraint bounds is defined and lower constraint bounds is not.

model

name

node

parents

tags

tags: dict

temporal_agg_func