Aggregated Parameter

General Description

A collection of IndexParameters. This class behaves like a set. Parameters can be added or removed from it. It’s value is the value of it’s child parameters aggregated using a aggregating function (e.g. sum). API Reference

Attributes

Name	Description	Required
type	aggregated	Yes
parameters	The parameters to aggregate	Optional
agg_func	The aggregation function. Must be one of {“sum”, “min”, “max”, “mean”, “product”}, or a callable function which accepts a list of values	Optional

Example

{
  "type": "AggregatedParameter",
  "agg_func": "product",
  "parameters": [
    "Baseline demand",
    "Control curve demand factor"
  ]
}

In this case Aggregated Parameter is multipliying two parameters togther

• Baseline demand
• Control curve demand factor

This example shows a Baseline demand being multiplied by a factor that reduces demand based on a reservoir control curve. You can click on the each of these Parameters to see how they are defined.