perun.api.cli

Command line API.

Attributes

Functions

cli() → None

Command line entrypoint.

showconf(args) → None

Print current perun configuration in INI format.

sensors(args) → None

Print available sensors.

metadata(args) → None

Print global metadata dictionaries in json format.

export(args) → None

Export existing perun output file to another format.

monitor(args) → None

Gather power consumption from hardware devices while SCRIPT [SCRIPT_ARGS] is running.

Module Contents

perun.api.cli.log[source]
perun.api.cli.CLEARABLE_OPTIONS
perun.api.cli.cli() → None[source]

Command line entrypoint.

Return type:

None

perun.api.cli.showconf(args: argparse.Namespace) → None[source]

Print current perun configuration in INI format.

Parameters:

args (argparse.Namespace)

Return type:

None

perun.api.cli.sensors(args: argparse.Namespace) → None[source]

Print available sensors.

Parameters:

args (argparse.Namespace)

Return type:

None

perun.api.cli.metadata(args: argparse.Namespace) → None[source]

Print global metadata dictionaries in json format.

Parameters:

args (argparse.Namespace)

Return type:

None

perun.api.cli.export(args: argparse.Namespace) → None[source]

Export existing perun output file to another format.

Parameters:

args (argparse.Namespace)

Return type:

None

perun.api.cli.monitor(args: argparse.Namespace) → None[source]

Gather power consumption from hardware devices while SCRIPT [SCRIPT_ARGS] is running.

SCRIPT is a path to the python script to monitor, run with arguments SCRIPT_ARGS.

Parameters:

args (argparse.Namespace)

Return type:

None