# dynamics labx.gantry

Describes the entry `labx.gantry` at version `0.1.0`, registered by `mime_lab_fixture.Gantry`.

## At a glance

- dynamics `labx.gantry`, version `0.1.0`, namespace `labx`
- Nodes: [`GantryNode`](../../nodes/GantryNode.md)
- Undocumented, so with no equations to link: [`GantryNode`](../../nodes/GantryNode.md)
- Derivative: `exact`
- Validity: none declared

## What it models, and when not to use it

No hand-written part: this entry's source has not been written (the docs walk counts it).

## Settings

| Setting | Type | Default | Dimension | Role | Default's kind |
|---|---|---|---|---|---|
| `at` | `Annotated[Quantity \| None, Length]` | `null` | length (m) | physical | convention |
| `mount` | `str \| None` | `null` | none | physical | none |
| `orientation` | `tuple[float, float, float, float] \| None` | `null` | none | physical | convention |
| `rate` | `Quantity \| None` | `null` | none | numerical | convention |
| `travel` | `tuple[float, float, float]` | `[1.0, 0.0, 0.0]` | none | physical | convention |

Each role and default's kind is the entry's `setting_roles` (`mime.registry.SettingRole`); a setting that declares none is required.

Each default is a claim (`mime.registry.DefaultKind`): a determined default is resolved in every profile, a convention taken in every profile, a numerical default taken in exploratory only and stamped pending. Their rules and bases:

- `at` (convention): the setting's written default; a segment sits at the origin of the frame it is placed in unless offset
- `orientation` (convention): the setting's written default; a segment is not turned from the frame it is placed in unless turned
- `rate` (convention): the setting's written default; a node steps every base step unless the experiment chooses a slower rate
- `travel` (convention): the setting's written default; the carriage slides along its base frame's +x unless given another direction

## Roles, reads and deliveries

Publishes:

| Interface | Output |
|---|---|
| [`apparatus.frame_poses`](../../vocabulary.md#namespace-mime) | `frame_poses` |

## Nodes it builds

- [`GantryNode`](../../nodes/GantryNode.md)

Declared in `builds`; the node walk compares it with what a round-trip case builds.

## Gradient status

The derivative through this entry is `exact`, the derivative of what it computes.

## Validity

none declared

## References

none declared

## Other declarations

| Class variable | Type | Value |
|---|---|---|
| `accepts` | `ClassVar[Mapping[str, Port]]` | `{}` |
| `applies_to` | `ClassVar[frozenset[ThingKind]]` | `["apparatus"]` |
| `flags` | `ClassVar[frozenset[Capability]]` | `["rigid"]` |
| `initial_state` | `ClassVar[Mapping[str, Dimension]]` | `{}` |
| `limits` | `ClassVar[tuple[str, ...]]` | `[]` |
| `moving` | `ClassVar[bool]` | `false` |
| `nodes` | `ClassVar[tuple[str, ...]]` | `[""]` |
| `registration_kinds` | `ClassVar[frozenset[str]]` | `[]` |