armi.cli package

This package provides various operations users can ask ARMI to do with their inputs.

An Entry Point might run a simulation, migrate inputs, build a suite of related inputs and submit them in a parameter sweep, validate inputs, open the GUI, run a test suite, or other similar things. There are built-in entry points, and additional ones may be specified by custom plugins.

The full docs for entry points are here.

See also

armi.cases

Individual collections of tasks that may run one or more entry points. These allow one entry point to create a sequence of events that may call one or more additional entry points. For example, the submitSuite entry point builds a case suite with many related cases that will all call the run entry point from a HPC cluster.

armi.operators

Operations that ARMI will perform on a reactor model. These may be created by Case objects created by certain entry points (e.g. run).

armi

Fundamental entry point that calls this package.

class armi.cli.EntryPointsPlugin

Bases: ArmiPlugin

static defineEntryPoints()

class armi.cli.ArmiParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

Bases: ArgumentParser

Subclass of default ArgumentParser to better handle application splash text.

print_help(file=None)

class armi.cli.ArmiCLI

Bases: object

ARMI CLI – The main entry point into ARMI. There are various commands available. To get help for the individual commands, run again with <command> –help. Typically, the CLI implements functions that already exist within ARMI.

static showVersion()

Print the App name and version on the command line.

listCommands()

List commands with a short description.

run() → Optional[int]

executeCommand(command, args) → Optional[int]

Execute command with arguments args, return optional exit code.

armi.cli.splash()

Emit a the active App’s splash text to the runLog for the primary node.

Subpackages

• armi.cli.tests package
  • Submodules
    • armi.cli.tests.test_runEntryPoint module
      • TestInitializationEntryPoints
      • TestCheckInputEntryPoint
      • TestCloneArmiRunCommandBatch
      • TestCloneSuiteCommand
      • TestCompareCases
      • TestCompareSuites
      • TestConvertDB
      • TestExpandBlueprints
      • TestExtractInputs
      • TestInjectInputs
      • TestMigrateInputs
      • TestModifyCaseSettingsCommand
      • TestReportsEntryPoint
      • TestCompareIsotxsLibsEntryPoint
      • TestRunEntryPoint
      • TestRunSuiteCommand
      • TestVisFileEntryPointCommand
    • armi.cli.tests.test_runSuite module
      • TestRunSuiteSuite

Submodules

• armi.cli.checkInputs module
  • ExpandBlueprints
    • ExpandBlueprints.name
    • ExpandBlueprints.splash
    • ExpandBlueprints.addOptions()
    • ExpandBlueprints.invoke()
    • ExpandBlueprints.settingsArgument
  • CheckInputEntryPoint
    • CheckInputEntryPoint.name
    • CheckInputEntryPoint.addOptions()
    • CheckInputEntryPoint.invoke()
    • CheckInputEntryPoint.settingsArgument
• armi.cli.cleanTemps module
  • CleanTemps
    • CleanTemps.name
    • CleanTemps.invoke()
    • CleanTemps.settingsArgument
• armi.cli.clone module
  • CloneArmiRunCommandBatch
    • CloneArmiRunCommandBatch.name
    • CloneArmiRunCommandBatch.settingsArgument
    • CloneArmiRunCommandBatch.addOptions()
    • CloneArmiRunCommandBatch.invoke()
  • CloneArmiRunCommandInteractive
    • CloneArmiRunCommandInteractive.name
    • CloneArmiRunCommandInteractive.settingsArgument
  • CloneSuiteCommand
    • CloneSuiteCommand.name
    • CloneSuiteCommand.addOptions()
    • CloneSuiteCommand.invoke()
    • CloneSuiteCommand.settingsArgument
• armi.cli.compareCases module
  • CompareCases
    • CompareCases.name
    • CompareCases.addOptions()
    • CompareCases.parse()
    • CompareCases.invoke()
    • CompareCases.settingsArgument
  • CompareSuites
    • CompareSuites.name
    • CompareSuites.addOptions()
    • CompareSuites.invoke()
    • CompareSuites.settingsArgument
• armi.cli.database module
  • ConvertDB
    • ConvertDB.name
    • ConvertDB.mode
    • ConvertDB.addOptions()
    • ConvertDB.parse_args()
    • ConvertDB.invoke()
    • ConvertDB.settingsArgument
  • ExtractInputs
    • ExtractInputs.name
    • ExtractInputs.mode
    • ExtractInputs.addOptions()
    • ExtractInputs.parse_args()
    • ExtractInputs.invoke()
    • ExtractInputs.settingsArgument
  • InjectInputs
    • InjectInputs.name
    • InjectInputs.mode
    • InjectInputs.addOptions()
    • InjectInputs.invoke()
    • InjectInputs.settingsArgument
• armi.cli.entryPoint module
  • EntryPoint
    • EntryPoint.name
    • EntryPoint.description
    • EntryPoint.settingsArgument
    • EntryPoint.splash
    • EntryPoint.mode
    • EntryPoint.addOptions()
    • EntryPoint.parse_args()
    • EntryPoint.parse()
    • EntryPoint.invoke()
    • EntryPoint.createOptionFromSetting()
  • storeBool()
  • setSetting()
  • setCaseTitle()
  • loadSettings()
• armi.cli.gridGui module
  • GridGuiEntryPoint
    • GridGuiEntryPoint.name
    • GridGuiEntryPoint.addOptions()
    • GridGuiEntryPoint.invoke()
    • GridGuiEntryPoint.settingsArgument
• armi.cli.migrateInputs module
  • MigrateInputs
    • MigrateInputs.name
    • MigrateInputs.addOptions()
    • MigrateInputs.invoke()
    • MigrateInputs.settingsArgument
• armi.cli.modify module
  • ModifyCaseSettingsCommand
    • ModifyCaseSettingsCommand.name
    • ModifyCaseSettingsCommand.addOptions()
    • ModifyCaseSettingsCommand.invoke()
    • ModifyCaseSettingsCommand.settingsArgument
• armi.cli.reportsEntryPoint module
  • ReportsEntryPoint
    • ReportsEntryPoint.name
    • ReportsEntryPoint.settingsArgument
    • ReportsEntryPoint.description
    • ReportsEntryPoint.addOptions()
    • ReportsEntryPoint.invoke()
  • createReportFromSettings()
• armi.cli.run module
  • RunEntryPoint
    • RunEntryPoint.name
    • RunEntryPoint.settingsArgument
    • RunEntryPoint.addOptions()
    • RunEntryPoint.invoke()
• armi.cli.runSuite module
  • RunSuiteCommand
    • RunSuiteCommand.name
    • RunSuiteCommand.addOptions()
    • RunSuiteCommand.invoke()
    • RunSuiteCommand.settingsArgument