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 For example:

>>> import serpentTools
>>> res ='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

Depletion File

Detector/ Tally File

Sensitivity File

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

Cross Section Plot File

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