# The user guide

Tutorials that run, and a few short pages. Every tutorial's code is a file that a test runs, included here and never pasted,
and every block of output is that file's output, regenerated by `mime docs check`. The definitions the tutorials use are in
the concept pages, which this guide links to where you meet each idea and does not repeat.

## Start here

- [Install and environment](install.md): what it needs, checking an environment, fetching assets, the precision rule.
- [Tutorial A](tutorial_a.md): de Jongh's screw in a tube of water, as a reproduction of the earlier line's script A and
  then with records.
- [Tutorial A0](tutorial_a0.md): the same screw driven by a magnet on a robot arm, in a closed loop.
- The tutorial for experiment G waits for a1.
- [Reading a build report](build_report.md): each part of the report, and what to do with it.
- [The command line](cli.md): every command and flag, generated from the parser.
- [Scope and limits](scope.md): what MIME declares and what it does not claim, with the profiles.

## Advanced

- [Extending MIME](lab_author.md): a plugin, a package of a lab's own entries, asset records and storage adapters, and what a
  lab may claim for what it adds.
- [Assets in depth](assets.md): what a record says, where an experiment's records come from, where the bytes may go, and the
  audit for a package's CI.

## The concepts the tutorials use

[The scene](../scene.md) (frames, regions, the stage), [materials](../materials.md) (how a value reaches an entry, declared
against fitted), [the multibody library](../multibody.md) (chains, mounts, armature), [the profiles](../profiles.md),
[reading a run's results](../results.md), and [reading an error](../reading_errors.md).

## Terms

MIME keeps no glossary of its own. The terms the stack shares are in [the stack's glossary](https://microrobotica.org/glossary.html),
and the names a model reads and delivers, with their units and frames, are on [the vocabulary page](../vocabulary.md). The
terms specific to MIME are defined where they are used: the page types in [the concepts note](../concepts.md), and the others
in the concept pages above.