crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 22:26:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

specified that year is Julian in docstring

Browse source
This commit is contained in:
shimwell 2022-08-02 20:36:42 +01:00
parent 3c22a405fe
commit ea926ef84a
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
openmc/deplete/results.py
View file

@ -111,7 +111,8 @@ class Results(list):
time_units : {"s", "min", "h", "d", "a"}, optional
Units for the returned time array. Default is ``"s"`` to
return the value in seconds. Other options are minutes ``"min"``,
hours ``"hours"``, days ``"d"``, years ``"a"``
hours ``"hours"``, days ``"d"``, years ``"a"`` (Julian year 365.25
days).
.. versionadded:: 0.12
@ -207,6 +208,7 @@ class Results(list):
time_units : {"s", "d", "min", "h", "a"}, optional
Desired units for the times array. Options are seconds ``"s"``
minutes ``"min"``, hours ``"hours"``, days ``"d"``, years ``"a"``
(Julian year 365.25 days).
Returns
-------
@ -275,7 +277,8 @@ class Results(list):
time_units : {"s", "d", "min", "h", "a"}, optional
Return the vector in these units. Default is to
convert to days ``"d"``. Other options are seconds ``"s"``, minutes
``"min"``, hours ``"hours"``, years ``"a"``
``"min"``, hours ``"hours"``, years ``"a"`` (Julian year 365.25
days).
Returns
-------
@ -315,6 +318,7 @@ class Results(list):
time_units : {"s", "d", "min", "h", "a"}, optional
Units on ``time``. Default: days ``"d"``. Other options are seconds
``"s"``, minutes ``"min"``, hours ``"hours"`` and years ``"a"``
(Julian year 365.25 days)
atol : float, optional
Absolute tolerance (in ``time_units``) if ``time`` is not
found.