pywr.recorders.MeanParameterRecorder¶
-
class
pywr.recorders.
MeanParameterRecorder
¶ Record the mean 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.
Parameters: - model : pywr.core.Model
- param : pywr.parameters.Parameter
The parameter to record.
- name : str (optional)
The name of the recorder
- factor : float (default=1.0)
Scaling factor for the values of param.
-
__init__
($self, /, *args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
after
aggregated_value
before
finish
load
register
reset
setup
unregister
values
Attributes
agg_func
children
comment
epsilon
factor
ignore_nan
is_constraint
is_objective
model
name
parameter
parents