Update Chain.from_endf docstring: Support Evaluations

This commit is contained in:
Andrew Johnson 2020-01-28 13:33:45 -05:00
parent 0f2863b488
commit 2ef7ec2df5
No known key found for this signature in database
GPG key ID: C40EC2D0985B2B02

View file

@ -192,13 +192,18 @@ class Chain(object):
def from_endf(cls, decay_files, fpy_files, neutron_files, progress=True):
"""Create a depletion chain from ENDF files.
String arguments in ``decay_files``, ``fpy_files``, and
``neutron_files`` will be treated as file names to be read.
Alternatively, :class:`openmc.data.endf.Evaluation` instances
can be included in these arguments.
Parameters
----------
decay_files : list of str
decay_files : list of str or openmc.data.endf.Evaluation
List of ENDF decay sub-library files
fpy_files : list of str
fpy_files : list of str or openmc.data.endf.Evaluation
List of ENDF neutron-induced fission product yield sub-library files
neutron_files : list of str
neutron_files : list of str or openmc.data.endf.Evaluation
List of ENDF neutron reaction sub-library files
progress : bool, optional
Flag to print status messages during processing. Does not