armi.bookkeeping.mainInterface module

This module performs some file manipulations, cleanups, state loads, etc.

It’s a bit of a catch-all interface, and it’s name is admittedly not very descriptive.

armi.bookkeeping.mainInterface.describeInterfaces(_cs)

Function for exposing interface(s) to other code.

class armi.bookkeeping.mainInterface.MainInterface(r, cs)

Bases: Interface

Do some basic manipulations, calls, Instantiates the database.

Notes

Interacts early so that the database is accessible as soon as possible in the run. The database interfaces runs near the end of the interface stack, but the main interface interacts first.

Construct an interface.

The r and cs arguments are required, but may be None, where appropriate for the specific Interface implementation.

Parameters:

• r (Reactor) – A reactor to attach to

• cs (Settings) – Settings object to use

Raises:

RuntimeError – Interfaces derived from Interface must define their name

name: str | None = 'main'

The name of the interface. This is undefined for the base class, and must be overridden by any concrete class that extends this one.

static specifyInputs(cs)

interactBOL()

interactBOC(cycle=None)

Typically the first interface to interact beginning of cycle.

interactEveryNode(cycle, node)

Loads from db if necessary.

interactEOL()

cleanARMIFiles()

Delete temporary ARMI run files like simulation inputs/outputs.

Useful if running a clean job that doesn’t require restarts.

cleanLastCycleFiles()

Delete ARMI files from previous cycle that aren’t necessary for the next cycle. Unless you’re doing reloads, of course.