armi.bookkeeping.report.reportInterface module

This interface serves the reporting needs of ARMI. If there is any information that a user desires to show in PDF form to others this is the place to do it.

armi.bookkeeping.report.reportInterface.describeInterfaces(cs)

Function for exposing interface(s) to other code

class armi.bookkeeping.report.reportInterface.ReportInterface(r, cs)

Bases: armi.interfaces.Interface

An interface to manage the use of the report system

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: Optional[str] = 'report'

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

reports = {}

distributable()

Disables distributing of this report by broadcast MPI.

interactBOL()

Called at the Beginning-of-Life of a run, before any cycles start.

interactEveryNode(cycle, node)

Called at each time node/subcycle of every cycle.

interactBOC(cycle=None)

Called at the beginning of each cycle.

interactEOC(cycle=None)

Called at the end of each cycle.

generateDesignReport(generateFullCoreMap, showBlockAxMesh)

interactEOL()

Adds the data to the report, and generates it

printReports()

writeReports()

Renders each report into a document for viewing.

writeRunSummary()

Make a summary of the run