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	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...

{

}