armi.context module

Module containing global constants that reflect the executing context of ARMI.

This contains information about the circumstatces under which an ARMI application is running. Things like the MPI environment, executing user, etc. live here. These are re-exported by the armi package, but live here so that import loops won’t lead to as many issues.

class armi.context.Mode

Bases: object

Mode represents different run modes possible in ARMI.

The modes can be Batch, Interactive, or GUI. In different modes, there are different types of interactions possible.

Mode is generally auto-detected based on your terminal. It can also be set in various CLI entry points, which are the implementations of armi.cli.entryPoint.EntryPoint. Lastly, each entry point has a --batch command line argument that can force Batch mode.

Batch = 1

Interactive = 2

Gui = 4

classmethod setMode(mode)

Set the run mode of the current ARMI case.