armi.cli.compareCases module

class armi.cli.compareCases.CompareCases

Bases: armi.cli.entryPoint.EntryPoint

Compare the databases from two ARMI cases.

name: Optional[str] = 'compare'

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

addOptions()

parse(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.compareCases.CompareSuites

Bases: armi.cli.compareCases.CompareCases

Do a case-by-case comparison between two CaseSuites.

name: Optional[str] = 'compare-suites'

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.