minore update to the documentation

Author: marco-de-pietri

.codex

@@ -60,16 +60,17 @@ attributes:
 ``<source>`` Element
 --------------------
 
-The ``<source>`` element represents photon and electron sources associated with
-the decay of a nuclide and contains information to construct an
+The ``<source>`` element represents decay particle sources associated with the
+decay of a nuclide and contains information to construct an
 :class:`openmc.stats.Univariate` object that represents this emission as an
 energy distribution. This element has the following attributes:
 
   :type:
     The type of :class:`openmc.stats.Univariate` source term.
 
   :particle:
-    The type of particle emitted, e.g., 'photon' or 'electron'
+    The type of particle emitted, e.g., ``photon``, ``electron``,
+    ``positron``, ``alpha``, ``neutron``, ``proton``, or ``fragment``
 
   :parameters:
     The parameters of the source term, e.g., for a

docs/source/io_formats/depletion_chain.rst

@@ -64,6 +64,7 @@ Core Functions
     combine_distributions
     decay_constant
     decay_energy
+    decay_particle_energy
     decay_photon_energy
     dose_coefficients
     gnds_name

docs/source/pythonapi/data.rst

@@ -39,9 +39,13 @@ Generally, it involves the following steps:
    with the timestep index returns a :class:`~openmc.deplete.StepResult` object,
    which itself has a :meth:`~openmc.deplete.StepResult.get_material` method
    returning an activated material.
-4. The :meth:`openmc.Material.get_decay_photon_energy` method is used to obtain
-   the energy spectrum of the decay photon source. The integral of the spectrum
-   also indicates the intensity of the source in units of [Bq].
+4. The :meth:`openmc.Material.get_decay_particle_energy` method can be used to
+   obtain the energy spectrum of decay particles from the activated material.
+   For R2S, the photon spectrum is needed and can be obtained either with
+   :meth:`openmc.Material.get_decay_particle_energy` using
+   ``particle='photon'`` or with the wrapper
+   :meth:`openmc.Material.get_decay_photon_energy`. The integral of the
+   spectrum indicates the intensity of the source in units of [Bq].
 5. A new photon source is defined using one of OpenMC's source classes with the
    energy distribution set equal to the object returned by the
    :meth:`openmc.Material.get_decay_photon_energy` method. The source is then
@@ -76,9 +80,10 @@ Altogether, the workflow looks as follows::
     model.settings.source = photon_source
     model.run()
 
-Note that by default, the :meth:`~openmc.Material.get_decay_photon_energy`
-method will eliminate spectral lines with very low intensity, but this behavior
-can be configured with the ``clip_tolerance`` argument.
+Note that :meth:`~openmc.Material.get_decay_particle_energy` and
+:meth:`~openmc.Material.get_decay_photon_energy` will, by default, eliminate
+spectral lines with very low intensity, but this behavior can be configured
+with the ``clip_tolerance`` argument.
 
 Cell-based R2S
 --------------
@@ -236,4 +241,3 @@ relevant tallies. This can be done with the aid of the
 
     # Apply time correction factors
     tally = d1s.apply_time_correction(dose_tally, factors, time_index)
-

docs/source/usersguide/decay_sources.rst

@@ -571,7 +571,8 @@ def decay_photon_energy(nuclide: str) -> Univariate | None:
     for the first time, you need to ensure that a depletion chain has been
     specified in openmc.config['chain_file'].
 
-    .. versionadded:: 0.13.2
+    This is a backward-compatible convenience wrapper around
+    :func:`decay_particle_energy` with ``particle='photon'``.
 
     Parameters
     ----------
@@ -600,14 +601,16 @@ def decay_particle_energy(nuclide: str, particle: str) -> Univariate | None:
     nuclide : str
         Name of nuclide, e.g., 'Co58'
     particle : str
-        Name of the decay particle, e.g., 'photon', 'neutron'
+        Name of the decay particle, e.g., ``photon``, ``electron``,
+        ``positron``, ``alpha``, ``neutron``, ``proton``, or ``fragment``.
 
     Returns
     -------
     openmc.stats.Univariate or None
-        Distribution of energies in [eV] of decay particles emitted from decay, or None
-        if no decay source of that particle exists. Note that the probabilities represent
-        intensities, given as [Bq/atom] (in other words, decay constants).
+        Distribution of energies in [eV] of decay particles emitted from decay,
+        or None if no decay source of that particle exists. Note that the
+        probabilities represent intensities, given as [Bq/atom] (in other
+        words, decay constants).
     """
 
     if not _DECAY_PARTICLE_ENERGY:
@@ -674,4 +677,3 @@ def decay_energy(nuclide: str):
             warn(f"Chain file '{chain_file}' does not have any decay energy.")
 
     return _DECAY_ENERGY.get(nuclide, 0.0)
-

openmc/data/decay.py

@@ -346,7 +346,9 @@ def get_decay_particle_energy(
         Parameters
         ----------
         particle : string
-            Particle type to return the energy distribution for.
+            Particle type to return the energy distribution for. Supported
+            values are ``'photon'``, ``'electron'``, ``'positron'``,
+            ``'alpha'``, ``'neutron'``, ``'proton'``, and ``'fragment'``.
         clip_tolerance : float
             Maximum fraction of :math:`\sum_i x_i p_i` for discrete distributions
             that will be discarded.
@@ -427,10 +429,9 @@ def get_decay_photon_energy(
     ) -> Univariate | None:
         r"""Return energy distribution of decay photons from unstable nuclides.
 
-        This is a convenience wrapper around :meth:`Material.get_decay_particle_energy`
-        with ``particle='photon'``.
-
-        .. versionadded:: 0.14.0
+        This is a backward-compatible convenience wrapper around
+        :meth:`Material.get_decay_particle_energy` with
+        ``particle='photon'``.
 
         Parameters
         ----------