Project Overview¶
The serpentTools
package contains a variety of parsing utilities,
each designed to read a specific output from the SERPENT
Monte Carlo code [serpent].
Many of the parsing utilities store the outputs in custom container objects,
while other store or return a collection of arrays.
This page gives an overview of what files are currently supported,
including links to examples and relevant documentation.
Unless otherwise noted, all the files listed below can be read using
serpentTools.read()
. For example:
>>> import serpentTools
>>> res = serpentTools.read('my_resFile_res.m')
would return a ResultsReader
Some file-types have an additional reader that is capable of reading
multiple files and computing actual uncertainties. These samplers
are detailed in Samplers and listed under the supported files.
Many of the readers have examples present in the Examples section. Each example is present as a Jupyter notebook at Github: examples. These can be used as a launching point for tutorials or for your own analysis.
Main output File¶
File Description: Primary output file for transport calculation -
[input]_res.m
SERPENT wiki: result wiki
Primary Reader:
ResultsReader
Example - notebook: ResultsReader
Example - manual: Results Reader
Depletion File¶
File Description: Output from burnup calculations, showing quantities for various materials -
[input]_dep.m
SERPENT wiki: depletion wiki
Primary Reader:
DepletionReader
Example - notebook: DepletionReader
Example - manual: Depletion Reader
Sampler -
serpentTools.samplers.DepletionSampler
Detector/ Tally File¶
File Description: Output generated by creating detectors -
[input]_det[N].m
SERPENT wiki: detector definition
Primary Reader:
DetectorReader
Example - notebook: Detector
Example - manual: Detector Reader
Sampler -
serpentTools.samplers.DetectorSampler
Sensitivity File¶
File Description: Output giving sensitivities of defined responses to perturbations -
[input]_sens[N].m
SERPENT wiki: sensitivity wiki
Primary Reader:
SensitivityReader
Example - notebook: Sensitivity
Example - manual: Sensitivity Reader
Branching Coefficient File¶
File Description: Selected homogenized group constants across a variety of defined branch states -
[input].coe
SERPENT wiki: branching wiki
Primary Reader:
BranchingReader
Secondary Read function:
serpentTools.BranchCollector.fromFile()
Example - notebook: Branching
Example - manual: Branching Reader
Micro-depletion File¶
File Description:
SERPENT wiki: microxs wiki
Primary Reader:
MicroXSReader
Example - notebook: MicroXSReader
Example - manual: Micro cross section reader
Cross Section Plot File¶
File Description: Cross section data and energy grids for various reactions -
[input]_xs0.m
SERPENT wiki: xsplot wiki_
Primary Reader:
XSPlotReader
Example - notebook: XSPlot
Example - manual: Cross Section Reader/Plotter
Depletion Matrix File¶
File Description: Data pertaining to depletion for a single burnable material at a single point in time -
depmtx_[material-identifier]-s[step].m
Primary Reader:
DepmtxReader
Example - notebook: DepletionMatrix
Example - manual: Depletion Matrix Reader