Miscellaneous

Data Module

The data module exists to assist with reproducing example problems and the test interface. It should be used sparsely unless following along with an example as it is subject to change.

readDataFile	Return a reader for the data file (test or example) file.
getFile	Retrieve the path to one of the reference or example files

Exceptions

serpentTools relies on a few custom exceptions, documented below for convenience.

Note

Developers should rely on built-in exceptions whenever possible. These will be fading out over coming versions.

SerpentToolsException	Base-class for all exceptions in this project
SamplerError	Base-class for errors in sampling process
MismatchedContainersError	Attempting to sample from dissimilar containers

Random Seed Module

Exposed through the serpentTools.seed module are functions to assist in generating repeated input files with unique random seeds. These are used to support the command line sub-command Random Seed Generation.

seedFiles	Copy input file multiple times with unique seeds.
generateSeed	Generate a random seed with length digits