> ## Documentation Index
> Fetch the complete documentation index at: https://docs.models.dunsky.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HEAT

> Dunsky documentation for HEAT: find model guidance, source references, and the right tools for your work.

HEAT calculates performance, energy consumption, costs, adoption, and load impacts of heating electrification and decarbonization technologies. Use HEAT for heating electrification and decarbonization analysis. The model is maintained under `packages/heat`. The platform runner includes Heat Potential with HVAC or DHW and sector selections.

## Use the model

For browser-based execution, open [models.dunsky.com](https://models.dunsky.com) and follow the [platform run guide](https://docs.models.dunsky.com/quickstart.md).

For local execution, start with the [package README](https://github.com/dunsky-consulting/packages/blob/trunk/heat/README.md). It documents the environment and installation steps; repository access is required.

After installing and configuring the package, its documented entry point is:

```bash theme={null}
heat --help
```

## Model notes

### Time conventions

The README defines model values at year-end and input values at the start of the year, with a shift during energy-user setup. Study years are inclusive. Check these conventions before interpreting installation years, impact years, or capital costs.

### Review evidence

The README identifies unit and end-to-end tests. Review the version-specific tests and reference inputs before concluding that a change preserves outputs.

## Documents and references

Use the following model guides and reference documents.

| Document | Format | Purpose and status |
| - | - | - |
| [HEAT ramp-up](https://dunsky.sharepoint.com/:w:/r/sites/DRModelDevelopment/Shared%20Documents/HEAT/HEAT/Model%20Documentation/Using%20HEAT/HEAT%20ramp%20up.docx?d=wb9a6d8afd53d425db4e9d30f0c780c6f\&csf=1\&web=1\&e=VeLNzQ) | Word | Orientation document referenced by the package README |
| [HEAT - VM User Guide](https://dunsky.atlassian.net/wiki/spaces/Modelling/pages/102498305/HEAT+-+VM+User+Guide) | Confluence | VM-specific instructions; contains outdated cloud-availability statement |

The VM guide says HEAT is not yet available in the cloud application. That statement conflicts with the current runner. Use the guide only for its VM-specific scope and have the operational instructions confirmed.

## Implementation reference

[HEAT source and README](https://github.com/dunsky-consulting/packages/blob/trunk/heat/README.md). Check the source revision applicable to your model version.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.