crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update docstring for Model.run

Browse source
This commit is contained in:
Paul Romano 2020-03-27 07:49:53 -05:00
parent 11807ae1f1
commit 3e36801ea3
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
openmc/model/model.py
View file

@ -198,18 +198,18 @@ class Model:
self.plots.export_to_xml(d)
def run(self, **kwargs):
"""Creates the XML files, runs OpenMC, and returns k-effective.
The last statepoint Path is available in model.statepoint
"""Creates the XML files, runs OpenMC, and returns the path to the last
statepoint file generated.
Parameters
----------
**kwargs
All keyword arguments are passed to :func:`openmc.run`
Keyword arguments passed to :func:`openmc.run`
Returns
-------
Path
the name of the last statepoint written by this run
Path to the last statepoint written by this run
(None if no statepoint was written)
"""