Serpenttools

======

.. warning::

This release drops support for Python 3.8 which reached end-of-life
2024-10-17

* Depletion reader settings can be provided at construction - :pull:`516`
* Support ``numpy`` 2.0 - :pull:`524`
* Names of detectors to read can be provided at construction of the detector
reader - :pull:`519`
* Drop Python 3.8 - :pull:`525`
* Support Python 3.12, 3.13 - :pull:`525`

:release-tag:`0.10.1`
=====================

This is a bug fix release to fix installing the package.
Users should experience no changes. Developer should note
that the package has moved from a "flat-layout" to a "src-layout",
where the code the the package has moved from ``serpentTools``
to ``src/serpentTools``

* Move from "flat-layout" to "src-layout" - :pull:`506`

:release-tag:`0.10.0`
=====================

.. warning::

This release has been pulled from :term:`PyPI` and should
be replaced with :ref:`v0.10.1`

* Drop support for Python 3.5, 3.6, and 3.7 - :pull:`478`
* Support and test against Python 3.9, 3.10, and 3.11 - :pull:`492`
* Support Serpent 2.2.1 - :pull:`481`

:release-tag:`0.9.5`
====================

.. note::

Following the `0.9.5` release, the default branch for development
will be the ``main`` branch on GitHub.

* Allow microxs reader to handle files w/o nfy data :pull:`468`
* ResultsReader supports Serpent 2.2.0 :pull:`472`
* SensitivityReader.plot applies the title to the plot :pull:`471`
* SensitivityReader.plot uses absolute value for yerr :pull:`470`
* Allow pathlib.Path arguments to readers :pull:`463`

:release-tag:`0.9.4`
====================

* Normalize spectrum by maximum value or not at all - :pull:`457`
* Support for reading ``pspec`` fields in xsplot files - :pull:`456`

* Support for Serpent 2.1.32 via :ref:`settings`. 2.1.31 is still
default - :pull:`447`
* Support for installing under python 3.9 - :pull:`444`
* Various ``plot`` methods now support passing keyword arguments to underlying
matplotlib plot routines

* :meth:`serpentTools.objects.HomogUniv.plot` - :pull:`432`
* :meth:`serpentTools.SensitivityReader.plot` - :pull:`434`
* :meth:`serpentTools.ResultsReader.plot` - :pull:`446`

Supported by releases :release-tag:`0.9.4rc0` and :release-tag:`0.9.4rc1`

:release-tag:`0.9.3`
====================

* Depletion data now exposed through attributes like
:attr:`~serpentTools.objects.DepletedMaterial.adens` - :pull:`390`
* Generate a :class:`pandas.DataFrame` with depletion data using
:meth:`~serpentTools.objects.DepletedMaterial.toDataFrame`
- :pull:`391`
* Dictionary-like item access and iteration for branching, detector,
history, depletion, and xsplot readers - :pull:`392`, :pull:`395`, :pull:`402`
* Obtain data from :attr:`~serpentTools.ResultsReader.resdata` with
:meth:`~serpentTools.ResultsReader.__getitem__` and
:meth:`~serpentTools.ResultsReader.get` - :pull:`392`
* Modify plot legends for :meth:`serpentTools.objects.XSData.plot` for all
or some plotted MTs - :pull:`402`
* Options for plotting sensitivity profiles against energies in MeV - :pull:`405`

.. _v0.9.3-bug:

Bug Fixes
---------

* Support ``xsplot`` files with branching fractions - :issue:`387`, :pull:`388`

.. _v0.9.3-dep:

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

* :attr:`serpentTools.DepletionReader.metadata`. Prefer attributes
like :attr:`~serpentTools.DepletionReader.zais`
* :attr:`serpentTools.samplers.DepletionSampler.metadata`. Prefer
attributes like :attr:`~serpentTools.samplers.DepletionSampler.zais`
* :meth:`serpentTools.BranchingReader.iterBranches`. Prefer
:meth:`~serpentTools.BranchingReader.items`
* :attr:`serpentTools.XSPlotReader.metadata` and
:attr:`serpentTools.objects.XSData.metadata`. Prefer attributes like
:attr:`~serpentTools.XSPlotReader.majorant` or
:attr:`~serpentTools.objects.XSData.energies` - :pull:`402`