Numpy Array Index Parameter Recorder

General Description

Recorder for timeseries information from an IndexParameter.

This class stores the value from a specific IndexParameter 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

Attributes

Name	Description	Required
model	pywr.core.Model	Yes
param	Parameter instance to record	Yes
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	Yes

Example

coming soon...

{

}