MIME documentation

Generated from the registry and the vocabulary. To learn MIME by doing, the user guide has a tutorial for each experiment it covers; to add your own entry, the lab-author guide. Start with the concepts if the page types are new to you. After a run, reading its results: each observation’s outputs by name, with units. To go from a first run to a sealed experiment, the profiles: explore, see what is pending, seal. When MIME refuses something, reading an error, and every error by its code. To watch a run as it runs, live sessions and the protocol, and to replay one, recordings. The ideas the entries share: the scene (frames, regions, the stage), materials (how a value reaches an entry, declared against fitted) and the multibody library (chains, mounts, armature).

By goal

What can act on a body?

A body takes deliveries into its targets; the mechanism page of each target kind says how they combine and lists the entries that deliver into it.

Target kind	Entries that deliver into it
load	drag, gravity, labx.nudge, magnetic.force, magnetic.torque, toy.drag, toy.lift, toy.spring, toy.twist
kinematic	none registered
operator	drag
equality constraint	toy.hold
inequality constraint	none registered
registration	none registered

Which model, when there are several?

A family collects the laws that answer one question, with the contract each must satisfy and, once two of its members that can replace one another are built, a comparison. A member is an entry, or one built rung of an entry that has rungs.

Family	Members	Built members
contact	contact	1
gravity	gravity	1
hydrodynamic	drag	2
magnetic	magnetic.force, magnetic.torque	2
toy	toy.drag	2

What do I write?

Every registered entry has a page, listed by kind.

interaction

• contact 0.1.0

• contact 0.4.0

• drag 0.3.0

• drag 0.4.0

• gravity 0.1.0

• labx.nudge 0.1.0

• magnetic.force 0.1.0

• magnetic.torque 0.1.0

• toy.couple 0.1.0

• toy.drag 0.2.0

• toy.hold 0.1.0

• toy.lift 0.1.0

• toy.spring 0.1.0

• toy.twist 0.1.0

dynamics

• arm 0.1.0

• labx.gantry 0.1.0

• motor 0.2.0

• rigid_inertial 0.2.0

• rigid_inertial 0.3.0

• toy.anchored_body 0.1.0

• toy.body 0.1.0

• toy.relaxation 0.1.0

field provider

• point_dipole 0.1.0

• toy.field 0.1.0

• uniform_rotating 0.1.0

geometry

• box 0.1.0

• capsule 0.1.0

• capsule 0.2.0

• cylinder 0.1.0

• ellipsoid 0.1.0

• labx.bead 0.1.0

• screw 0.2.0

• screw 0.3.0

• sphere 0.1.0

• sphere 0.2.0

• tube 0.1.0

observation

• labx.height 0.1.0

• swim_speed 0.1.0

• toy.recorder 0.1.0

• toy.region_probe 0.1.0

drive

• drive.constant 0.1.0

controller

• arm_tracking 0.1.0

wall kind

• free_space 0.1.0

• tube 0.1.0

What does a name mean?

The vocabulary lists every interface name with its units, frame, shape and sign.

What does a node do?

• ConstantNode

• DynamicArmNode

• DynamicMotorNode

• GantryNode

• GravityNode

• HeightNode

• KinematicArmNode

• KinematicMotorNode

• MRSDragNode

• MagneticForceNode

• MagneticTorqueNode

• NudgeNode

• PointDipoleNode

• RigidInertialMidpointNode

• RigidInertialNode

• SourceReactionNode

• SurrogateDragNode

• SwimSpeedNode

• ToyAnchoredBodyNode

• ToyBodyNode

• ToyDragNode

• ToyFieldNode

• ToyHoldNode

• ToyLiftNode

• ToyMediumNode

• ToyRecorderNode

• ToyRegionProbeNode

• ToySpringNode

• UniformRotatingNode

What does a saved folder hold, and what does a load refuse?

The saved form’s specification, with the JSON Schemas of its document and its lock.

What does a mime: name on a stage mean?

The mime: USD schema: each attribute and applied schema MIME writes or reads.

What was a 0.2 name, in 0.3?

The migration table: each public name of the 0.2 line and what takes its place.

Which claims does a test back?

The evidence counts: every claim and specification statement, with its tests’ outcomes.