Reference¶
The reference pages are generated from Homeostat's own metadata, so they always describe the installed version.
| Page | Contents |
|---|---|
| Scenario schema | Every key of a scenario file, with its type, default and meaning. Also as JSON Schema, for editors and AI assistants. |
| Operators | Every core operator: its equations, ports, direct feedthrough, random numbers per step, and parameters with units and ranges. |
| Process library | Templates with their parameters and ports, sensor presets, faults, degradations and maintenance tasks. |
| Error codes | Every error code, the stage that raises it, and what it means. |
| Python API | The public functions and classes, from their docstrings. |
The same information is available as data:
import homeostat
catalog = homeostat.catalog() # operators, templates, presets, faults, degradations, tasks
For AI assistants, the site also publishes llms.txt: a short guide to writing scenarios, links to these pages and the library's vocabulary.