Metriplane

Understand what went wrong in a recorded workcell run—and turn it into a repeatable test.

Give Metriplane timestamped object positions and process rules. It creates an incident timeline, a human-readable report, a verified evidence bundle, and a regression check you can run again.

In the bundled example, a required torque driver is missing and an assembly step is delayed by 35.0 seconds. The generated check lets an engineer rerun that same case after the software or process rules change. Metriplane analyzes recordings; it does not control machinery or make safety or quality decisions.

Quickstart

python -m pip install "metriplane==0.3.0"
metriplane demo --open

The example is camera-free, GPU-free, Docker-free, ROS-free, and offline after installation. It writes an HTML report and requests that the browser open it. Headless users can omit --open.

Metriplane bundled demo

Scenario:
A required torque driver is missing during an assembly step.
The fastening step is delayed by 35.0 seconds.

Result:
PASS  Incident timeline: 6 events
PASS  Incident report: 1 incident
PASS  Evidence bundle: verified
PASS  Repeatable regression check: passed
Browser: open request sent
If no browser opens, use the Report path above.
Demo complete.

Input and output

Input
  Timestamped object positions + process rules

Metriplane
  Replays the recorded run and checks what happened

Output
  Incident timeline
  Incident report
  Verified evidence bundle
  Repeatable regression check

Use Metriplane to:

• explain a recorded workcell delay, such as a required tool going missing;
• preserve an incident as a checksummed bundle that another engineer can verify;
• rerun that incident as a regression check after software or process-rule changes.

Terms in plain language

• Recorded run: timestamped observations saved from a workcell session.
• Event: one detected change or process condition in that run.
• Incident: related events grouped into one problem worth reviewing.
• Evidence bundle: the incident files plus checks that reveal missing or changed contents.
• Regression check: a repeatable test generated from an incident and rerun after a change.
• Process rules: the expected tools, locations, steps, and timing for the work.
• Deterministic replay: replay that gives the same software result from the same validated input; it does not prove that the original physical measurements were accurate.

Published versions

• Current installable software release: v0.3.0
• Frozen DOI-archived research artifact: v0.2.0
• TIM evaluated software boundary: v0.1.3

Official links

• Official site: https://www.metriplane.com/
• Python package: https://pypi.org/project/metriplane/
• Product roadmap: ROADMAP.md
• 3-minute v0.2.0 demo: https://www.youtube.com/watch?v=7U5nbBbGGbw
• v0.2.0 release: https://github.com/Miko997/metriplane/releases/tag/v0.2.0
• Zenodo DOI: https://doi.org/10.5281/zenodo.20736619
• SSRN manuscript preprint: https://doi.org/10.2139/ssrn.7166858
• External reproduction issue: https://github.com/Miko997/metriplane/issues/6
• Short feedback form: https://docs.google.com/forms/d/e/1FAIpQLSfnMZ4b3fSVVtwA89hZt3A09gf85eLfhW00FDD76TGRLNpirQ/viewform

Why this exists

Robotics teams often need more than raw logs after an incident. Metriplane explores a structured evidence layer where replayed workcell state becomes an inspectable incident bundle, a verification target, and a generated regression check.

Evidence Workflow

replayed workcell state
→ physical event
→ incident
→ Cell Truth Report
→ evidence bundle
→ bundle verification
→ generated regression check

Archived v0.2.0 Evidence Result

The author-run evidence package included in the archived release records:

• 580 tests passed
• deterministic replay pass=true
• 6 physical events
• 1 incident
• 35.0 second missing-tool delay
• bundle verify: pass=true
• generated regression check: PASS

Quick Reproduction Path

The core SoftwareX reproduction is camera-free, uses the exact v0.2.0 tag, and writes rerun outputs to temporary directories rather than the archived evidence package.

git clone --branch v0.2.0 --depth 1 https://github.com/Miko997/metriplane.git
cd metriplane

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .

python -m metriplane.cli doctor

RUNS=/tmp/metriplane-softwarex-runs \
  ./tools/mp.sh deterministic-replay datasets/demo/session_001.jsonl

metriplane atlas validate-pack configs/domain_packs/assembly_cell
metriplane atlas run \
  --session-jsonl datasets/demo/atlas/assembly_cell_missing_tool.jsonl \
  --pack configs/domain_packs/assembly_cell \
  --out /tmp/metriplane-softwarex-atlas \
  --overwrite

metriplane atlas bundle verify \
  /tmp/metriplane-softwarex-atlas/evidence_bundles/INC-0001.zip

metriplane atlas test \
  /tmp/metriplane-softwarex-atlas/regression_tests/INC-0001.yaml \
  --json

The full maintainer gate is separate from the core artifact path and adds test and browser dependencies:

python -m pip install -e .
python -m pip install pytest playwright
python -m playwright install chromium --with-deps
PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 python -m pytest -q

What Metriplane Is

• observe-only
• local-first
• replay-first, camera-compatible
• bounded workcell scoped
• research-software oriented
• focused on evidence, not robot control

What Metriplane Does Not Claim

• no robot or machine control
• no safety certification
• no quality-release approval
• no people recognition
• no marker-free tracking claim
• no full 3D reconstruction claim
• no production-factory deployment validation
• no factory-wide deployment readiness

Relationship to ROS Bags and Logs

Robotics teams often debug incidents using recorded sensor data, ROS bags, logs, traces, and simulation replays. Those artifacts are valuable raw evidence. Metriplane is not a replacement for ROS bags or logs. It explores the next structured layer: incident context, evidence bundle, verification result, and generated regression check.

External Feedback

External technical feedback and public discussion links are collected on the official site:

https://www.metriplane.com/feedback/

Citation / DOI

If you use or evaluate Metriplane v0.2.0, cite the archived release:

https://doi.org/10.5281/zenodo.20736619

Reproducibility and Archived Release

The SoftwareX manuscript evaluates the archived Metriplane v0.2.0 release. Reproduction commands, expected outputs, and evidence provenance are documented in docs/softwarex_reproducibility.md.

Repository Orientation

The public Python package and command-line entry points remain named metriplane.

Canonical SoftwareX Commands

Use the Quick Reproduction Path above for the camera-free core artifact. The same commands, expected outputs, evidence provenance, and the separate maintainer-gate sequence are maintained in docs/softwarex_reproducibility.md and the review kit.

Documentation

• First-time-user front door: docs/README.md
• Supported environments: docs/SUPPORTED_ENVIRONMENTS.md
• Development and contribution: docs/development.md and CONTRIBUTING.md
• Technical integration reference: docs/INTEGRATIONS.md
• Exact-version research reproduction: docs/softwarex_reproducibility.md

License

MIT License. See LICENSE.