File-parsing API¶

This page contains links to the full documentation for the readers used by serpentTools.

Functions¶

The core of serpentTools is the read() function. This function attempts to determine the file type based on the extension and use the correct reader to parse the file. Below are links to primary reader functions that accept a file path argument and will process the file accordingly.

`read`	Simple entry point to read a file and obtain the processed reader.
`readDepmtx`	Simple entry point to obtain data from depletion matrix files

Classes¶

The read() function relies heavily on the following parsers which can be created and used outside of the function. These classes are also the returned types for read().

`BumatReader`	Parser responsible for reading and working with burned material files.
`BranchingReader`	Parser responsible for reading and working with automated branching files.
`DepletionReader`	Parser responsible for reading and working with depletion files.
`DepmtxReader`	Reader for processing depletion matrix files
`DetectorReader`	Parser responsible for reading and working with detector files.
`HistoryReader`	Class responsible for reading history files
`MicroXSReader`	Parser responsible for reading and working with micro-xs (mdx) files.
`ResultsReader`	Parser responsible for reading and working with result files.
`SensitivityReader`	Class for reading sensitivity files
`XSPlotReader`	Parser responsible for reading and working with xsplot output files.