serpentTools.BumatReader

class serpentTools.BumatReader(filePath)

Parser responsible for reading and working with burned material files.

..note:

This is experimental and will be subject to change depending
upon the implementation of GH Issue #12
Parameters

filePath (str) – path to the depletion file

materials

Dictionary of materials with keys as names and values being a dictionary of parameters. The storage of materials is subject to change

Type

dict

burnup

Burnup [MWd/kgU] for this file

Type

float

days

Burnup [days] for this file

Type

float

__getitem__(key)

Return a material from materials

compare(other, lower=0, upper=10, sigma=2, verbosity=None)

Compare the results of this reader to another.

For values without uncertainties, the upper and lower arguments control what passes and what messages get raised. If a quantity in other is less than lower percent different that the same quantity on this object, consider this allowable and make no messages. Quantities that are greater than upper percent different will have a error messages printed and the comparison will return False, but continue. Quantities with difference between these ranges will have warning messages printed.

Parameters

  • other – Other reader instance against which to compare. Must be a similar class as this one.

  • lower (float or int) – Lower limit for relative tolerances in percent Differences below this will be considered allowable

  • upper (float or int) – Upper limit for relative tolerances in percent. Differences above this will be considered failure and errors messages will be raised

  • sigma (int) – Size of confidence interval to apply to quantities with uncertainties. Quantities that do not have overlapping confidence intervals will fail

  • verbosity (None or str) – If given, update the verbosity just for this comparison.

Returns

True if the objects are in agreement with each other according to the parameters specified

Return type

bool

Raises

  • TypeError – If other is not of the same class as this class nor a subclass of this class

  • ValueError – If upper > lower, If sigma, lower, or upper are negative

read()

The main method for reading that not only parses data, but also runs pre and post checks.