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.

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[source]

Bases: armi.plugins.ArmiPlugin

static defineEntryPoints()[source]

Return new entry points for the ARMI CLI

This hook allows plugins to provide their own ARMI entry points, which each serve as a command in the command-line interface.

Returns

class objects which derive from the base EntryPoint class.

Return type

list

class armi.cli.ArmiCLI[source]

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. Generically, the CLI implements functions that already exists within ARMI

listCommands()[source]

List commands with a short description.

run() → Optional[int][source]
executeCommand(command, args) → Optional[int][source]

execute command with arguments args, return optional exit code.