# 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](https://pywr.github.io/pywr-docs/master/api/generated/pywr.recorders.TotalParameterRecorder.html)

## Attributes

<table><thead><tr><th width="155">Name</th><th width="395">Description</th><th>Required</th></tr></thead><tbody><tr><td>model</td><td>pywr.core.Model</td><td>Optional</td></tr><tr><td>param</td><td>The parameter to record</td><td>Required</td></tr><tr><td>name</td><td>The name of the recorder</td><td>Optional</td></tr><tr><td>factor</td><td>Scaling factor for the values of <em>param</em></td><td>Optional</td></tr><tr><td>integrate</td><td>Whether to multiply by the time-step length in days during summation</td><td>Optional</td></tr></tbody></table>

## Example

coming soon...

```json
{

}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://water-strategy.gitbook.io/waterstrategy/modeling-basics/recorders/statistical-recorders/total-parameter-recorder.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.