armi.bookkeeping.visualization.entryPoint module

Entry point for producing visualization files.

class armi.bookkeeping.visualization.entryPoint.VisFileEntryPoint

Bases: EntryPoint

Create visualization files from database files.

name: Optional[str] = 'vis-file'

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

description: Optional[str] = 'Convert ARMI databases in to visualization files'

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()

parse(args)

Process user input.

Strings are parsed against some regular expressions and saved back to their original locations in the self.args namespace for later use.

invoke()

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.