0.9.0

Identical API as version 0.8.1, just without python 2 support

0.8.1

• Use six>=1.13.0
• Use yaml>=5.1.1
• Fix detector.names setting

0.8.0

🚨 This is the last major release to support Python 2 🚨

• Better handling of discontinuity factors
• HomogUniv objects no longer automatically convert data to arrays
• Serpent 2.1.31 is the default version
• Detectors and related subclasses are now standalone classes that can be imported as serpentTools.Detector
• serpentTools.objects.BranchContainer now inherits from dict
• Keys for universes in ResultsReader.universes are serpentTools.objects.UnivTuple
• Keys for microscopic cross sections in MicroXSReader.xsVal and MicroXSReader.xsUnc are serpentTools.MicroXSTuple
• Burnup and days are properly set on homogenized universes when reading a result file with multiple universes but no burnup
• Modifications made to detector tally data will be reflected in later plots
• Variable groups for version 2.1.31 are properly expanded
• Values are stored in array form on HomogUniv when it makes sense. For example, values like infKinf are stored as scalars.
• Setting expectGcu has been removed as fixed how files without group constants are handled.
• Keys to BranchedUniv objects stored in serpentTools.BranchCollector.universes are stored as strings, rather than integers, e.g. 0 is replaced with "0"
• Keys to HomogUniv instances stored on serpentTools.objects.BranchContainer are now serpentTools.objects.UnivTuple, or tuples with universe, burnup, step, days
• serpentTools.Detector.indexes is now a tuple of strings describing each dimension of tallies rather than OrderedDict
• Allow some aesthetic control with sampler spreadPlot

0.8.0rc0

• Better handling of discontinuity factors
• HomogUniv objects no longer automatically convert data to arrays
• Serpent 2.1.31 is the default version for :ref:serpentVersion setting
• Detectors and related subclasses are now standalone classes that can be
  imported as serpentTools.Detector
• serpentTools.objects.BranchContainer now inherits from dict
• Keys for universes in ResultsReader.universes are
  serpentTools.objects.UnivTuple
• Keys for microscopic cross sections in MicroXSReader.xsVal and
  MicroXSReader.xsUnc are serpentTools.MicroXSTuple
• Burnup and days are properly set on homogenized universes when reading
  a result file with multiple universes but no burnup
• Modifications made to detector tally data will be reflected in later plots
• Variable groups for version 2.1.31 are properly expanded
• Values are stored in array form on HomogUniv when it makes sense.
  For example, values like infKinf are stored as scalars.
• Setting expectGcu has been removed as fixed how files without
  group constants are handled.
• Keys to BranchedUniv objects stored in
  serpentTools.BranchCollector.universes are stored as strings,
  rather than integers, e.g. 0 is replaced with "0"
• Keys to HomogUniv instances stored on
  serpentTools.objects.BranchContainer are now
  serpentTools.objects.UnivTuple, or tuples with
  universe, burnup, step, days
• serpentTools.Detector.indexes is now a tuple of strings
  describing each dimension of tallies rather than OrderedDict

0.7.1

🚨 🚨 Release 0.8.0 will be the last major release to support python 2 🚨 🚨

API Changes

• Add __getitem__() and __setitem__() convenience methods for accessing expected values on HomogUniv objects
• Add thresh argument to Detector.meshPlot where only data greater than thresh is plotted.
• Mitigate pending deprecated imports from collections - #313
• Increase required version of yaml to 5.1.1
• Include SERPENT 2.1.31 support in serpentVersion setting

Bug fixes

• Tally data for detectors with time-bins are properly handled - #312
• Support for generic string universe names for BranchingReader and BranchCollector - #318

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.

Signatures

sha256sum

e7e50ab1f40f5b36d52a0b1ebef7cbb81c49205f9bd2a106a8178d6fa5e407be  serpentTools-0.7.1-py2-none-any.whl
b46b83c18ddfeb2e8000a234f118fd79b5dbb83b2c3e7ce452af4d358080282d  serpentTools-0.7.1-py3-none-any.whl
e099ef375382c610efd7badc8c2590632a5a5580b4f59060a0716af160b5fda6  serpentTools-0.7.1.tar.gz
9ce99d8f848293a81f86d2159163ab69dc620f160f3977603ff15bb7b026cdd5  serpentTools-0.7.1.zip

md5sum

77d38fb48b186e1c2766d2c6680edd88  serpentTools-0.7.1-py2-none-any.whl
4ec73a5b856f6449dd554691c3c7060c  serpentTools-0.7.1-py3-none-any.whl
e860e3642ac8ec2bca5bff6568160ef5  serpentTools-0.7.1.tar.gz
ecb8aa637b91054291a025c5c346e77f  serpentTools-0.7.1.zip

Binary uploads are signed with @drewejohnson gpg key 5CF4D1264A3E6339

0.7.0

New features

1. Documentation has been overhauled and reorganized
2. Easier import of readers, e.g.

>>> from serpentTools import DepletionReader

1. New BranchCollector object designed to collect group constant data from coefficient files in a condensed manner.
2. Depletion, Detector, Results, History, Sensitivity, and DepletionMatrix Readers can export their contents to binary .mat files using toMatlab
3. New sub-command $ python -m serpentTools to-matlab exports file contents to .mat files using these toMatlab methods

API Changes

The following changes have been made to the API and may cause issues. These are easy to mitigate and upgrade

1. HomogUniv objects are now zero-indexed by burnup step on the ResultsReader. All indexes are one value less
2. Detectors with a single bin store the tally data as a float, rather than an array.
3. SERPENT 2.1.30 is the default version in the settings. This will only effect the ResultsReader, and will display a warning message. The version can be reverted with

>>> from serpentTools.settings import rc
>>> rc['serpentVersion'] = '2.3.10'

Deprecations

1. DepletionReader.saveAsMatlab has been deprecated in favor of DepletionReader.toMatlab for a consistent interface

Bug Fixes

1. Read coefficient files with uncertainties - #272
2. Return axes object from plots - #297
3. HomogUniv plot against group rather than energy
   if no group structure given - #299
4. Use of seed CLI has better exit conditions - #300
5. ResultsReader can handle ADFs - #305

SHA256 sums for python wheels

7b408d3ddc8b4093a9737fcd60a0ca89d73b94b9e0f3a46b7d2f6b3ad48c5fb5  serpentTools-0.7.0-py2-none-any.whl
25a573be4759b8ed4328ee87c32e82217f38826eacaf42720c51d4fc8a637080  serpentTools-0.7.0-py3-none-any.whl

MD5 sums for python wheels

56a4ef672fb8e062cd26c358ddbd2ab1  serpentTools-0.7.0-py2-none-any.whl
7bbc27f30ed729245a6c10b1d1c44146  serpentTools-0.7.0-py3-none-any.whl

0.7.0rc0

First release candidate for 0.7.0

Changelog

New features

1. Documentation has been overhauled and reorganized
2. Easier import of readers, e.g.

>>> from serpentTools import DepletionReader

1. New BranchCollector object designed to collect group constant data from coefficient files in a condensed manner.
2. Depletion, Detector, Results, History, Sensitivity, and DepletionMatrix Readers can export their contents to binary .mat files using toMatlab
3. New sub-command $ python -m serpentTools to-matlab exports file contents to .mat files using these toMatlab methods

API Changes

The following changes have been made to the API and may cause issues. These are easy to mitigate and upgrade

1. HomogUniv objects are now zero-indexed by burnup step on the ResultsReader. All indexes are one value less
2. Detectors with a single bin store the tally data as a float, rather than an array.

Deprecations

1. DepletionReader.saveAsMatlab has been deprecated in favor of DepletionReader.toMatlab for a consistent interface

SHA256 sums for python wheels

4e58edc5e5aaed258f7b23d6f0400ce64fcb139229596d851cf7e1f78eb9c6ab  serpentTools-0.7.0rc0-py2-none-any.whl
106d562a3330d268a6c3c16e01872177b71e51f4253521071b05a5999bf7004d  serpentTools-0.7.0rc0-py3-none-any.whl

MD5 sums for python wheels

5cb2b0ef1c40ffb1afcdd53bdfdb6b54  serpentTools-0.7.0rc0-py2-none-any.whl
1a5b7b28e8bd8b5279851be6905e5acb  serpentTools-0.7.0rc0-py3-none-any.whl

0.6.2

Highlights

• Depletion and detector files can be written to matlab .mat files from the command line with
  $ python -m serpentTools to-matlab my_dep.m
• Experimental serpentTools.xs.BranchCollector object compresses coefficient file data into a more concise format. Each group constant is stored as a multidimensional array spanning all universes, burnup points, and perturbation states.
• Data files are bundled in source distribution
• Plotting routines will attach to the active plot through matplotlib.pyplot.gca if not ax argument is given

Deprecations

• DepletionReader saveAsMatlab will be deprecated in 0.7.0 in favor of a toMatlab method

0.6.1

Updates

serpentTools can now be installed via pip, greatly simplifying the install procedure.

Changes

• #256 - Use yaml.safe_load everywhere
• #257 - DepletionReader export to matlab using scipy.io.savemat with saveAsMatlab
• #259 - More clarity when using serpentTools.read

v0.6.0

• #174 - Added parent object BaseObject with basic comparison
  method from which all objects inherit. Comparison method contains
  upper and lower bounds for values w/o uncertainties, #191
• #196 - Add comparison methods for resultReader and
  homogUniv objects
• #228 - Add comparison methods for detectorReader and
  detector objects
• #236 - Add comparison methods for depletionReader and
  DepletedMaterial objects
• #241 - Fix a bug in the CLI that rendered the ability to generate files with
  unique random seeds. python -m serpentTools seed <input> <N> can now be properly
  used.
• #249 - Better sparse support for depletion matrix, depmtx files with a
  depmtxReader
• #252 - Better axis and colorbar labeling for detector mesh plots
• #254 - Better plotting of single concentrations with depmtxReader
• #255 - depletionReader can capture material with underscores now!