> For the complete documentation index, see [llms.txt](https://water-strategy.gitbook.io/waterstrategy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://water-strategy.gitbook.io/waterstrategy/modeling-basics/recorders/base-recorder/parameter-recorder.md).

# Parameter Recorder

## General Description

Base class for recorders that track *Parameter* values. [API Reference](https://pywr.github.io/pywr-docs/master/api/generated/pywr.recorders.ParameterRecorder.html)

## Attributes

<table><thead><tr><th width="158">Name</th><th width="487">Description</th><th>Required</th></tr></thead><tbody><tr><td>model</td><td>pywr.core.Model</td><td>Yes</td></tr><tr><td>param</td><td>The parameter to record</td><td>Yes</td></tr><tr><td>agg_func</td><td>Scenario aggregation function to use when <em>aggregated_value</em> is called</td><td>Yes</td></tr><tr><td>name</td><td>Name of the recorder</td><td>Yes</td></tr><tr><td>comment</td><td>Comment or description of the recorder</td><td>Yes</td></tr><tr><td>ignore_nan</td><td>Flag to ignore NaN values when calling <em>aggregated_value</em></td><td>Yes</td></tr><tr><td>is_objective</td><td>Flag to denote the direction, if any, of optimisation undertaken with this recorder</td><td>Yes</td></tr><tr><td>epsilon</td><td>Epsilon distance used by some optimisation algorithms</td><td>Yes</td></tr><tr><td>constraint_lower_bounds, constraint_upper_bounds</td><td><p>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 <em>None</em> (the default) to disable the respective bound. If both bounds are <em>None</em> then the <em>is_constraint</em> property will return <em>False</em>. 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.</p><p>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.</p></td><td>Yes</td></tr></tbody></table>

## Example

coming soon...

```json
{

}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.