armi.cli.reportsEntryPoint module

class armi.cli.reportsEntryPoint.ReportsEntryPoint

Bases: EntryPoint

Placeholder for an ARMI reports entry point.

Subclass this if you want to parse the ARMI DB or Reactor data model to build your reports.

name: str | None = 'report'

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

settingsArgument: str | None = '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.

invoke()