Aggregated Recorder
General Description
Section titled “General Description”This Recorder is used to aggregate across multiple other Recorder objects.
The class provides a method to produce a complex aggregated recorder by taking the results of other records. The .values() method first collects unaggregated values from the provided recorders. These are then aggregated on a per scenario basis and returned by this classes .values() method. This method allows AggregatedRecorder to be used as a recorder for in other AggregatedRecorder instances.
By default the same agg_func function is used for both steps, but an optional recorder_agg_func can undertake a different aggregation across scenarios. For example summing recorders per scenario, and then taking a mean of the sum totals. API Reference
Attributes
Section titled “Attributes”| Name | Description | Required |
|---|---|---|
| model | pywr.core.Model | Optional |
| recorders | The other Recorder instances to perform aggregation over | Optional |
| agg_func | Scenario aggregation function to use when aggregated_value is called (default=”mean”) | Optional |
| recorder_agg_func | Recorder aggregation function to use when aggregated_value is called (default=agg_func) | Optional |
Example
Section titled “Example”coming soon…
{
}