Numpy Array Daily Profile Parameter Recorder

General Description

Recorder for an annual profile from a Parameter.

This recorder stores a daily profile returned by a specific parameter. For each day of the year it stores the value encountered for that day during a simulation. This results in the final profile being the last value encountered on each day of the year during a simulation. This recorder is useful for returning the daily profile that may result from the combination of one or more parameters. For example, during optimisation of new profiles non-daily parameters (e.g. RbfProfileParameter) and/or aggregations of several parameters might be used. With this recorder the daily profile used in the simulation can be easily saved.

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. For aggregation over scenarios see the agg_func keyword argument	Yes

Example

coming soon...

{

}