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

Better organization of top-level Python API page

Browse source
This commit is contained in:
Paul Romano 2015-08-07 12:01:38 +07:00
parent 43b42bca20
commit 043bb1b1f6
1 changed files with 29 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -4,31 +4,55 @@
Python API
==========
**API Documentation:**
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
executor
filter
geometry
material
mesh
nuclide
opencg_compatible
particle_restart
plots
settings
statepoint
summary
surface
tallies
trigger
universe
**Running OpenMC:**
.. toctree::
:maxdepth: 1
executor
**Post-processing:**
.. toctree::
:maxdepth: 1
particle_restart
statepoint
summary
tallies
**Examples:**
.. toctree::