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
DatabaseDatabase.timeNodeGroupPatternDatabase.versionDatabase.versionMajorDatabase.versionMinorDatabase.open()Database.isOpen()Database.writeSystemAttributes()Database.grabLocalCommitHash()Database.close()Database.splitDatabase()Database.fileNameDatabase.loadCS()Database.loadBlueprints()Database.loadGeometry()Database.writeInputsToDB()Database.readInputsFromDB()Database.mergeHistory()Database.genTimeStepGroups()Database.getLayout()Database.genTimeSteps()Database.genAuxiliaryData()Database.getAuxiliaryDataPath()Database.keys()Database.getH5Group()Database.hasTimeStep()Database.writeToDB()Database.syncToSharedFolder()Database.load()Database.loadReadOnly()Database.getHistoryByLocation()Database.getHistoriesByLocation()Database.getHistory()Database.getHistories()
Database3DatabaseInterfaceDatabaseInterface.nameDatabaseInterface.databaseDatabaseInterface.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.database 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.passiveDBLoadPlugin 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()HistoryTrackerInterfaceHistoryTrackerInterface.nameHistoryTrackerInterface.DETAILED_ASSEMBLY_FLAGSHistoryTrackerInterface.interactBOL()HistoryTrackerInterface.interactBOC()HistoryTrackerInterface.interactEOL()HistoryTrackerInterface.addDetailAssembliesBOL()HistoryTrackerInterface.addAllDetailedAssems()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