armi.bookkeeping.db package

The db package is responsible for reading and writing the state of the reactor to/from disk.

As an ARMI run progresses, this is periodically updated as the primary output file. It can also be an input file for follow-on analysis or restart runs.

The database can be visualized through various tools such as XTVIEW.

This module contains factories for selecting and building DB-related objects

armi.bookkeeping.db.copyDatabase(r, srcDB, tarDB)

Write the information stored in the source database to the target database

Parameters

• r (reactor) – This reactor should correspond to the data model housed in the srcDB

• srcDB (database) – Any implementation of the database in ARMI

• tarDB (database) – Any implementation of the database in ARMI

armi.bookkeeping.db.convertDatabase(inputDBName: str, outputDBName: Optional[str] = None, outputVersion: Optional[str] = None)

Convert database files between different versions.

Parameters

• inputDB – name of the complete hierarchy database

• outputDB – name of the output database that should be consistent with XTView

• outputVersion – version of the database to convert to. Defaults to latest version

Submodules

• armi.bookkeeping.db.compareDB module
• armi.bookkeeping.db.compareDB3 module
• armi.bookkeeping.db.database module
• armi.bookkeeping.db.database3 module
• armi.bookkeeping.db.factory module
• armi.bookkeeping.db.permissions module
• armi.bookkeeping.db.types module
• armi.bookkeeping.db.xtviewDB module