mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-25 20:45:35 -04:00
Added basic structure for Python API docs and filled out docstrings for
openmc.cmfd module.
This commit is contained in:
parent
471030c992
commit
11ab3b78aa
22 changed files with 306 additions and 180 deletions
8
docs/source/pythonapi/ace.rst
Normal file
8
docs/source/pythonapi/ace.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
.. _pythonapi_ace:
|
||||
|
||||
==========
|
||||
ACE Format
|
||||
==========
|
||||
|
||||
.. automodule:: openmc.ace
|
||||
:members:
|
||||
8
docs/source/pythonapi/cmfd.rst
Normal file
8
docs/source/pythonapi/cmfd.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
.. _pythonapi_cmfd:
|
||||
|
||||
====
|
||||
CMFD
|
||||
====
|
||||
|
||||
.. automodule:: openmc.cmfd
|
||||
:members:
|
||||
9
docs/source/pythonapi/element.rst
Normal file
9
docs/source/pythonapi/element.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_element:
|
||||
|
||||
=======
|
||||
Element
|
||||
=======
|
||||
|
||||
.. automodule:: openmc.element
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/executor.rst
Normal file
9
docs/source/pythonapi/executor.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_executor:
|
||||
|
||||
========
|
||||
Executor
|
||||
========
|
||||
|
||||
.. automodule:: openmc.executor
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/filter.rst
Normal file
9
docs/source/pythonapi/filter.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_filter:
|
||||
|
||||
======
|
||||
Filter
|
||||
======
|
||||
|
||||
.. automodule:: openmc.filter
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/geometry.rst
Normal file
9
docs/source/pythonapi/geometry.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_geometry:
|
||||
|
||||
========
|
||||
Geometry
|
||||
========
|
||||
|
||||
.. automodule:: openmc.geometry
|
||||
:members:
|
||||
:undoc-members:
|
||||
32
docs/source/pythonapi/index.rst
Normal file
32
docs/source/pythonapi/index.rst
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
.. _pythonapi:
|
||||
|
||||
==========
|
||||
Python API
|
||||
==========
|
||||
|
||||
--------
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ace
|
||||
cmfd
|
||||
element
|
||||
executor
|
||||
filter
|
||||
geometry
|
||||
material
|
||||
mesh
|
||||
nuclide
|
||||
opencg_compatible
|
||||
particle_restart
|
||||
plots
|
||||
settings
|
||||
statepoint
|
||||
summary
|
||||
surface
|
||||
tallies
|
||||
trigger
|
||||
universe
|
||||
9
docs/source/pythonapi/material.rst
Normal file
9
docs/source/pythonapi/material.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_material:
|
||||
|
||||
=========
|
||||
Materials
|
||||
=========
|
||||
|
||||
.. automodule:: openmc.material
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/mesh.rst
Normal file
9
docs/source/pythonapi/mesh.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_mesh:
|
||||
|
||||
====
|
||||
Mesh
|
||||
====
|
||||
|
||||
.. automodule:: openmc.mesh
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/nuclide.rst
Normal file
9
docs/source/pythonapi/nuclide.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_nuclide:
|
||||
|
||||
=======
|
||||
Nuclide
|
||||
=======
|
||||
|
||||
.. automodule:: openmc.nuclide
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/opencg_compatible.rst
Normal file
9
docs/source/pythonapi/opencg_compatible.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_opencg_compatible:
|
||||
|
||||
====================
|
||||
OpenCG Compatibility
|
||||
====================
|
||||
|
||||
.. automodule:: openmc.opencg_compatible
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/particle_restart.rst
Normal file
9
docs/source/pythonapi/particle_restart.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_particle_restart:
|
||||
|
||||
================
|
||||
Particle Restart
|
||||
================
|
||||
|
||||
.. automodule:: openmc.particle_restart
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/plots.rst
Normal file
9
docs/source/pythonapi/plots.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_plots:
|
||||
|
||||
=====
|
||||
Plots
|
||||
=====
|
||||
|
||||
.. automodule:: openmc.plots
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/settings.rst
Normal file
9
docs/source/pythonapi/settings.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_settings:
|
||||
|
||||
========
|
||||
Settings
|
||||
========
|
||||
|
||||
.. automodule:: openmc.settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/statepoint.rst
Normal file
9
docs/source/pythonapi/statepoint.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_statepoint:
|
||||
|
||||
==========
|
||||
Statepoint
|
||||
==========
|
||||
|
||||
.. automodule:: openmc.statepoint
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/summary.rst
Normal file
9
docs/source/pythonapi/summary.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_summary:
|
||||
|
||||
=======
|
||||
Summary
|
||||
=======
|
||||
|
||||
.. automodule:: openmc.summary
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/surface.rst
Normal file
9
docs/source/pythonapi/surface.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_surface:
|
||||
|
||||
=======
|
||||
Surface
|
||||
=======
|
||||
|
||||
.. automodule:: openmc.surface
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/tallies.rst
Normal file
9
docs/source/pythonapi/tallies.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_tallies:
|
||||
|
||||
=======
|
||||
Tallies
|
||||
=======
|
||||
|
||||
.. automodule:: openmc.tallies
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/trigger.rst
Normal file
9
docs/source/pythonapi/trigger.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_trigger:
|
||||
|
||||
=======
|
||||
Trigger
|
||||
=======
|
||||
|
||||
.. automodule:: openmc.trigger
|
||||
:members:
|
||||
:undoc-members:
|
||||
9
docs/source/pythonapi/universe.rst
Normal file
9
docs/source/pythonapi/universe.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _pythonapi_universe:
|
||||
|
||||
========
|
||||
Universe
|
||||
========
|
||||
|
||||
.. automodule:: openmc.universe
|
||||
:members:
|
||||
:undoc-members:
|
||||
Loading…
Add table
Add a link
Reference in a new issue