indented index and combined tallies

Author: shimwell

docs/source/cell_tallies.rst

@@ -0,0 +1,7 @@
+
+FusionSettings()
+----------------
+
+.. automodule:: openmc_dagmc_wrapper.FusionSettings
+   :members:
+   :show-inheritance:

docs/source/cell_tally.rst

@@ -0,0 +1,7 @@
+
+Geometry()
+----------
+
+.. automodule:: openmc_dagmc_wrapper.Geometry
+   :members:
+   :show-inheritance:

docs/source/fusion_settings.rst

@@ -1,66 +1,27 @@
 openmc-dagmc-wrapper
 ====================
 
-The openmc-dagmc-wrapper python package allows convenient access to a series of
-standard neutronics simulations and post using OpenMC and DAGMC.
-
-.. toctree::
-   :maxdepth: 1
-
-   install
-   cell_tally
-   cell_tallies
-   mesh_tally_2d
-   mesh_tallies_2d
-   mesh_tally_3d
-   mesh_tallies_3d
-   tet_mesh_tally
-   tet_mesh_tallies
-   tests
-
-History
--------
-
-The package was originally conceived by Jonathan Shimwell to help automate
-neutronics simulations of fusion reactors in a reproducible manner.
-
-The source code is distributed with a permissive open-source
-license (MIT) and is available from the GitHub repository 
-`https://github.com/fusion-energy/openmc-dagmc-wrapper <https://github.com/fusion-energy/openmc-dagmc-wrapper>`_
+The openmc-dagmc-wrapper python package extends OpenMC base classes and adds
+convenience features aimed as easing the use of OpenMC with DAGMC for
+fixed-source simulations.
 
+The openmc-dagmc-wrapper is built around the assumption that a DAGMC geometry
+in the form of a h5m is used as the simulation geometry. This allows several
+aspects of openmc simulations to be simplified.
 
-Features
---------
+Further simplifications are access by using additional packages from the
+`fusion-neutronics-workflow <https://github.com/fusion-energy/fusion_neutronics_workflow>`_
 
-In general the openmc-dagmc-wrapper takes a DAGMC geometry in the form of a h5m
-file and helps adding tallies, materials and a source term to be easily added to 
-create a complete neutronics model. The package will also post processes the
-results of the neutronics simulation to allow easy access to the outputs.
-The simulated results are extracted from the statepoint.h5 file that
-OpenMC produces and converted to vtk, png and JSON files depending on the tally.
+If you are looking for an easy neutronics interface for performing simulations
+of fusion reactors this package was built for you.
 
-To create a model it is also necessary to define the source and the materials
-used. 
-
-The Paramak accepts native OpenMC materials and also Neutronics Material Maker
-materials. Further details on the Neutronics Material Maker is avaialbe via online
-`documentation <https://neutronics-material-maker.readthedocs.io/en/latest/>`_ 
-and the `source code repository <https://github.com/fusion-energy/neutronics_material_maker>`_
-.
-
-The `OpenMC workshop <https://github.com/fusion-energy/neutronics_workshop>`_ 
-also has some tasks that make use of this package. The workshop also
-demonstrates methods of creating the CAD geometry and h5m files from CAD
-geometry.
-
-The `OpenMC workflow <https://github.com/fusion-energy/neutronics_workflow>`_ 
-demonstrates the use of this package along side others in a complete neutronics
-tool chain.
-
-`CAD-to-h5m <https://github.com/fusion-energy/cad_to_h5m>`_ makes use of the
-`Cubit API <https://coreform.com/products/coreform-cubit/>`_ to convert CAD
-files (stp or sat format) into `DAGMC <https://svalinn.github.io/DAGMC/>`_ 
-compatible h5m files for use in DAGMC enabled neutronics codes.
+.. toctree::
+   :maxdepth: 2
 
-For magnetic confinement fusion simulations you might want to use the parametric-plasma-source
-`Git repository <https://github.com/open-radiation-sources/parametric-plasma-source>`_ 
+   install
+   geometry
+   materials
+   fusion_settings
+   tally
+   tests
+   license

docs/source/geometry.rst

@@ -2,13 +2,29 @@
 Installation
 ============
 
-
-Install
--------
-
 To use the OpenMC-DAGMC-Wrapper package you will need the Python, MOAB, DAGMC
 and OpenMC installed.
 
+
+To complete the software stack OpenMC, DAGMC and MOAB will also need installing.
+We don't have simple instructions for these packages yet but one option is to
+duplicate the stages in the `Dockerfile https://github.com/fusion-energy/neutronics_workflow/blob/main/Dockerfile>`_
+or to make use of the `install scripts <https://github.com/fusion-energy/neutronics_workflow/blob/main/install_scripts/`_
+
+
+Pip install
+-----------
+
+Then install the OpenMC-DAGMC-Wrapper package using Pip.
+
+.. code-block:: python
+
+   pip install openmc-dagmc-wrapper
+
+
+Conda install
+-------------
+
 The recommended method is to install Python 3 using Anaconda or Miniconda
 
 * `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ (preferable to avoid hdf5 conflicts)
@@ -38,12 +54,6 @@ Then install the OpenMC-DAGMC-Wrapper package using Pip.
    pip install openmc-dagmc-wrapper
 
 
-To complete the software stack OpenMC, DAGMC and MOAB will also need installing.
-We don't have simple instructions for these packages yet but one option is to
-duplicate the stages in the `Dockerfile https://github.com/fusion-energy/neutronics_workflow/blob/main/Dockerfile>`_
-or to make use of the `install scripts <https://github.com/fusion-energy/neutronics_workflow/blob/main/install_scripts/`_
-
-
 Docker Image Installation
 -------------------------
 

docs/source/index.rst

@@ -0,0 +1,7 @@
+
+License
+-------
+
+The source code is distributed with a permissive open-source license (MIT) and
+is available from the GitHub repository 
+`https://github.com/fusion-energy/openmc-dagmc-wrapper <https://github.com/fusion-energy/openmc-dagmc-wrapper>`_

docs/source/install.rst

@@ -0,0 +1,7 @@
+
+Materials()
+-----------
+
+.. automodule:: openmc_dagmc_wrapper.Materials
+   :members:
+   :show-inheritance: