Skip to content

Commit

Permalink
DOC Clean up sensitivity plot documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
drewejohnson committed Jan 4, 2021
1 parent 1368d0e commit b1370fa
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions serpentTools/parsers/sensitivity.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from itertools import product

from numpy import transpose, hstack
from matplotlib.pyplot import gca, axvline
from matplotlib.pyplot import gca

from serpentTools.utils.plot import magicPlotDocDecorator, formatPlot
from serpentTools.engines import KeywordParser
Expand Down Expand Up @@ -321,27 +321,27 @@ def plot(self, resp, zai=None, pert=None, mat=None, mevscale=False,
----------
resp: str
Name of the specific response to be examined. Must be a key
in ``sensitivities`` and ``energyIntegratedSens``
zai: None or str or int or iterable
in :attr:`sensitivities` and :attr:`energyIntegratedSens`
zai : None or str or int or iterable
Plot sensitivities due to these isotopes. Passing ``None``
will plot against all isotopes.
pert: None or str or list of strings
pert : None or str or list of strings
Plot sensitivities due to these perturbations. Passing ``None``
will plot against all perturbations.
mat: None or str or list of strings
mat : None or str or list of strings
Plot sensitivities due to these materials. Passing ``None``
will plot against all materials.
mevscale : bool, optional
mevscale : bool, optional
Flag for plotting energy grid in MeV units. If ``True``, the energy
axis is expressed in MeV. Default is ``False``.
egrid : numpy.array, optional
egrid : numpy.array, optional
User-defined energy grid boundaries displayed on the sensitivities
as vblack, dashed vertical lines. Default is ``None``.
{sigma}
normalize: True
normalize : True
Normalize plotted data per unit lethargy
{ax}
labelFmt: None or str
labelFmt : None or str
Formattable string to be applied to the labels.
The following entries will be formatted for each plot
permuation::
Expand Down Expand Up @@ -371,7 +371,7 @@ def plot(self, resp, zai=None, pert=None, mat=None, mevscale=False,
See Also
--------
* :py:meth:`str.format` - used for formatting labels
* :meth:`str.format` - used for formatting labels
"""
for subDict in {'sensitivities', 'energyIntegratedSens'}:
Expand Down

0 comments on commit b1370fa

Please sign in to comment.