armi.cli.reportsEntryPoint module

class armi.cli.reportsEntryPoint.ReportsEntryPoint

Bases: armi.cli.entryPoint.EntryPoint

Create report from database files.

name = 'report'

settingsArgument = 'optional'

description = 'Convert ARMI databases into a report'

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.