armi.cli.reportsEntryPoint module

class armi.cli.reportsEntryPoint.ReportsEntryPoint

Bases: EntryPoint

Create a report from a database file.

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.

report_out_dir = 'reportsOutputFiles'

addOptions()

invoke()

static toTwoTuple(strInput)

Convert a string to a two-tuple of integers.

Parameters:

strInput (str) – Representing a simple two-tuple of integers: ‘(1,3)’.

Returns:

A tuple of two integers.

Return type:

tuple

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.

Parameters:

cs (Settings) – A standard ARMI Settings object, to define a run.

Returns:

A string representing the HTML for a web page.

Return type:

str