General Description

This Recorder is used to aggregate across multiple other Recorder objects.

The class provides a method to produce a complex aggregated recorder by taking the results of other records. The .values() method first collects unaggregated values from the provided recorders. These are then aggregated on a per scenario basis and returned by this classes .values() method. This method allows AggregatedRecorder to be used as a recorder for in other AggregatedRecorder instances.

By default the same agg_func function is used for both steps, but an optional recorder_agg_func can undertake a different aggregation across scenarios. For example summing recorders per scenario, and then taking a mean of the sum totals. API Reference

Attributes

Example

coming soon...

{

}

General Description

Record the mean value of a Parameter during a simulation.

This recorder can be used to track the mean 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. API Reference

Attributes

Example

coming soon...

{

}

General Description

Records the mean flow of a Node for the previous N timesteps. API Reference

Attributes

Example

coming soon...

{

}

General Description

Recorder to total the flow for a Node.

A factor can be provided to scale the total flow (e.g. for calculating operational costs). API Reference

Attributes

Example

coming soon...

{

}

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

Example

coming soon...

{

}

General Description

For each scenario, record the total flow in each year across a list of nodes. Output from data property has shape: (years, scenario combinations).

A list of factors can be provided to scale the total flow (e.g. for calculating operational costs). API Reference

Attributes

Example

coming soon...

{

}

General Description

Record the number of times an index parameter exceeds a threshold for each scenario.

This recorder will count the number of timesteps so will be a daily count when running on a daily timestep.

Attributes

Example

coming soon...

General Description

For each scenario, count the number of times a list of parameters exceeds a threshold in each year. If multiple parameters exceed in one timestep then it is only counted once.

Output from data property has shape: (years, scenario combinations).

Attributes

Example

coming soon...

General Description

Record the minimum volume in a Storage node during a simulation.

Attributes

Example

coming soon...

General Description

Record the mean flow for a Node.

A factor can be provided to scale the total flow (e.g. for calculating operational costs). API Reference

Attributes

Example

coming soon...

{

}

General Description

Records the mean value of a Parameter for the last N timesteps. API Reference

Attributes

Example

coming soon...

{

}

General Description

Record whether a Storage node falls below a particular volume threshold during a simulation.

This recorder will return a value of 1.0 for scenarios where the volume Storage is less than or equal to the threshold at any time-step during the simulation. Otherwise it will return zero. API Reference

Attributes

Example

coming soon...

{

}