armi.bookkeeping package
The bookkeeping package handles data persistence, reporting, and some debugging.
- class armi.bookkeeping.BookkeepingPlugin[source]
Bases:
ArmiPlugin
- static mpiActionRequiresReset(cmd) bool [source]
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.
- static getReportContents(r, cs, report, stage, blueprint)[source]
Generate general report content. Where diagrams/tables not specific to additional plugins comes together.
Currently only happening at End and Begin stage because no content gathered in these sections is used to create a graph across time.
Subpackages
- armi.bookkeeping.db package
- When updating a db version
- Database revision changelog
Database3
Database3.timeNodeGroupPattern
Database3.version
Database3.versionMajor
Database3.versionMinor
Database3.open()
Database3.writeSystemAttributes()
Database3.grabLocalCommitHash()
Database3.close()
Database3.splitDatabase()
Database3.fileName
Database3.loadCS()
Database3.loadBlueprints()
Database3.loadGeometry()
Database3.writeInputsToDB()
Database3.readInputsFromDB()
Database3.mergeHistory()
Database3.genTimeStepGroups()
Database3.getLayout()
Database3.genTimeSteps()
Database3.genAuxiliaryData()
Database3.getAuxiliaryDataPath()
Database3.keys()
Database3.getH5Group()
Database3.hasTimeStep()
Database3.writeToDB()
Database3.syncToSharedFolder()
Database3.load()
Database3.getHistoryByLocation()
Database3.getHistoriesByLocation()
Database3.getHistory()
Database3.getHistories()
DatabaseInterface
DatabaseInterface.name
DatabaseInterface.database
DatabaseInterface.interactBOL()
DatabaseInterface.initDB()
DatabaseInterface.interactEveryNode()
DatabaseInterface.writeDBEveryNode()
DatabaseInterface.interactEOC()
DatabaseInterface.interactEOL()
DatabaseInterface.closeDB()
DatabaseInterface.interactError()
DatabaseInterface.interactDistributeState()
DatabaseInterface.distributable()
DatabaseInterface.prepRestartRun()
DatabaseInterface.loadState()
DatabaseInterface.getHistory()
DatabaseInterface.getHistories()
compareDatabases()
databaseFactory()
loadOperator()
- Subpackages
- Submodules
- armi.bookkeeping.db.compareDB3 module
- armi.bookkeeping.db.database3 module
- armi.bookkeeping.db.databaseInterface module
- armi.bookkeeping.db.factory module
- armi.bookkeeping.db.jaggedArray module
- armi.bookkeeping.db.layout module
- armi.bookkeeping.db.permissions module
- armi.bookkeeping.db.typedefs module
- armi.bookkeeping.report package
setData()
- Subpackages
- Submodules
- armi.bookkeeping.report.data module
- armi.bookkeeping.report.html module
- armi.bookkeeping.report.newReportUtils module
insertBlueprintContent()
insertGeneralReportContent()
comprehensiveBOLContent()
insertDesignContent()
insertBlockDesignReport()
insertCoreDesignReport()
insertEndOfLifeContent()
insertBlockDiagrams()
insertMetaTable()
insertSettingsData()
getPinDesignTable()
insertAreaFractionsReport()
createDimensionReport()
insertCoreAndAssemblyMaps()
DESIGN
- armi.bookkeeping.report.newReports module
- armi.bookkeeping.report.reportInterface module
- armi.bookkeeping.report.reportingUtils module
writeWelcomeHeaders()
getNodeName()
getSystemInfo()
getInterfaceStackSummary()
writeTightCouplingConvergenceSummary()
writeAssemblyMassSummary()
writeCycleSummary()
setNeutronBalancesReport()
summarizePinDesign()
summarizePowerPeaking()
summarizePower()
makeCoreDesignReport()
makeBlockDesignReport()
makeCoreAndAssemblyMaps()
- armi.bookkeeping.tests package
- armi.bookkeeping.visualization package
Submodules
- armi.bookkeeping.historyTracker module
- Getting history information
describeInterfaces()
HistoryTrackerInterface
HistoryTrackerInterface.name
HistoryTrackerInterface.interactBOL()
HistoryTrackerInterface.interactBOC()
HistoryTrackerInterface.interactEOL()
HistoryTrackerInterface.addDetailAssembliesBOL()
HistoryTrackerInterface.addAllFuelAssems()
HistoryTrackerInterface.addDetailAssemsByAssemNums()
HistoryTrackerInterface.getTrackedParams()
HistoryTrackerInterface.addDetailAssembly()
HistoryTrackerInterface.getDetailAssemblies()
HistoryTrackerInterface.getDetailBlocks()
HistoryTrackerInterface.filterTimeIndices()
HistoryTrackerInterface.writeAssemHistory()
HistoryTrackerInterface.preloadBlockHistoryVals()
HistoryTrackerInterface.unloadBlockHistoryVals()
HistoryTrackerInterface.getBlockHistoryVal()
HistoryTrackerInterface.getTimeSteps()
- armi.bookkeeping.mainInterface module
- armi.bookkeeping.memoryProfiler module
- armi.bookkeeping.snapshotInterface module