armi.physics.neutronics.diffIsotxs module¶
This script is used to compare ISOTXS files.
- class armi.physics.neutronics.diffIsotxs.CompareIsotxsLibraries[source]¶
Bases:
armi.cli.entryPoint.EntryPoint
Compare two ISOTXS files
- name: Optional[str] = 'diff-isotxs'¶
The <command-name> that is used to call the command from the command line
- addOptions()[source]¶
Add additional command line options.
Values of options added to
self.parser
will be available onself.args
. Values added withcreateOptionFromSetting
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()[source]¶
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: 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.