armi.cli.reportsEntryPoint module

class armi.cli.reportsEntryPoint.ReportsEntryPoint

Bases: armi.cli.entryPoint.EntryPoint

Create report from database files.

name: Optional[str] = 'report'

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

settingsArgument: Optional[str] = 'optional'

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.

description: Optional[str] = 'Convert ARMI databases into a report'

A string summarizing the command’s actions. This is summary that is printed when you run python -m armi –list-commands or python -m armi <command-name> –help. If not provided, the docstring of the decorated class will be used instead. In general, the docstring is probably sufficient but this argument allows you to provide a short description of the command while retaining a long and detailed docstring.

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

armi.cli.reportsEntryPoint.createReportFromSettings(cs)

Create BEGINNING reports, given a settings file.

This will construct a reactor from the given settings and create BOL reports for that reactor/settings.