solprop.calibration.command#

solprop calibrate: measure, show, export, import or forget a profile (SEP 46).

The command line’s parser (solprop.cli) hands this module its arguments. Nothing here loads the native extension.

Functions

add_arguments(parser)

Add solprop calibrate's options to parser.

describe([environ])

Return solprop calibrate --show's text.

run(arguments)

Carry out solprop calibrate.

solprop.calibration.command.add_arguments(parser)[source]#

Add solprop calibrate’s options to parser.

Parameters:
parserargparse.ArgumentParser

The subcommand’s parser.

solprop.calibration.command.describe(environ=None)[source]#

Return solprop calibrate --show’s text.

Parameters:
environMapping[str, str] or None, optional

The environment; the process’s when None.

Returns:
str

The store, the machine, the build, the allocation, and the profile’s settings beside the built-in table’s, or why none applies.

solprop.calibration.command.run(arguments)[source]#

Carry out solprop calibrate.

Parameters:
argumentsargparse.Namespace

The parsed options of add_arguments().

Returns:
int

The exit status: zero on success.

Raises:
CalibrationError

When there is nothing to export, a file cannot be imported, or no action was asked for.