API Reference
This is the documentation for the application programming interface (API) provided
in the python package scale.olm.
Note
For documentation of the command line utility olm, see CLI Reference.
Welcome to the ORIGEN Library Manager (OLM) Python package!
The main feature of this package is the command line tool olm
which has its own help screens. However there is a ton of useful code
that olm depends on that you may find useful from within your own
Python scripts or notebooks.
import scale.olm as olm # use as olm.core.BurnupHistory
The scale.olm.core contains core classes used throughout OLM.
Additionally, there is a set of five modules for ORIGEN library creation, used by
olm create. These contain functions that are called as part of the library creation
process, based on contents of the model configuration file.
scale.olm.generatefor input generation functions (include submodules)
scale.olm.runfor SCALE running functions
scale.olm.assemblefor library assembly functions
scale.olm.checkfor checking functions
scale.olm.reportfor report generation functions
There is a module used by olm link to link locally stored libraries into
SCALE calculations.
scale.olm.linkfor library linking functions
Finally there are two additional modules for miscellaneous code.
scale.olm.contribfor any contributed utility functions
scale.olm.internalfor internal, private functions
See their respective documentation for details.