Skip to main content
Version: dev-latest

Pretty Print Mode

Purpose​

  • Pretty print a plex or results from a calibration

Usage​

metrical pretty-print [OPTIONS] <PLEX_OR_RESULTS_PATH>

Concepts​

Pretty Print does what it says on the tin: prints the plex or results of a calibration in a human-readable format. This is useful for debugging and for getting a quick overview of the calibration.

If an origin and secondary component are provided, then Pretty Print will extract the relevant component and constraint data between those two items. Origin will act as the origin for any constraints. This is useful for a gut-check of a calibration parameter or two.

If you need to reformat a plex into something more convenient for your application, use Shape mode instead.

Examples​

Pretty print a plex​

metrical pretty-print $PLEX

Pretty print the results of a calibration​

metrical calibrate -o $RESULTS $DATA $INIT_PLEX $OBJ
metrical pretty-print $RESULTS

Pretty print the constraints between two components​

metrical pretty-print -a ir_one -b ir_two $PLEX

Arguments​

[PLEX_OR_RESULTS_PATH]​

The path to the input plex. This can be a MetriCal results JSON or a plex JSON.

Options​

Universal Options​

As with every mode, all universal options are supported (though not all may be used).

-a, --origin [ORIGIN]​

The origin component, if provided. Must have a secondary component option as well.

-b, --secondary [SECONDARY]​

The secondary component, if provided. Must have an origin component option as well.