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

Add documentation for openmc.source and openmc.stats

Browse source
This commit is contained in:
Paul Romano 2016-01-15 07:09:40 -06:00
parent 13d91746a0
commit d578d19d1f
4 changed files with 79 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/pythonapi/index.rst
View file

@ -35,6 +35,8 @@ on a given module or class.
opencg_compatible
plots
settings
source
stats
surface
tallies
trigger

8
docs/source/pythonapi/source.rst Normal file
View file

@ -0,0 +1,8 @@
.. _pythonapi_source:
======
Source
======
.. automodule:: openmc.source
:members:

58
docs/source/pythonapi/stats.rst Normal file
View file

@ -0,0 +1,58 @@
.. _pythonapi_stats:
=====================
Statistical Functions
=====================
----------------------------
Summary of Available Classes
----------------------------
Univariate Probability Distributions
------------------------------------
.. currentmodule:: openmc.stats.univariate
.. autosummary::
Univariate
Discrete
Uniform
Maxwell
Watt
Tabular
Angular Distributions
---------------------
.. currentmodule:: openmc.stats.multivariate
.. autosummary::
UnitSphere
PolarAzimuthal
Isotropic
Monodirectional
Spatial Distributions
---------------------
.. autosummary::
Spatial
CartesianIndependent
Box
Point
Univariate Probability Distributions
------------------------------------
.. automodule:: openmc.stats.univariate
:members:
Multivariate Probability Distributions
--------------------------------------
.. automodule:: openmc.stats.multivariate
:members: