Skip to content

Add missing documentation on <source> in depletion chain file format #3590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 2, 2025
Merged

Add missing documentation on <source> in depletion chain file format #3590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1522430
Correct units of activity in decay_photon_energy
pshriwise Sep 30, 2025
50c09b8
Adding documentation on source node in chain files
pshriwise Sep 30, 2025
d6fc813
Adjusting wording, indentation
pshriwise Oct 1, 2025
916f866
Apply @aprilnovak suggestions from code review
paulromano Oct 2, 2025
6f225b5
Small edits
paulromano Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/source/io_formats/depletion_chain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,27 @@ attributes:

.. _io_chain_reaction:

--------------------
``<source>`` Element
--------------------

The ``<source>`` element represents photon and electron 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'

:parameters:
The parameters of the source term, e.g., for a
:class:`openmc.stats.Discrete` source, the energies (in [eV]) at which the
particles are emitted and their relative intensities in [Bq/atom] (in other
words, decay constants).

----------------------
``<reaction>`` Element
----------------------
Expand Down
2 changes: 1 addition & 1 deletion openmc/data/decay.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@ def decay_photon_energy(nuclide: str) -> Univariate | None:
openmc.stats.Univariate or None
Distribution of energies in [eV] of photons emitted from decay, or None
if no photon source exists. Note that the probabilities represent
intensities, given as [Bq].
intensities, given as [Bq/atom] (in other words, decay constants).
"""
if not _DECAY_PHOTON_ENERGY:
chain_file = openmc.config.get('chain_file')
Expand Down