Merge pull request #406 from drewejohnson/r0.9.3

REL Release 0.9.3

Author: Andrew Johnson

docs/changelog.rst

@@ -6,21 +6,32 @@
 Changelog
 =========
 
+.. note::
+
+    Development will be limited to bug fixes for future 
+    ``0.9.x`` releases. Release ``0.10.0`` will introduce
+    new and improved parsers and containers alongside
+    existing structures. For more information, see
+    :ref:`data-model`
+
 .. _v0.9.3:
 
-0.9.3
-=====
+: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, and depletion readers - :pull:`392`, :pull:`395`
+  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:
 
@@ -40,6 +51,10 @@ Pending Deprecations
   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`
 
 .. _v0.9.2:
 

docs/conf.py

@@ -52,7 +52,7 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
-version = "0.9.2"
+version = "0.9.3"
 
 # General information about the project.
 project = 'serpentTools'

docs/contributors.rst

@@ -7,8 +7,9 @@ Developer Team
 Here are all the wonderful people that helped make this project happen
 
 * `Andrew Johnson <https://github.com/drewejohnson>`_
-* `Dr. Dan Kotlyar <https://github.com/CORE-GATECH>`_
+* `Dan Kotlyar <https://github.com/DanKotlyar>`_
 * `Stefano Terlizzi <https://github.com/sallustius>`_
 * `Gavin Ridley <https://github.com/gridley>`_
 * `Paul Romano <https://github.com/paulromano>`_
-        
+* `Anton Travleev <https://github.com/travleev>`_
+* `@nicolaborate <https://github.com/nicoloabrate>`_ 

docs/develop/index.rst

@@ -8,6 +8,11 @@ This section serves as a guide for people who would like to add functionality
 to this project. If that is not your desire, this chapter can be skipped
 without any loss of comprehension.
 
+.. note::
+
+    Developers are encouraged to read and follow new guiding principles
+    in :ref:`data-model` leading up to verison ``0.10.0``
+
 .. toctree::
     :maxdepth: 2
     :caption: Contents:

docs/index.rst

@@ -71,6 +71,7 @@ version, with links to earlier releases.
    develop/index
    license
    contributors
+   publications
    glossary
 
 Indices and tables

docs/publications.rst

@@ -0,0 +1,59 @@
+.. _publications:
+
+============
+Publications
+============
+
+The following is a non-exhaustive list of publications using ``serpentTools``.
+Please reach out if you wish to add a publication to this list.
+
+Overview
+========
+
+Andrew Johnson, Dan Kotlyar, Stefano Terlizzi, and Gavin Ridley,
+*"serpentTools: A Python Package for Expediting Analysis with Serpent*."
+`Nuclear Science and Engineering (in press) (2020)
+<https://doi.org/10.1080/00295639.2020.1723992>`_
+
+Journal
+=======
+
+M. Krecicki and D. Kotlyar, "*Low enriched nuclear thermal propulsion
+neutronic, thermal hydraulic, and system design space analysis*."
+`Nuclear Engineering and Design (2020) <https://doi.org/10.1016/j.nucengdes.2020.110605>`_
+
+A. Johnson and D. Kotlyar, "*A Transport-Free Method for Predicting the
+Post-Depletion Spatial Neutron Flux Distribution*." `Nuclear Science and
+Engineering (2019) <https://doi.org/10.1080/00295639.2019.1661171>`_
+
+G. Pereira, A. Johnson, Y. Bilodid, E. Fridman, and D. Kotlyar,
+"*Applying the Serpent-DYN3D code sequence for the decay heat analysis
+of metallic fuel sodium fast reactor*." `Annals of Nuclear Energy (2019)
+<https://doi.org/10.1016/j.anucene.2018.11.020>`_
+
+Conference
+==========
+
+A. Johnson and D. Kotlyar, "*Application of a Custom Depletion Framework
+to the Prediction of Neutron Flux Distribution Through Depletion*,"
+in proceedings of PHYSOR 2020: Transition to a Scalable Nuclear
+Future, Cambridge, UK, 2020
+
+C. Kazaroff and A. Johnson and D. Kotlyar and J. Parker, "*Economic
+Benefits of Higher Enriched Assays for 24-month Cycle Length*," in
+proceedings of Global/Top Fuel 2019, Seattle, WA, 2019
+
+A. Johnson and D. Kotlyar, "*Prediction of Spatial Flux Through Depletion*,"
+in proceedings of ANS M&C 2019: Bridging Theory and Applications, Portland, OR, 2019
+
+A. Johnson and D. Kotlyar, "*serpent-tools: A Python Package for Expediting
+Analysis with Serpent Data*," in proceedings of ANS M&C 2019: Bridging
+Theory and Applications, Portland, OR, 2019
+
+M. Krecicki, and D. Kotlyar, "*Sensitivity Studies of the Tungsten Vector
+on the Performance of a LEU NTP Engine*," in proceedings of Nuclear and
+Emerging Technologies for Space, Richland, WA, 2019.
+
+A. Johnson and D. Kotlyar, "*Comparative Study of Monte Carlo Burnup Schemes
+for Full Core Calculations*," in proceedings of PHYSOR 2018: Reactor Physics
+paving the way towards more efficient systems, Cancun, Mexico, 2018.

serpentTools/__init__.py

@@ -7,4 +7,4 @@
 from serpentTools.seed import *
 from serpentTools.xs import *
 
-__version__ = "0.9.2"
+__version__ = "0.9.3"

serpentTools/parsers/sensitivity.py

@@ -415,13 +415,16 @@ def plot(self, resp, zai=None, pert=None, mat=None, mevscale=False,
         if xlabel is None:
             xlabel = "Energy [MeV]" if mevscale else "Energy [eV]"
 
-        xlabel = 'Energy [eV]' if xlabel is None else xlabel
-        ylabel = ylabel if ylabel is not None else (
-            'Sensitivity {} {}'.format(
-                'per unit lethargy' if normalize else '',
-                r'$\pm{}\sigma$'.format(sigma) if sigma else ''))
+        if ylabel is None:
+            parts = ["Sensitivity"]
+            if normalize:
+                parts.append("per unit lethargy")
+            if sigma:
+                parts.append(r"$\pm{}\sigma$".format(sigma))
+            ylabel = " ".join(parts)
+
         ax = formatPlot(ax, loglog=loglog, logx=logx, logy=logy, legendcols=ncol,
-                        legend=legend, xlabel=xlabel, ylabel=ylabel.strip())
+                        legend=legend, xlabel=xlabel, ylabel=ylabel)
         return ax
 
     def _gather_matlab(self, reconvert):

setup.py

@@ -43,7 +43,7 @@ def getDataFiles():
 
 pythonRequires = ">=3.5,<3.9"
 
-version = "0.9.2"
+version = "0.9.3"
 
 setupArgs = {
     'name': 'serpentTools',