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

Fix docstring for Model.plot (#3198)

Browse source
This commit is contained in:
Paul Romano 2024-11-13 15:58:22 -06:00 • committed by GitHub
parent 58400cbf10
commit d30b2e8014
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
openmc/model/model.py
View file

@ -820,14 +820,14 @@ class Model:
Parameters
----------
n_samples : dict
n_samples : int, optional
The number of source particles to sample and add to plot. Defaults
to None which doesn't plot any particles on the plot.
plane_tolerance: float
When plotting a plane the source locations within the plane +/-
the plane_tolerance will be included and those outside of the
plane_tolerance will not be shown
source_kwargs : dict
source_kwargs : dict, optional
Keyword arguments passed to :func:`matplotlib.pyplot.scatter`.
**kwargs
Keyword arguments passed to :func:`openmc.Universe.plot`