From 043bb1b1f689d697201ec4d0c3c0992c105c41c5 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Fri, 7 Aug 2015 12:01:38 +0700 Subject: [PATCH] Better organization of top-level Python API page --- docs/source/pythonapi/index.rst | 34 ++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/docs/source/pythonapi/index.rst b/docs/source/pythonapi/index.rst index 38314f4ea..253362597 100644 --- a/docs/source/pythonapi/index.rst +++ b/docs/source/pythonapi/index.rst @@ -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::