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: Optional[str] = 'clone-batch'

The <command-name> that is used to call the command from the command line

settingsArgument: Optional[str] = 'required'

One of {‘optional’, ‘required’, None}, or unspecified. Specifies whether a settings file argument is to be added to the command’s argument parser. If settingsArgument == ‘required’, then a settings file is a required positional argument. If settingsArgument == ‘optional’, then it is an optional positional argument. Finally, if settingsArgument is None, then no settings file argument is added.

addOptions()

invoke()

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: Optional[str] = 'clone'

The <command-name> that is used to call the command from the command line

settingsArgument: Optional[str] = 'required'

One of {‘optional’, ‘required’, None}, or unspecified. Specifies whether a settings file argument is to be added to the command’s argument parser. If settingsArgument == ‘required’, then a settings file is a required positional argument. If settingsArgument == ‘optional’, then it is an optional positional argument. Finally, if settingsArgument is None, then no settings file argument is added.

class armi.cli.clone.CloneSuiteCommand

Bases: armi.cli.entryPoint.EntryPoint

Clone existing ARMI cases as a new suite.

name: Optional[str] = 'clone-suite'

The <command-name> that is used to call the command from the command line

addOptions()

invoke()

settingsArgument: Optional[str] = None

One of {‘optional’, ‘required’, None}, or unspecified. Specifies whether a settings file argument is to be added to the command’s argument parser. If settingsArgument == ‘required’, then a settings file is a required positional argument. If settingsArgument == ‘optional’, then it is an optional positional argument. Finally, if settingsArgument is None, then no settings file argument is added.