Settings¶
Presented here are the various settings used by the
readers to control what data is stored and how the
data is stored. There are specific settings for each reader,
and those are of the form <leader>.<setting>
,
so depletion.materials is used only by the
DepletionReader
.
Without modifying any settings, each reader defaults to storing all of the
data present in the output file.
Many of the settings instruct the readers to store specific data, such as
only materials present in depletion.materials.
Setting Control¶
Setting control is done using the rc
global. It acts largely
like a dictionary with some validation.
-
class
serpentTools.settings.
rc
¶ -
__getitem__
()¶ x.__getitem__(y) <==> x[y]
-
__setitem__
(name, value)¶ Set the value of a specific setting.
-
__enter__
()¶ Use as a context manager to easily reset settings
Examples
>>> rc["serpentVersion"] = "2.1.30" >>> rc["serpentVersion"] "2.1.30" >>> with rc: ... rc["serpentVersion"] = "2.1.29" ... print(rc["serpentVersion"]) "2.1.29" >>> rc["serpentVersion"] "2.1.30"
-
The settings are explained below and are used by the readers to control what data are stored when reading from files.
Default Settings¶
branching.floatVariables
¶
Names of state data variables to convert to floats for each branch:
Default: []
Type: list
branching.intVariables
¶
Name of state data variables to convert to integers for each branch:
Default: []
Type: list
depletion.materialVariables
¶
Names of variables to store. Empty list -> all variables:
Default: []
Type: list
depletion.materials
¶
Names of materials to store. Empty list -> all materials:
Default: []
Type: list
depletion.metadataKeys
¶
Non-material data to store, i.e. zai, isotope names, burnup schedule, etc:
Default: ['ZAI', 'NAMES', 'DAYS', 'BU']
Type: list
Options: [ZAI, NAMES, DAYS, BU]
depletion.processTotal
¶
Option to store the depletion data from the TOT block:
Default: True
Type: bool
detector.names
¶
List of detectors to store. Empty list -> store all detectors:
Default: []
Type: list
microxs.getFY
¶
If true, store the fission yields:
Default: True
Type: bool
microxs.getFlx
¶
If true, store the group flux ratios:
Default: True
Type: bool
microxs.getXS
¶
If true, store the micro-group cross sections:
Default: True
Type: bool
sampler.allExist
¶
True if all the files should exist. Suppresses errors if a file does not exist:
Default: True
Type: bool
sampler.freeAll
¶
If true, do not retain data from parsers after reading. Limits memory usage after reading:
Default: False
Type: bool
sampler.raiseErrors
¶
If True, stop at the first error. Otherwise, continue reading but make a note about the error:
Default: True
Type: bool
sampler.skipPrecheck
¶
If True, no checks are performed prior to preparing data. Set this to be True only if you know all files contain the same data as errors may arise:
Default: False
Type: bool
serpentVersion
¶
Version of Serpent:
Default: 2.1.31
Type: str
Options: [2.1.29, 2.1.30, 2.1.31]
verbosity
¶
Set the level of errors to be shown:
Default: warning
Type: str
Options: [critical, error, warning, info, debug]
xs.getB1XS
¶
If true, store the critical leakage cross sections:
Default: True
Type: bool
xs.getInfXS
¶
If true, store the infinite medium cross sections:
Default: True
Type: bool
xs.reshapeScatter
¶
If true, reshape the scattering matrices to square matrices. By default, these matrices are stored as vectors:
Default: False
Type: bool
xs.variableExtras
¶
Full SERPENT name of variables to be read:
Default: []
Type: list
xs.variableGroups
¶
Name of variable groups from variables.yaml to be expanded into SERPENT variable to be store:
Default: []
Type: list