MiravoConcepts
The vocabulary behind Miravo template bundles: assets, models, generators, lifecycle, faults, and protocol output.
Technical details
Template bundle folders
A template bundle is a folder you can run. It holds one root .miravo.yaml template and, optionally, sibling .asset.yaml files that override the shared built-in models.
An asset model defines one asset type in an .asset.yaml file. A template composes assets, topology, namespace, and runtime settings in a .miravo.yaml file.
From files to protocols
Miravo compiles the entry file, the sibling model overrides, and the shared built-in models into runtime assets. The runtime evaluates them on each tick. The same graph feeds every enabled adapter.
Discovery and resolution
Miravo looks for a template bundle in this order: the current working directory, your personal template bundles, your namespaced personal template bundles, then the built-in templates.
A model reference resolves to a sibling .asset.yaml first, then to the shared built-in model. Add a sibling file only when the bundle needs to override a shared model.
Terms
| Term | Meaning | More |
|---|---|---|
| Factory | One running simulation: its assets, engine, protocol adapters, and saved state. | Architecture |
| Template | A .miravo.yaml file that composes models into areas, lines, and assets, plus namespace and protocol settings. You run one with miravo start -t. | Templates |
| Template bundle | The folder that holds one template and any sibling .asset.yaml overrides. | Build your own template |
| Asset model | A type definition in an .asset.yaml file: members, generators, lifecycle, and faults. Also called a model. | Asset models |
| Asset | One instance of a model in a running factory, such as pump-001. | Asset models |
| Station | An asset that takes part in a production line's serial flow. | Production lines |
| Catalog | The read-only library of built-in templates and models. You can list it, launch from it, or copy from it. | CLI reference |
| Generator | The value source or transform behind one member. | Generators |
| Lifecycle | Long-term wear on an asset, defined by the model author. | Lifecycle and faults |
| Fault | A named failure mode with a trigger and effects. | Lifecycle and faults |
| Asset graph | The runtime source of truth for values, lifecycle, and faults. | Architecture |
A template is the plan, a factory is the running result, and assets are its parts. Models are what assets are made from.
Related pages
Asset models
Asset type schema.
Templates
Template topology schema.
Build your own template
Local template bundle folders.
Architecture
Runtime flow and contracts.
Was this page useful?
Last updated on