armi.cli.database module

Entry point into ARMI for manipulating output databases.

class armi.cli.database.ConvertDB

Bases: EntryPoint

Convert databases between different versions.

name: Optional[str] = 'convert-db'

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

mode: Optional[int] = 1

One of {armi.Mode.BATCH, armi.Mode.INTERACTIVE, armi.Mode.GUI}, optional. Specifies the ARMI mode in which the command is run. Default is armi.Mode.BATCH.

addOptions()

parse_args(args)

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.

class armi.cli.database.ExtractInputs

Bases: EntryPoint

Recover input files from a database file.

This can come in handy when input files need to be hand-migrated to facilitate loading or migration of the database file itself, or when attempting to re-run a slightly-modified version of a case.

name: Optional[str] = 'extract-inputs'

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

mode: Optional[int] = 1

One of {armi.Mode.BATCH, armi.Mode.INTERACTIVE, armi.Mode.GUI}, optional. Specifies the ARMI mode in which the command is run. Default is armi.Mode.BATCH.

addOptions()

parse_args(args)

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.

class armi.cli.database.InjectInputs

Bases: EntryPoint

Insert new inputs into a database file, overwriting any existing inputs.

This is useful for performing hand migrations of inputs to facilitate database migrations.

name: Optional[str] = 'inject-inputs'

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

mode: Optional[int] = 1

One of {armi.Mode.BATCH, armi.Mode.INTERACTIVE, armi.Mode.GUI}, optional. Specifies the ARMI mode in which the command is run. Default is armi.Mode.BATCH.

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.