Serpenttools

:release-tag:`0.9.2`
====================

* Officially support installing under Python 3.8
* Support for passing threshold values to hexagonal detector plots
- :issue:`351`

.. _v0.9.2-bugs:

Bug Fixes
---------

* Detector reader can handle sequential detectors with very similar
names - :issue:`374`.
* ``serpentTools`` doesn't make any modifications to the logging state,
other than introducing package-wide logger - :pull:`380`
* Colorbars for mesh plots are placed next to their corresponding
plot, rather than near the last drawn plot - :issue:`372`

:release-tag:`0.9.1`
====================

.. _v0.9.1-bugs:

Bug Fixes
---------

* Sensitivity arrays generated with ``sens opt history 1`` will no longer
overwrite the primary result arrays - :pull:`366`. These arrays are not
currently stored - :issue:`367`

:release-tag:`0.9.0`
====================

* Python 2 support has been dropped.
* Add support for installing and testing against Python 3.7

:release-tag:`0.8.1`
====================

* Use ``six>=1.13.0``
* Use ``yaml>=5.1.1``

.. _v0.8.1-bug:

Bug Fixes
---------

* Fix :ref:`detector-names` setting

:release-tag:`0.8.0`
====================


.. warning::

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

* Better handling of discontinuity factors - :pull:`329`
* |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`` - :pull:`341`
* :class:`~serpentTools.objects.BranchContainer` now inherits from
:class:`dict` - :pull:`344`
* Keys for universes in ``ResultsReader.universes`` are
:class:`~serpentTools.objects.UnivTuple`
* Keys for microscopic cross sections in ``MicroXSReader.xsVal`` and
``MicroXSReader.xsUnc`` are :class:`~serpentTools.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.

.. _v0.8.0-bug:

Bug Fixes
---------

* Burnup and days are properly set on homogenized universes when reading a
result file with multiple universes but no burnup - :pull:`346`
* Modifications made to detector tally data will be reflected in later
plots - :issue:`337`, :pull:`341`
* Variable groups for version 2.1.31 are properly expanded - :pull:`347`

.. _v0.8.0-api:

Incompatible API Changes
------------------------

* 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 :pull:`324` fixed how files without
group constants are handled.
* Keys to |BranchedUniv| objects stored in
:attr:`serpentTools.xs.BranchCollector.universes` are stored as strings,
rather than integers, e.g. ``0`` is replaced with ``"0"`` - :pull:`321`
* Keys to |HomogUniv| instances stored on
:class:`~serpentTools.objects.BranchContainer` are now
:class:`~serpentTools.objects.UnivTuple`, or tuples with
``universe, burnup, step, days`` - :pull:`344`
* :class:`serpentTools.Detector.indexes` is now a tuple of strings
describing each dimension of ``tallies`` rather than ``OrderedDict``
- :pull:`341`

:release-tag:`0.7.1`
====================

* Add :meth:`~serpentTools.objects.HomogUniv.__getitem__` and
:meth:`~serpentTools.objects.HomogUniv.__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`` - :issue:`313`
* Increase required version of :term:`yaml` to ``5.1.1``
* Include ``SERPENT`` ``2.1.31`` support in :ref:`serpentVersion` setting

.. _v0.7.1-bug:

Bug fixes
---------

* Tally data for detectors with time-bins are properly handled - :issue:`312`
* Support for generic string universe names for |BranchingReader| and
|BranchCollector| - :issue:`318`

.. _v0.7.1-dep:

Pending Deprecations
--------------------

* Keys to |BranchedUniv| objects stored in
:attr:`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``.