OpenMC/docs/source/pythonapi/index.rst
2015-08-10 06:39:03 +07:00

61 lines
883 B
ReStructuredText

.. _pythonapi:
==========
Python API
==========
OpenMC includes a rich Python API that enables programmatic pre- and
post-processing. The easiest way to begin using the API is to take a look at the
example IPython notebooks provided. The full API documentation serves to provide
more information on a given module or class.
**Handling nuclear data:**
.. toctree::
:maxdepth: 1
ace
**Creating input files:**
.. toctree::
:maxdepth: 1
cmfd
element
filter
geometry
material
mesh
nuclide
opencg_compatible
plots
settings
surface
tallies
trigger
universe
**Running OpenMC:**
.. toctree::
:maxdepth: 1
executor
**Post-processing:**
.. toctree::
:maxdepth: 1
particle_restart
statepoint
summary
tallies
**Examples:**
.. toctree::
:maxdepth: 1
examples/tally-arithmetic