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

Added some missing versionadded directives

Browse source
This commit is contained in:
Paul Romano 2023-01-13 13:41:00 +07:00
parent 606457a1f0
commit bbe39dbc1b
2 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
openmc/executor.py
View file

@ -41,7 +41,7 @@ def _process_CLI_arguments(volume=False, geometry_debug=False, particles=None,
Path to OpenMC executable. Defaults to 'openmc'.
mpi_args : list of str, optional
MPI execute command and any additional MPI arguments to pass,
e.g. ['mpiexec', '-n', '8'].
e.g., ['mpiexec', '-n', '8'].
path_input : str or Pathlike
Path to a single XML file or a directory containing XML files for the
OpenMC executable to read.
@ -139,6 +139,8 @@ def plot_geometry(output=True, openmc_exec='openmc', cwd='.', path_input=None):
Path to a single XML file or a directory containing XML files for the
OpenMC executable to read.
.. versionadded:: 0.13.3
Raises
------
RuntimeError
@ -171,6 +173,8 @@ def plot_inline(plots, openmc_exec='openmc', cwd='.', path_input=None):
Path to a single XML file or a directory containing XML files for the
OpenMC executable to read.
.. versionadded:: 0.13.3
Raises
------
RuntimeError
@ -222,7 +226,7 @@ def calculate_volumes(threads=None, output=True, cwd='.',
Path to OpenMC executable. Defaults to 'openmc'.
mpi_args : list of str, optional
MPI execute command and any additional MPI arguments to pass,
e.g. ['mpiexec', '-n', '8'].
e.g., ['mpiexec', '-n', '8'].
cwd : str, optional
Path to working directory to run in. Defaults to the current working
directory.
@ -280,7 +284,7 @@ def run(particles=None, threads=None, geometry_debug=False,
openmc_exec : str, optional
Path to OpenMC executable. Defaults to 'openmc'.
mpi_args : list of str, optional
MPI execute command and any additional MPI arguments to pass, e.g.
MPI execute command and any additional MPI arguments to pass, e.g.,
['mpiexec', '-n', '8'].
event_based : bool, optional
Turns on event-based parallelism, instead of default history-based
@ -291,6 +295,8 @@ def run(particles=None, threads=None, geometry_debug=False,
Path to a single XML file or a directory containing XML files for the
OpenMC executable to read.
.. versionadded:: 0.13.3
Raises
------
RuntimeError

2
openmc/material.py
View file

@ -352,6 +352,8 @@ class Material(IDManagerMixin):
on this string. The name and material_id parameters are simply passed on
to the Material constructor.
.. versionadded:: 0.13.3
Parameters
----------
cfg : str