MetriCal Commands

MetriCal is a powerful program with many different tools to help you calibrate your system. Each one is designed for a specific purpose, and can be used in conjunction with other commands to achieve your desired calibration results.

Manifest or CLI?

MetriCal commands can be run either through a manifest file (see the New and Run commands) or directly via the command line interface. The manifest file is a TOML file that contains all the necessary information to run a standard calibration workflow, while the CLI allows you to run commands one-by-one directly from the terminal.

Though there's no "right" way to use MetriCal, we recommend using the manifest file for most users, as it allows for easier reproducibility and version control while also double-checking dependencies and I/O logic. The CLI is best suited for debugging and rapid testing; in fact, there are commands specifically designed for debugging purposes that are not available for use in the manifest file.

Global Arguments

Global Arguments

Overview of global arguments available in MetriCal commands.

View Details →

MetriCal Manifest

Manifest Overview

What a manifest is and how it is used in MetriCal.

View Guide →

Command: New

Create a new MetriCal manifest with default configuration.

View Command →

Command: Run

Run a MetriCal manifest. Execute an entire calibration workflow.

View Command →

Command: Validate

Validate a MetriCal manifest for correctness and completeness.

View Command →

Calibration And Processing

Command: Init

Profile a dataset for calibration. Create or modify a Plex based on this data.

View Command →

Command: Calibrate

Calibrate a sensor system given an initial plex and object space configuration.

View Command →

The Shape Commands

Modify a plex into any number of different helpful output formats.

View Command →

Command: Consolidate

Consolidate compatible targets into a single object space.

View Command →

CLI Utilities

Command: Report

Generate the report from the results of a calibration.

View Command →

Command: Display

Render a dataset. Apply the calibrated plex and render the fused data.

View Command →

Command: Completion

Generate autocomplete files for common shell variants.

View Command →

Errors and Troubleshooting

Errors and Troubleshooting

Common errors, and how to address them.

View Command →