armi.cli.clone module

class armi.cli.clone.CloneArmiRunCommandBatch

Bases: armi.cli.entryPoint.EntryPoint

Clone existing ARMI settings input, and associated files, to the current directory and modify it according to the supplied settings (on the command line).

name = 'clone-batch'

settingsArgument = 'required'

addOptions()

Add additional command line options.

Values of options added to self.parser will be available on self.args. Values added with createOptionFromSetting will override the setting values in the settings input file.

See also

createOptionFromSetting()

A method often called from here to creat CLI options from application settings.

argparse.ArgumentParser.add_argument()

Often called from here using self.parser.add_argument to add custom argparse arguments.

invoke()

Body of the entry point.

This is an abstract method, and must must be overridden in sub-classes.

Returns

exitcode – Implementations should return an exit code, or None, which is interpreted the same as zero (successful completion).

Return type

int or None

class armi.cli.clone.CloneArmiRunCommandInteractive

Bases: armi.cli.clone.CloneArmiRunCommandBatch

Interactively clone existing ARMI settings input, and associated files, to the current directory and modify it according to the supplied settings (on the command line).

name = 'clone'

settingsArgument = 'required'

class armi.cli.clone.CloneSuiteCommand

Bases: armi.cli.entryPoint.EntryPoint

Clone existing ARMI cases as a new suite.

name = 'clone-suite'

addOptions()

Add additional command line options.

Values of options added to self.parser will be available on self.args. Values added with createOptionFromSetting will override the setting values in the settings input file.

See also

createOptionFromSetting()

A method often called from here to creat CLI options from application settings.

argparse.ArgumentParser.add_argument()

Often called from here using self.parser.add_argument to add custom argparse arguments.

invoke()

Body of the entry point.

This is an abstract method, and must must be overridden in sub-classes.

Returns

exitcode – Implementations should return an exit code, or None, which is interpreted the same as zero (successful completion).

Return type

int or None

settingsArgument = None