Serpenttools

:release-tag:`0.7.0`
=======================

* Easier construction of |BranchCollector| objects - :pull:`276`
* Directly from the class :class:`~serpentTools.xs.BranchCollector.fromFile`
* Don't require passing branch information to |BranchCollector|. Will be inferred
from file and set with ``(p0, p1, ...)``. State data can be used to
determine which index is a given perturbation type.
* Direct ``toMatlab`` methods for |ResultsReader|, |SensitivityReader|,
|DepmtxReader| |DepletionReader|, |DetectorReader|, |HistoryReader|,
and |Detector| objects - :pull:`290`, :pull:`291`
* Overhaul, reorganization, and cleanup of documentation

.. _v0.7.0-api:

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 - :pull:`288`
* When reading Detectors with a single tally, the value of ``tallies``,
``errors``, and ``scores`` are stored as floats, rather than
:term:`numpy` arrays - :pull:`289`

.. _v0.7.0-dep:

Deprecations
------------

* |DepletionReader| ``saveAsMatlab`` in favor of
:meth:`~serpentTools.DepletionReader.toMatlab`
* SERPENT ``2.1.30`` is the default version of :ref:`serpentVersion`. Will
alter some variable groups, like :ref:`optimization-base` and
:ref:`optimization-2-1-30`, that exist in both versions but are slightly
different.

.. _v0.7.0-bug:

Bug Fixes
---------

* |BranchingReader| is now capable of reading ``.coe`` files with
uncertainties - :pull:`272`
* Fixed a bug that caused some plots not to return the axes object of the plot
- :pull:`297`
* |HomogUniv| plots are plotted against energy group when no group structure
can be determined, and now labeled as such - :pull:`299`
* Removed a non-zero exit code from a successful use of the :ref:`cli-seed`
command line command - :pull:`300`
* |ResultsReader| can process files with assembly discontinuity factors (ADFs)
- :pull:`305`

:release-tag:`0.6.2`
====================

* Data files are bundled in source distribution
* CLI interface for converting some output files to matlab files -
:ref:`cli-to-matlab`
* Add :mod:`serpentTools.io` module for converting objects to
other data types. Currently a general function for converting
|toMatlab-short|
* |DetectorReader| and |Detector| objects can be written to
MATLAB files using |toMatlab-full|
* |ResultsReader| can plot data using
:meth:`~serpentTools.ResultsReader.plot`
* Experimental |BranchCollector| for
collecting group constants from coefficient files. Collects
group constants in in multi-dimensional matrices according
to perturbations, universes, and burnup.
* Plotting routines now use attach to the active plot or generate
a new plot figure if ``ax`` argument not given - :issue:`267`
* |BranchingReader| can
read coefficient files with uncertainties - :issue:`270`

.. warning::

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

.. _v0.6.2-dep:

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

* :meth:`~serpentTools.DepletionReader.saveAsMatlab`
in favor of |toMatlab-full| with::

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

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

:release-tag:`0.6.1`
====================

* :pull:`256` :meth:`serpentTools.settings.rc.loadYaml` uses ``safe_load``
* :pull:`257` |DepletionReader| now can utilize
:meth:`~serpentTools.DepletionReader.saveAsMatlab` for
exporting data to a binary ``.mat`` file
* :pull:`259` Little more clarity into supported readers through documentation
and |read-full| function

:release-tag:`0.6.0`
====================

* :pull:`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, :pull:`191`
* :pull:`196` - Add comparison methods for |ResultsReader| and
|HomogUniv| objects
* :pull:`228` - Add comparison methods for |DetectorReader| and
|Detector| objects
* :pull:`236` - Add comparison methods for |DepletionReader| and
:class:`~serpentTools.objects.DepletedMaterial` objects
* :pull:`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.
* :pull:`249` - Better sparse support for depletion matrix, ``depmtx`` files with a
|DepmtxReader|
* :pull:`252` - Better axis and colorbar labeling for |Detector| mesh plots
* :pull:`254` - Better plotting of single concentrations with |DepmtxReader|
* :pull:`255` - |DepletionReader| can capture material with underscores now!

.. _v0.6.0-dep:

Deprecations
------------

* :func:`~serpentTools.parsers.depmtx` is deprecated in favor of either
:func:`~serpentTools.parsers.readDepmtx` or the class-based
|DepmtxReader|

:release-tag:`0.5.4`
====================

* :pull:`239` - Update python dependencies to continue use of python 2

:release-tag:`0.5.3`
====================

* :pull:`221` - Expanded ``utils`` module to better assist developers
* :pull:`227` - Better documentation of our :ref:`cli`.
Better documentation and testing of functions for generating input
files with unique random seeds - :mod:`serpentTools.seed`
* :pull:`229` - :meth:`serpentTools.SensitivityReader.plot`
now respects the option to not set x nor y labels.
* :pull:`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 :ref:`v0.8.0` and in :pull:`324`