Address @pshriwise comments on #1558

This commit is contained in:
Paul Romano 2020-05-26 11:33:36 -05:00
parent 698df9294a
commit 4586de20ab
2 changed files with 11 additions and 8 deletions

View file

@ -33,22 +33,24 @@ def dose_coefficients(particle, geometry='AP'):
This function provides fluence to dose conversion coefficients for effective
dose for various types of external exposures based on values in `ICRP
Publication 116 <https://doi.org/10.1016/j.icrp.2011.10.001>`_.
Publication 116 <https://doi.org/10.1016/j.icrp.2011.10.001>`_. Corrected
values found in a correigendum are used rather than the values in the
original report.
Parameters
----------
particle : {'neutron', 'photon', 'electron', 'positron'}
Incident particle
geometry : {'AP', 'PA', 'LLAT', 'RLAT', 'ROT', 'ISO'}
Irradiation geometry assumed. Refer to ICRP-116 for the meaning of the
options here.
Irradiation geometry assumed. Refer to ICRP-116 (Section 3.2) for the
meaning of the options here.
Returns
-------
energy : numpy.ndarray
Energies at which dose conversion coefficients are given
dose : numpy.ndarray
Effective dose in [pSv cm^2] at provided energies
dose_coeffs : numpy.ndarray
Effective dose coefficients in [pSv cm^2] at provided energies
"""
if not _DOSE_ICRP116:
@ -67,5 +69,5 @@ def dose_coefficients(particle, geometry='AP'):
# Pull out energy and dose from table
energy = data[:, 0].copy()
dose = data[:, index + 1].copy()
return energy, dose
dose_coeffs = data[:, index + 1].copy()
return energy, dose_coeffs

View file

@ -32,7 +32,8 @@ kwargs = {
# Data files and librarries
'package_data': {
'openmc.lib': ['libopenmc.{}'.format(suffix)],
'openmc.data': ['mass16.txt', 'BREMX.DAT', '*.h5']
'openmc.data': ['mass16.txt', 'BREMX.DAT', '*.h5'],
'openmc.data.effective_dose': ['*.txt']
},
# Metadata