adding back files to be reviewed

docs/source/examples/cad-geom.rst

@@ -0,0 +1,13 @@
+.. _notebook_cad-geom:
+
+==========================
+Using CAD-Based Geometries
+==========================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/cad-based-geometry.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/candu.rst

@@ -0,0 +1,13 @@
+.. _notebook_candu:
+
+=======================
+Modeling a CANDU Bundle
+=======================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/candu.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/expansion-filters.rst

@@ -0,0 +1,13 @@
+.. _notebook_expansion:
+
+=====================
+Functional Expansions
+=====================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/expansion-filters.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/hexagonal.rst

@@ -0,0 +1,13 @@
+.. _notebook_hexagonal:
+
+===========================
+Modeling Hexagonal Lattices
+===========================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/hexagonal-lattice.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/index.rst

@@ -0,0 +1,62 @@
+.. _examples:
+
+========
+Examples
+========
+
+The following series of `Jupyter <https://jupyter.org/>`_ Notebooks provide
+examples for how to use various features of OpenMC by leveraging the
+:ref:`pythonapi`.
+
+-------------
+General Usage
+-------------
+
+.. toctree::
+    :maxdepth: 1
+
+    pincell
+    post-processing
+    pandas-dataframes
+    tally-arithmetic
+    expansion-filters
+    search
+    nuclear-data
+    nuclear-data-resonance-covariance
+    cad-geom
+    pincell-depletion
+
+--------
+Geometry
+--------
+
+.. toctree::
+    :maxdepth: 1
+
+    hexagonal
+    triso
+    candu
+
+------------------------------------
+Multi-Group Cross Section Generation
+------------------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    mgxs-part-i
+    mgxs-part-ii
+    mgxs-part-iii
+    mdgxs-part-i
+    mdgxs-part-ii
+
+----------------
+Multi-Group Mode
+----------------
+
+.. toctree::
+    :maxdepth: 1
+
+    mg-mode-part-i
+    mg-mode-part-ii
+    mg-mode-part-iii

docs/source/examples/mdgxs-part-i.rst

@@ -0,0 +1,13 @@
+.. _notebook_mdgxs_part_i:
+
+===================================================================
+Multi-Group (Delayed) Cross Section Generation Part I: Introduction
+===================================================================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mdgxs-part-i.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mdgxs-part-ii.rst

@@ -0,0 +1,13 @@
+.. _notebook_mdgxs_part_ii:
+
+=========================================================================
+Multi-Group (Delayed) Cross Section Generation Part II: Advanced Features
+=========================================================================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mdgxs-part-ii.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mg-mode-part-i.rst

@@ -0,0 +1,13 @@
+.. _notebook_mg_mode_part_i:
+
+=====================================
+Multi-Group Mode Part I: Introduction
+=====================================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mg-mode-part-i.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mg-mode-part-ii.rst

@@ -0,0 +1,13 @@
+.. _notebook_mg_mode_part_ii:
+
+=============================================================
+Multi-Group Mode Part II: MGXS Library Generation With OpenMC
+=============================================================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mg-mode-part-ii.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mg-mode-part-iii.rst

@@ -0,0 +1,13 @@
+.. _notebook_mg_mode_part_iii:
+
+====================================================
+Multi-Group Mode Part III: Advanced Feature Showcase
+====================================================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mg-mode-part-iii.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mgxs-part-i.rst

@@ -0,0 +1,13 @@
+.. _notebook_mgxs_part_i:
+
+=========================
+MGXS Part I: Introduction
+=========================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mgxs-part-i.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mgxs-part-ii.rst

@@ -0,0 +1,13 @@
+.. _notebook_mgxs_part_ii:
+
+===============================
+MGXS Part II: Advanced Features
+===============================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mgxs-part-ii.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/mgxs-part-iii.rst

@@ -0,0 +1,13 @@
+.. _notebook_mgxs_part_iii:
+
+========================
+MGXS Part III: Libraries
+========================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/mgxs-part-iii.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/nuclear-data-resonance-covariance.rst

@@ -0,0 +1,13 @@
+.. _notebook_nuclear_data_resonance_covariance:
+
+==================================
+Nuclear Data: Resonance Covariance
+==================================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/nuclear-data-resonance-covariance.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/nuclear-data.rst

@@ -0,0 +1,13 @@
+.. _notebook_nuclear_data:
+
+============
+Nuclear Data
+============
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/nuclear-data.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/pandas-dataframes.rst

@@ -0,0 +1,13 @@
+.. _examples_pandas:
+
+=================
+Pandas Dataframes
+=================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/pandas-dataframes.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/pincell-depletion.rst

@@ -0,0 +1,14 @@
+.. _notebook_depletion:
+
+=================
+Pincell Depletion
+=================
+
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/pincell_depletion.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/pincell.rst

@@ -0,0 +1,13 @@
+.. _notebook_pincell:
+
+===================
+Modeling a Pin-Cell
+===================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/pincell.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/post-processing.rst

@@ -0,0 +1,13 @@
+.. _notebook_post_processing:
+
+===============
+Post Processing
+===============
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/post-processing.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/search.rst

@@ -0,0 +1,13 @@
+.. _notebook_search:
+
+==================
+Criticality Search
+==================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/search.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/tally-arithmetic.rst

@@ -0,0 +1,11 @@
+================
+Tally Arithmetic
+================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/tally-arithmetic.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.

docs/source/examples/triso.rst

@@ -0,0 +1,13 @@
+.. _notebook_triso:
+
+========================
+Modeling TRISO Particles
+========================
+
+.. only:: html
+
+    .. notebook:: ../../../examples/jupyter/triso.ipynb
+
+.. only:: latex
+
+    IPython notebooks must be viewed in the online HTML documentation.