# Changelog¶

Note

Development will be limited to bug fixes for future 0.9.x releases. Release 0.10.0 will introduce new and improved parsers and containers alongside existing structures. For more information, see Updated Data Model

## 0.9.3¶

### Bug Fixes¶

• Support xsplot files with branching fractions - #387, #388

## 0.9.2¶

• Officially support installing under Python 3.8

• Support for passing threshold values to hexagonal detector plots - #351

### Bug Fixes¶

• Detector reader can handle sequential detectors with very similar names - #374.

• serpentTools doesn’t make any modifications to the logging state, other than introducing package-wide logger - #380

• Colorbars for mesh plots are placed next to their corresponding plot, rather than near the last drawn plot - #372

## 0.9.1¶

### Bug Fixes¶

• Sensitivity arrays generated with sens opt history 1 will no longer overwrite the primary result arrays - #366. These arrays are not currently stored - #367

## 0.9.0¶

• Python 2 support has been dropped.

• Add support for installing and testing against Python 3.7

## 0.8.1¶

• Use six>=1.13.0

• Use yaml>=5.1.1

## 0.8.0¶

Warning

Serpent 1 detectors are no longer supported - #327. Version 0.9.0 will remove support for python 2 - #328

• Better handling of discontinuity factors - #329

• HomogUniv objects no longer automatically convert data to arrays

• Serpent 2.1.31 is the default version for serpentVersion setting

• Detectors and related subclasses are now standalone classes that can be imported as serpentTools.Detector - #341

• BranchContainer now inherits from dict - #344

• Keys for universes in ResultsReader.universes are UnivTuple

• Keys for microscopic cross sections in MicroXSReader.xsVal and MicroXSReader.xsUnc are MicroXSTuple

• Spread plots for sampled detector and depletion containers allow changing how the mean data and sampled data are plotted by passing dictionary of matplotlib commands, e.g. meanKwargs={"c": "r", "marker": x"} would plot the mean data in red with crosses as markers.

### Bug Fixes¶

• Burnup and days are properly set on homogenized universes when reading a result file with multiple universes but no burnup - #346

• Modifications made to detector tally data will be reflected in later plots - #337, #341

• Variable groups for version 2.1.31 are properly expanded - #347

## 0.7.1¶

### Pending Deprecations¶

• Keys to BranchedUniv objects stored in serpentTools.xs.BranchCollector.universes are stored as strings, rather than integers, e.g. 0 is replaced with "0". A workaround is in-place, but will be removed in future versions.

• SERPENT 1 style detectors with additional score column will not be supported starting at version 0.8.0.

## 0.7.0¶

### Incompatible API Changes¶

• HomogUniv objects are now stored on ResultsReader with zero-based indexing for burnup. The previous first value of burnup step was one. All burnup indices are now decreased by one. Similarly, if no burnup was present in the file, the values of burnup and days for all universes is zero - #288

• When reading Detectors with a single tally, the value of tallies, errors, and scores are stored as floats, rather than numpy arrays - #289

## 0.6.2¶

Warning

The API for the BranchCollector may be subject to change through revisions until 0.7.0

### Pending Deprecations¶

• saveAsMatlab() in favor of serpentTools.io.toMatlab() with:

>>> from serpentTools.io import toMatlab
>>> toMatlab(depR)

• Depletion plot routines will no longer accept timePoints arguments, instead plotting against all points in time

## 0.6.0¶

### Deprecations¶

• depmtx() is deprecated in favor of either readDepmtx() or the class-based DepmtxReader

## 0.5.4¶

• #239 - Update python dependencies to continue use of python 2

## 0.5.3¶

• #221 - Expanded utils module to better assist developers

• #227 - Better documentation of our Command Line Interface. Better documentation and testing of functions for generating input files with unique random seeds - serpentTools.seed

• #229 - serpentTools.SensitivityReader.plot() now respects the option to not set x nor y labels.

• #231 - ResultsReader objects can now read files that do not contain group constant data. The setting results-expectGcu should be used to inform the reader that no group constant data is anticipated

Note

This setting was removed in 0.8.0 and in #324

## 0.5.1¶

• #180 - Add capability to pass isotope zzaaai for getValues() and associated plot routines

• #187 - Import all readers and samplers from the main package:

>>> from serpentTools import ResultsReader
>>> from serpentTools import DetectorSampler

• #189 - Support for reading Detectors with hexagonal, cylindrical, and spherical meshes.

### API Changes¶

• zzaaai data is stored on zai as a list of integers, not strings

## 0.5.0¶

### Deprecation¶

• Variable group xs-yields is removed. Use poisons instead

• Branches of a single name are only be accessible through branches['nom'], not branches[('nom'), ] as per #114

## 0.4.0¶

• #95 Add xsplot file reader - XSPlotReader

• #121 Samplers will raise more warnings/errors if no files are loaded from * wildcards

• #122 Better Detector labeling

• #135 Added instructions for better converting Jupyter notebooks to .rst files. Plotting guidelines

## 0.3.1¶

• #118 - Support for SERPENT 2.1.30

• #119 - SampledDepletedMaterial now respects the value of xUnits - #120

• #114 - Standalone branches in the coefficient files are stored and accessed using a single string, rather than a single-entry tuple branches['myBranch'] vs. branches[('myBranch', )]

## 0.2.2¶

• #82 - Command line interface and some sub-commands

• #88 - Pre- and post-check methods for readers

• #93 - Detector and Depletion Samplers

• #96 - Better mesh plotting for Detector

• #99 - Negative universe burnup with branching reader - #100

• serpentTools.objects.Detector.indexes are now zero-indexed

• The PDF manual is no longer tracked in this repository