Total Parameter Recorder

General Description

Record the total value of a Parameter during a simulation.

This recorder can be used to track the sum total of the values returned by a Parameter during a models simulation. An optional factor can be provided to apply a linear scaling of the values. If the parameter represents a flux the integrate keyword argument can be used to multiply the values by the time-step length in days. API Reference

Attributes

Name	Description	Required
model	pywr.core.Model	Optional
param	The parameter to record	Required
name	The name of the recorder	Optional
factor	Scaling factor for the values of param	Optional
integrate	Whether to multiply by the time-step length in days during summation	Optional

Example

coming soon…

{

}