armi.cli.checkInputs module

Entry point into ARMI to check inputs of a case or a whole folder of cases.

class armi.cli.checkInputs.ExpandBlueprints

Bases: EntryPoint

Perform expansion of !include directives in a blueprint file.

This is useful for testing inputs that make heavy use of !include directives.

name: Optional[str] = 'expand-bp'

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

splash = False

Whether running the entry point should produce a splash text upon executing.

Setting this to False is useful for utility commands that produce standard output that would be needlessly cluttered by the splash text.

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.

class armi.cli.checkInputs.CheckInputEntryPoint

Bases: EntryPoint

Check ARMI inputs for errors, inconsistencies, and the ability to initialize a reactor. Also has functionality to generate a summary report of the input design. This can be run on multiple cases and creates a table detailing the results of the input check.

name: Optional[str] = 'check-input'

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.