armi.cli.run module

Run an ARMI case.

class armi.cli.run.RunEntryPoint

Bases: EntryPoint

Run an ARMI case.

name: Optional[str] = 'run'

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()