armi.bookkeeping package

The bookkeeping package handles data persistence, reporting, and some debugging.

class armi.bookkeeping.BookkeepingPlugin

Bases: ArmiPlugin

static exposeInterfaces(cs)

static defineEntryPoints()

static defineCaseDependencies(case, suite)

static mpiActionRequiresReset(cmd) → bool

Prevent reactor resets after certain mpi actions.

• Memory profiling is small enough that we don’t want to reset

• distributing state would be undone by this so we don’t want that.

See also

armi.operators.operatorMPI.OperatorMPI.workerOperate

static onProcessCoreLoading(core, cs, dbLoad)

Called whenever a Core object is newly built.

armi.bookkeeping.summarizeMaterialData(container)

Create a summary of the material objects and source data for a reactor container.

Parameters:

container (Core object) – Any Core object with Blocks and Components defined.

Subpackages

• armi.bookkeeping.db package
  • When updating a db version
  • Database revision changelog
  • loadOperator()
  • Subpackages
    • armi.bookkeeping.db.tests package
      • Submodules
  • Submodules
    • armi.bookkeeping.db.compareDB3 module
      • OutputWriter
      • DiffResults
      • compareDatabases()
    • armi.bookkeeping.db.database module
      • getH5GroupName()
      • Database
      • packSpecialData()
      • unpackSpecialData()
      • collectBlockNumberDensities()
    • armi.bookkeeping.db.databaseInterface module
      • describeInterfaces()
      • DatabaseInterface
    • armi.bookkeeping.db.factory module
      • databaseFactory()
    • armi.bookkeeping.db.jaggedArray module
      • JaggedArray
    • armi.bookkeeping.db.layout module
      • Layout
      • replaceNonesWithNonsense()
      • replaceNonsenseWithNones()
    • armi.bookkeeping.db.passiveDBLoadPlugin module
      • PassThroughYamlize
      • PassiveDBLoadPlugin
    • armi.bookkeeping.db.permissions module
      • Permissions
    • armi.bookkeeping.db.typedefs module
• armi.bookkeeping.report package
  • setData()
  • Subpackages
    • armi.bookkeeping.report.tests package
      • Submodules
  • Submodules
    • armi.bookkeeping.report.data module
      • Report
      • Group
      • Table
      • Image
    • armi.bookkeeping.report.reportInterface module
      • describeInterfaces()
      • ReportInterface
    • armi.bookkeeping.report.reportingUtils module
      • writeWelcomeHeaders()
      • getNodeName()
      • getSystemInfo()
      • getInterfaceStackSummary()
      • writeTightCouplingConvergenceSummary()
      • writeAssemblyMassSummary()
      • writeCycleSummary()
      • setNeutronBalancesReport()
      • summarizePinDesign()
      • summarizePowerPeaking()
      • makeCoreDesignReport()
      • makeBlockDesignReport()
      • makeCoreAndAssemblyMaps()
• armi.bookkeeping.tests package
  • Submodules
    • armi.bookkeeping.tests.test_bookkeepingPlugin module
      • TestBookkeepingPlugin
      • TestBookkeepingPluginHooks
    • armi.bookkeeping.tests.test_historyTracker module
      • TestHistoryTracker
    • armi.bookkeeping.tests.test_memoryProfiler module
      • TestMemoryProfiler
      • KlassCounterTests
    • armi.bookkeeping.tests.test_snapshot module
      • MockReactorParams
      • MockReactor
      • TestSnapshotInterface
• armi.bookkeeping.visualization package
  • Subpackages
    • armi.bookkeeping.visualization.tests package
      • Submodules
  • Submodules
    • armi.bookkeeping.visualization.dumper module
      • VisFileDumper
    • armi.bookkeeping.visualization.entryPoint module
      • VisFileEntryPoint
    • armi.bookkeeping.visualization.utils module
      • VtkMesh
      • createReactorBlockMesh()
      • createReactorAssemMesh()
      • createBlockMesh()
      • createAssemMesh()
    • armi.bookkeeping.visualization.vtk module
      • Limitations
      • VtkDumper
    • armi.bookkeeping.visualization.xdmf module
      • XdmfDumper

Submodules

• armi.bookkeeping.historyTracker module
  • Getting history information
    • Using the database-based history trackers
    • Specifying parameters to add to the EOL history report
    • Specifying blocks and assemblies to track
  • describeInterfaces()
  • HistoryTrackerInterface
    • HistoryTrackerInterface.name
    • HistoryTrackerInterface.DETAILED_ASSEMBLY_FLAGS
    • HistoryTrackerInterface.interactBOL()
    • HistoryTrackerInterface.interactBOC()
    • HistoryTrackerInterface.interactEOL()
    • HistoryTrackerInterface.addDetailAssembliesBOL()
    • HistoryTrackerInterface.addAllDetailedAssems()
    • HistoryTrackerInterface.addDetailAssemsByAssemNums()
    • HistoryTrackerInterface.getTrackedParams()
    • HistoryTrackerInterface.addDetailAssembly()
    • HistoryTrackerInterface.getDetailAssemblies()
    • HistoryTrackerInterface.getDetailBlocks()
    • HistoryTrackerInterface.nonStationaryBlocks()
    • HistoryTrackerInterface.getAssemHistories()
    • HistoryTrackerInterface.writeAssemHistories()
    • HistoryTrackerInterface.preloadBlockHistoryVals()
    • HistoryTrackerInterface.unloadBlockHistoryVals()
    • HistoryTrackerInterface.getBlockHistoryVal()
    • HistoryTrackerInterface.getTimeSteps()
• armi.bookkeeping.mainInterface module
  • describeInterfaces()
  • MainInterface
    • MainInterface.name
    • MainInterface.specifyInputs()
    • MainInterface.interactBOL()
    • MainInterface.interactBOC()
    • MainInterface.interactEveryNode()
    • MainInterface.interactEOL()
    • MainInterface.cleanARMIFiles()
    • MainInterface.cleanLastCycleFiles()
• armi.bookkeeping.memoryProfiler module
  • describeInterfaces()
  • getTotalJobMemory()
  • getCurrentMemoryUsage()
  • MemoryProfiler
    • MemoryProfiler.name
    • MemoryProfiler.interactBOL()
    • MemoryProfiler.interactEveryNode()
    • MemoryProfiler.interactEOL()
    • MemoryProfiler.printCurrentMemoryState()
    • MemoryProfiler.displayMemoryUsage()
    • MemoryProfiler.checkForDuplicateObjectsOnArmiModel()
    • MemoryProfiler.getReferrers()
  • KlassCounter
    • KlassCounter.countObjects()
  • InstanceCounter
    • InstanceCounter.add()
  • ProfileMemoryUsageAction
    • ProfileMemoryUsageAction.invokeHook()
  • SystemAndProcessMemoryUsage
  • PrintSystemMemoryUsageAction
    • PrintSystemMemoryUsageAction.minProcessMemoryInMB
    • PrintSystemMemoryUsageAction.maxProcessMemoryInMB
    • PrintSystemMemoryUsageAction.invokeHook()
    • PrintSystemMemoryUsageAction.printUsage()
• armi.bookkeeping.snapshotInterface module
  • describeInterfaces()
  • SnapshotInterface
    • SnapshotInterface.name
    • SnapshotInterface.interactBOL()
    • SnapshotInterface.interactEveryNode()
    • SnapshotInterface.interactCoupled()
    • SnapshotInterface.activateDefaultSnapshots()
  • extractCycleNodeFromStamp()
  • getCycleNodeStamp()