MiravoMiravo

Concepts

Learn the core vocabulary behind Miravo environments: twins, models, generators, lifecycle state, faults, runtime truth, and protocol output.

Technical details

Start from an environment folder

water-loop.miravo.yaml
centrifugal-pump.twin.yaml
storage-tank.twin.yaml

An environment folder is one runnable scenario. It contains one root .miravo.yaml entry file and optional sibling .twin.yaml files that override shared built-in models.

A twin model defines one asset type in .twin.yaml. A template entry composes twin instances, topology, namespace, and runtime settings in .miravo.yaml.

Follow files to runtime

Miravo compiles the entry file, sibling model overrides, and shared built-in models into runtime instances. The runtime evaluates them on each tick. The same graph then feeds every enabled adapter.

Know discovery and resolution

Environment discovery checks the current working directory, personal environments, namespaced personal environments, then built-in starters. Model references resolve sibling first, then shared built-in model. Add a sibling .twin.yaml file only when the environment overrides the shared model.

The core terms

Environment

One runnable scenario folder with an entry file and optional sibling model overrides.

Twin

One modeled asset instance such as pump-001 or compressor-002.

Twin model

Asset type definition stored in one .twin.yaml file.

Template entry

.miravo.yaml composition of twins, topology, namespace, and settings.

Catalog

Read-only built-in starter library that can be listed, launched, or forked.

Generator

Value source or transform for one member.

Lifecycle

Long-horizon wear model on a twin definition.

Fault

Named failure mode with triggers and effects.

Reference

TermMeaningNext page
EnvironmentRunnable folder with one .miravo.yaml entry and optional sibling .twin.yaml overridesCustom content
Twin modelAsset type definition in .twin.yamlTwin models
Template entryTopology and runtime composition in .miravo.yamlTemplates
CatalogBuilt-in starter and shared model libraryCLI reference
GeneratorPer-member value logicGenerators
LifecycleWear progression defined by the model authorLifecycle and faults
FaultNamed runtime failure surfaceLifecycle and faults
Runtime graphSource of truth for values, lifecycle, and faultsArchitecture

Was this page useful?

Last updated on