v0.6.0rc1

This is the first release candidate for the version 0.6.0. Passing as a release candidate to give some time for input on the comparison methods

Changelog

• #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.

0.5.3

• #221 - Expanded utils module to better assist developers
• #227 - Better documentation of our :ref:cli.
  Better documentation and testing of functions for generating input
  files with unique random seeds - :mod:serpentTools.seed`
• #229 - :meth:serpentTools.parsers.sensitivity.SensitivityReader.plot
  now respects the option to not set x nor y labels.
• #231 - :class:~serpentTools.parsers.results.ResultsReader objects
  can now read files that do not contain group constant data. The setting
  :ref:results-expectGcu` should be used to inform the reader that no
  group constant data is anticipated

0.5.2

• Import test and example files using serpentTools.data. Load example readers with serpentTools.data.readDataFile()
• Support for structured or unstructured matrix plotting with serpentTools.plot.cartMeshPlot()
• Support for plotting hexagonal meshes with serpentTools.objects.detectors.HexagonalDetector.hexPlot()
• Access serpentTools.objects.detectors.Detector objects directly from serpentTools.parsers.detector.DetectorReader with reader[detName]
• Access materials from serpentTools.readers.depletion.DepletionReader and serpentTools.samplers.depletion.DepletionSampler using key-like indexing, e.g. reader[matName] == reader.material[matName]
• Better default x-axis labels for simple detector plots

API Changes

• Some settings in ResultsReader.metadata are now stored as ints or floats, depending upon their nature. Many of these variables refer to flags of settings used by SERPENT

0.5.2a1 - Pre-release for Zenodo

Additional release required to trigger a zenodo build.

0.5.1 - Hexagonal, cylindrical, and spherical detectors

Includes changes that closed #184 - Failure to read detectors with non-Cartesian mesh structures. New parsing routine for the detector reader is capable of reading and storing these data on new Detector objects:

• CartesianDetector
• HexagonalDetector
• CylindricalDetector
• SphericalDetector

Changelog

• #180 - Add capability to pass isotope zzaaai for DepletedMaterial.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 DepletedMaterial.zai as a list of integers, not strings

v0.5.0 - Results, Sensitivity, and MicroXS Readers

• Updated variable groups between 2.1.29 and 2.1.30
  • include poison cross section, kinetic parameters,
    six factor formula (2.1.30 exclusive), and minor differences
• Setting xs.reshapeScatter can be used to reshape scatter matrices on
  HomogUniv objects to square matrices
• asData() added to check if HomogUniv objects have any data stored on them
• HomogUniv object stores group structure on the object.
  New dictionaries for storing group constant data that is not INF nor B1 - gc and gcUnc
• Added the ability to read results file
• Add the ability to read sensitivity files
• Add the serpentTools.objects.containers.HomogUniv.plot() method

API Changes

• metadata dictionaries are no longer present on HomogUniv objects

Deprecations

• Variable group xs-yields is removed
• Branches of a single name are accessible through
  branches['nom'], not branches[('nom', )]

Contributors

• @drewejohnson
• @DanKotlyar
• @paulromano

v0.4.0 - The one that plots cross sections

serpentTools now supports reading xsplot files generated with set xsplot - Example notebook

Pull Requests

• #95 Add xsplot file reader
• #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

Contributors

• @gridley
• @drewejohnson

0.3.1

Issues and Pull Requests Closed

• #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', )]
• Updated bibtex citation in README.rst and documentation

Contributors

• @gridley
• @drewejohnson

0.3.0 - The one with the history

Pull Requests included in this release

1. #109 - Capability to read history files - 78030a8
2. #107 - DepletionReader can now plot data for some or all materials - 15b1d30

0.2.2: The one with the documentation

Pull Requests merged

1. #82 - Command line interface and some sub-commands
2. #88 - Pre- and post-check methods for readers
3. #93 - Detector and Depletion Samplers
4. #96 - Better mesh plotting for detector

Bugs 🐛

1. #99 - Negative universe burnup with branching reader - Closed with #100

Notes

1. serpentTools.objects.containers.Detector.indexes are now zero-indexed
2. The PDF manual is no longer tracked in this repository

Contributors

1. @gridley
2. @drewejohnson