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: Interface

An interface to manage the use of the report system.

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()

interactEveryNode(cycle, node)

interactBOC(cycle=None)

interactEOC(cycle=None)

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.