1 of 6

Deficit Recorders

Numpy Array Node Deficit Recorder

General Description

Recorder for timeseries of deficit from a Node. This class stores deficit from a specific node for each time-step of a simulation. The data is saved internally using a memory view. The data can be accessed through the data attribute or to_dataframe() method. API Reference

deficit = max_flow - actual_flow

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

temporal_agg_func

Aggregation function used over time when computing a value per scenario. This can be used to return, for example, the median flow over a simulation. For aggregation over scenarios see the agg_func keyword argument.

Optional

Example

coming soon...

{

}

Numpy Array Node Supplied Ratio Recorder

General Description

Recorder for timeseries of ratio of supplied flow from a Node. This class stores supply ratio from a specific node for each time-step of a simulation. The data is saved internally using a memory view. The data can be accessed through the data attribute or to_dataframe() method. API Reference

supply_ratio = actual_flow / max_flow

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

temporal_agg_func

Optional

Example

coming soon...

{

}

Numpy Array Node Curtailment Ratio Recorder

General Description

Recorder for timeseries of curtailment ratio from a Node. This class stores curtailment ratio from a specific node for each time-step of a simulation. The data is saved internally using a memory view. The data can be accessed through the data attribute or to_dataframe() method. API Reference

curtailment_ratio = 1 - actual_flow / max_flow

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

temporal_agg_func

Optional

Example

coming soon...

{

}

Total Deficit Node Recorder

General Description

Recorder to total the difference between modelled flow and max_flow for a Node. API Reference

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

comment

Optional

Example

coming soon...

{

}

Deficit Frequency Node Recorder

General Description

Recorder to return the frequency of timesteps with a failure to meet max_flow. API Reference

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

comment

Optional

Example

coming soon...

{

}

Numpy Array Node Curtailment Ratio Recorder

General Description

curtailment_ratio = 1 - actual_flow / max_flow

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

temporal_agg_func

Optional

Example

coming soon...

{

}

Numpy Array Node Supplied Ratio Recorder

General Description

supply_ratio = actual_flow / max_flow

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

temporal_agg_func

Optional

Example

coming soon...

{

}

Numpy Array Node Deficit Recorder

General Description

deficit = max_flow - actual_flow

Attributes

Name

Description

Required

model

node

Node instance to record

Optional

temporal_agg_func

Optional

Example

coming soon...

{

}