armi.cli.checkInputs module

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

class armi.cli.checkInputs.CheckInputEntryPoint[source]

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()[source]

Hook method for adding additional command line options.

invoke()[source]

Body of the entry point.

This is an abstract method, and must must be overridden in sub-classes.

Returns

  • Implementations should return an exit code, or None, which is interpreted the

  • same as zero (successful completion).