Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
A collection of IndexParameters
This class behaves like a set. Parameters can be added or removed from it. Its index is the index of it’s child parameters aggregated using a aggregating function (e.g. sum). API Reference
agg_func
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
parameters
parameters: list
parents
size
coming soon...
Parameter that takes maximum of another Parameter and constant value (threshold).
This class is a more efficient version of AggregatedParameter where a single Parameter is compared to constant value. API Reference
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
parameter
parameter: pywr.parameters._parameters.Parameter
parents
size
threshold
threshold: ‘double’
coming soon...
Parameter that takes negative of another Parameter. API Reference
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
parameter
parameter: pywr.parameters._parameters.Parameter
parents
size
coming soon...
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).
In this case Aggregated Parameter is multipliying two parameters togther
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.
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
parameter
parameter: pywr.parameters._parameters.Parameter
parents
size
threshold
threshold: ‘double’
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
parameter
parameter: pywr.parameters._parameters.Parameter
parents
size
threshold
threshold: ‘double’
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
offset
The offset to apply to the value returned by parameter
parameter
The parameter to compare with the float
lower_bounds
The lower bounds of the offset when used during optimisation
upper_bounds
The upper bounds of the offset when used during optimisation
parents
size
children
comment
comment: unicode
denominator
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
numerator
parents
size
children
comment
comment: unicode
double_size
double_size: ‘int’
integer_size
integer_size: ‘int’
is_variable
is_variable: ‘bool’
model
name
parameter
parameter: pywr.parameters._parameters.Parameter
parents
size
threshold
threshold: ‘double’
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