crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-29 06:35:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

clean up docs for micro_xs helper functions

Browse source
This commit is contained in:
yardasol 2022-07-21 17:43:37 -05:00
parent cc87149526
commit 657a94b0c1
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
openmc/deplete/flux_operator.py
View file

@ -463,12 +463,13 @@ class FluxDepletionOperator(OpenMCOperator):
Array containing one-group microscopic cross section information for each
nuclide and reaction.
units : {'barn', 'cm^2'}, optional
Units for microscopic cross section data. Defaults to ``barn``.
Units of cross section values in ``data`` array. Defaults to ``barn``.
Returns
-------
micro_xs : pandas.DataFrame
A DataFrame object correctly formatted for use in ``FluxOperator``
A DataFrame object correctly formatted for use in ``FluxOperator``.
Cross section data is in [cm^2]
"""
# Validate inputs
@ -498,12 +499,13 @@ class FluxDepletionOperator(OpenMCOperator):
Relative path to csv-file containing microscopic cross section
data.
units : {'barn', 'cm^2'}, optional
Units for microscopic cross section data. Defaults to ``barn``.
Units of cross section values in the ``.csv`` file array. Defaults to ``barn``.
Returns
-------
micro_xs : pandas.DataFrame
A DataFrame object correctly formatted for use in ``FluxOperator``
A DataFrame object correctly formatted for use in ``FluxOperator``.
Cross section data is in [cm^2]
"""
micro_xs = pd.read_csv(csv_file, index_col=0)