crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Fix docstring for MicroXS class (#2540)

Browse source
This commit is contained in:
Paul Romano 2023-05-31 19:25:26 -05:00 • committed by GitHub
parent 6c7f857e1e
commit 16b955f690
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
openmc/deplete/microxs.py
View file

@ -37,8 +37,9 @@ class MicroXS(DataFrame):
dilute_initial=1.0e3,
energy_bounds=(0, 20e6),
run_kwargs=None):
"""Generate a one-group cross-section dataframe using
OpenMC. Note that the ``openmc`` executable must be compiled.
"""Generate a one-group cross-section dataframe using OpenMC.
Note that the ``openmc`` executable must be compiled.
Parameters
----------
@ -55,8 +56,6 @@ class MicroXS(DataFrame):
Initial atom density [atoms/cm^3] to add for nuclides that
are zero in initial condition to ensure they exist in the cross
section data. Only done for nuclides with reaction rates.
reactions : list of str, optional
Reaction names to tally
energy_bound : 2-tuple of float, optional
Bounds for the energy group.
run_kwargs : dict, optional