armi.cli.checkInputs module

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

armi.cli.checkInputs._runInspectorOnSettings(cs)

class armi.cli.checkInputs.ExpandBlueprints

Bases: armi.cli.entryPoint.EntryPoint

Perform expansion of !include directives in a blueprint file.

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

name = 'expand-bp'

splash = False

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

class armi.cli.checkInputs.CheckInputEntryPoint

Bases: armi.cli.entryPoint.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 = 'check-input'

settingsArgument = 'optional'

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