HEAT documentation
HEAT is a simulation analytics platform. Training simulators and capture tools send recorded data to HEAT. HEAT processes that data through a graph of steps that a developer defines once, then publishes the result as a dashboard. Three kinds of people work with it. Users, meaning instructors and trainees, read the dashboards. Administrators run the platform through the Control Centre. Developers decide how data is processed and what each dashboard shows.
Choose your path
Users: I want to see my sessionsAdministrators: I run a HEAT environmentDevelopers: I build data flows and dashboards
| Audience | Start with |
|---|---|
| Users | Signing in, then Reading a session dashboard |
| Administrators | The Control Centre, then Deployment |
| Developers | Build your first data flow, then Node templates |
How a session becomes a dashboard
Every dashboard in HEAT is the end of the same path.
- A developer creates a session template inside a Project. The template is a graph of named nodes that says how uploaded data is processed.
- Data arrives through an Ingest or the HEAT v2 API. It lands on the template’s input node and creates a Session, which is one run of the template over that batch of data.
- Each node in the template becomes a node instance in the session. A Runner executes the node’s node template and stores the result as a node output.
- A dashboard node publishes a Dimension. The dimension holds the data as channels grouped by Realm, plus a Layout that says how to draw them.
- The HEAT dashboard renders the layout’s widgets at
/sessions/<dimensionId>.
Where things live
| Surface | What it is for | Where |
|---|---|---|
| HEAT dashboard | Reading session dashboards, reports and system dashboards | The dashboard web application for your environment |
| Control Centre | Operating the environment, including users, projects, data sources, sessions and monitoring | /main and /admin on the same host (formerly Cluster Manager) |
| v2 API | Uploading data, creating sessions and reading dashboard data from your own software | /api/v2 on the same host, described in the HEAT v2 API reference |
| HEAT Capture | Recording data from simulators, sensors and wearables and streaming it to HEAT | A Windows application on the capture machine. See HEAT Capture for operators and Capture for developers for its interfaces. |
| This documentation | Concepts, procedures and contracts for all three audiences | You are here |
New to HEAT? Read How HEAT works first, then keep the Glossary open while you work.
Opens your browser's print dialog. Choose "Save as PDF" as the destination.