Flow Duration Curve Deviation Recorder

General Description

This recorder calculates a Flow Duration Curve (FDC) for each scenario and then calculates their deviation from upper and lower target FDCs. The 2nd dimension of the target duration curves and percentiles list must be of the same length and have the same order (high to low values or low to high values).

Deviation is calculated as positive if actual FDC is above the upper target or below the lower target. If actual FDC falls between the upper and lower targets zero deviation is returned. API Reference

Attributes

Name	Description	Required
model	pywr.core.Model	Yes
node	The node to record	Yes
percentiles	The percentiles to use in the calculation of the flow duration curve. Values must be in the range 0-100	Yes
lower_target_fdc	The lower FDC against which the scenario FDCs are compared	Yes
upper_target_fdc	The upper FDC against which the scenario FDCs are compared	Yes
agg_func	Function used for aggregating the FDC deviations across percentiles. Numpy style functions that support an axis argument are supported	Yes
fdc_agg_func	Optional different function for aggregating across scenarios	Yes

Example

coming soon...

{

}