Recorder

General Description

Base class for recording information from a pywr.model.Model.

Recorder components are used to calculate, aggregate and save data from a simulation. This base class provides the basic functionality for all recorders. API Reference

Attributes

Name	Description	Required
model	pywr.core.Model	Yes
agg_func	Scenario aggregation function to use when aggregated_value is called	Yes
name	Name of the recorder
comment	Comment or description of the recorder
ignore_nan	Flag to ignore NaN values when calling aggregated_value
is_objective	Flag to denote the direction, if any, of optimisation undertaken with this recorder
epsilon	Epsilon distance used by some optimisation algorithms
constraint_lower_bounds, constraint_upper_bounds	The value(s) to use for lower and upper bound definitions. These values determine whether the recorder instance is marked as a constraint. Either bound can be None (the default) to disable the respective bound. If both bounds are None then the is_constraint property will return False. The lower bound must be strictly less than the upper bound. An equality constraint can be created by setting both bounds to the same value. The constraint bounds are not used during model simulation. Instead they are intended for use by optimisation wrappers (or other external tools) to define constrained optimisation problems.

Example

coming soon...

{

}