armi.bookkeeping.report.reportingUtils module

A collection of miscellaneous functions used by ReportInterface to generate various reports.

armi.bookkeeping.report.reportingUtils.writeWelcomeHeaders(o, cs)[source]

Write welcome information using the Operator and the Case Settings.

armi.bookkeeping.report.reportingUtils.getNodeName()[source]

Get the name of this compute node.

First, look in context.py. Then try various Linux tools. Then try Windows commands.

Returns:

Compute node name.

Return type:

str

armi.bookkeeping.report.reportingUtils.getSystemInfo()[source]

Get system information, assuming the system is Windows or Linux.

Notes

The format of the system information will be different on Windows vs Linux.

Returns:

Basic system information: OS name, OS version, basic processor information

Return type:

str

armi.bookkeeping.report.reportingUtils.getInterfaceStackSummary(o)[source]
armi.bookkeeping.report.reportingUtils.writeTightCouplingConvergenceSummary(convergenceSummary)[source]
armi.bookkeeping.report.reportingUtils.writeAssemblyMassSummary(r)[source]

Print out things like Assembly weights to the runLog.

Parameters:

r (armi.reactor.reactors.Reactor) –

armi.bookkeeping.report.reportingUtils.writeCycleSummary(core)[source]

Prints a cycle summary to the runLog.

Parameters:
armi.bookkeeping.report.reportingUtils.setNeutronBalancesReport(core)[source]

Determines the various neutron balances over the full core.

Parameters:

core (armi.reactor.reactors.Core) –

armi.bookkeeping.report.reportingUtils.summarizePinDesign(core)[source]

Prints out some information about the pin assembly/duct design.

Handles multiple types of dimensions simplistically by taking the average.

Parameters:

core (armi.reactor.reactors.Core) –

armi.bookkeeping.report.reportingUtils.summarizePowerPeaking(core)[source]

Prints reactor Fz, Fxy, Fq.

Parameters:

core (armi.reactor.reactors.Core) –

armi.bookkeeping.report.reportingUtils.summarizePower(core)[source]

Provide an edit showing where the power is based on assembly types.

Parameters:

core (armi.reactor.reactors.Core) –

armi.bookkeeping.report.reportingUtils.makeCoreDesignReport(core, cs)[source]

Builds report to summarize core design inputs.

Parameters:
armi.bookkeeping.report.reportingUtils.makeBlockDesignReport(r)[source]

Summarize the block designs from the loading file.

Parameters:

r (armi.reactor.reactors.Reactor) –

armi.bookkeeping.report.reportingUtils.makeCoreAndAssemblyMaps(r, cs, generateFullCoreMap=False, showBlockAxMesh=True)[source]

Create core and assembly design plots.

Parameters: