> 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/hydro-power-recorders/total-hydro-energy-recorder.md).

# Total Hydro Energy Recorder

## General Description

Calculates the total energy production using the hydropower equation from a model run.

This recorder saves the total energy production in each scenario during a model run. It does not save a timeseries or power, but rather total energy. [API Reference](https://pywr.github.io/pywr-docs/master/api/generated/pywr.recorders.TotalHydroEnergyRecorder.html)

## Attributes

<table><thead><tr><th width="175">Name</th><th width="395">Description</th><th>Required</th></tr></thead><tbody><tr><td>water_elevation_parameter</td><td>Elevation of water entering the turbine. The difference of this value with the <em>turbine_elevation</em> gives the working head of the turbine</td><td>Required</td></tr><tr><td>turbine_elevation</td><td>Elevation of the turbine itself. The difference between the <em>water_elevation</em> and this value gives the working head of the turbine</td><td>Required</td></tr><tr><td>efficiency</td><td>The efficiency of the turbine</td><td>Optional</td></tr><tr><td>density</td><td>The density of water</td><td>Optional</td></tr><tr><td>flow_unit_conversion</td><td>A factor used to transform the units of flow to be compatible with the equation here. This should convert flow to units of <span class="math">m3/day</span></td><td>Optional</td></tr><tr><td>energy_unit_conversion</td><td>A factor used to transform the units of total energy. Defaults to 1e-6 to return <span class="math">MJ</span></td><td>Optional</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/hydro-power-recorders/total-hydro-energy-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.