Moved the example notebooks front and center

2026-07-27 05:35:49 -04:00 · 2017-03-05 14:19:34 -05:00 · 2017-03-05 14:19:34 -05:00 · 1668fc3a06
commit 1668fc3a06
parent e10a924872
25 changed files with 25 additions and 18 deletions
--- a/docs/source/examples/index.rst
+++ b/docs/source/examples/index.rst
@ -0,0 +1,24 @@
+.. _examples:
+
+=========================
+Example Jupyter Notebooks
+=========================
+
+The following series of Jupyter Notebooks provide examples for usage of OpenMC
+features via the `Python API`_.
+
+.. _Python API: ../pythonapi/index.html
+
+.. toctree::
+    :maxdepth: 1
+
+    post-processing
+    pandas-dataframes
+    tally-arithmetic
+    mgxs-part-i
+    mgxs-part-ii
+    mgxs-part-iii
+    mgxs-part-iv
+    mdgxs-part-i
+    mdgxs-part-ii
+    nuclear-data
--- a/docs/source/pythonapi/examples/mdgxs-part-i.ipynb
+++ b/docs/source/pythonapi/examples/mdgxs-part-i.ipynb
--- a/docs/source/pythonapi/examples/mdgxs-part-i.rst
+++ b/docs/source/pythonapi/examples/mdgxs-part-i.rst
--- a/docs/source/pythonapi/examples/mdgxs-part-ii.ipynb
+++ b/docs/source/pythonapi/examples/mdgxs-part-ii.ipynb
--- a/docs/source/pythonapi/examples/mdgxs-part-ii.rst
+++ b/docs/source/pythonapi/examples/mdgxs-part-ii.rst
--- a/docs/source/pythonapi/examples/mgxs-part-i.ipynb
+++ b/docs/source/pythonapi/examples/mgxs-part-i.ipynb
--- a/docs/source/pythonapi/examples/mgxs-part-i.rst
+++ b/docs/source/pythonapi/examples/mgxs-part-i.rst
--- a/docs/source/pythonapi/examples/mgxs-part-ii.ipynb
+++ b/docs/source/pythonapi/examples/mgxs-part-ii.ipynb
--- a/docs/source/pythonapi/examples/mgxs-part-ii.rst
+++ b/docs/source/pythonapi/examples/mgxs-part-ii.rst
--- a/docs/source/pythonapi/examples/mgxs-part-iii.ipynb
+++ b/docs/source/pythonapi/examples/mgxs-part-iii.ipynb
--- a/docs/source/pythonapi/examples/mgxs-part-iii.rst
+++ b/docs/source/pythonapi/examples/mgxs-part-iii.rst
--- a/docs/source/pythonapi/examples/mgxs-part-iv.ipynb
+++ b/docs/source/pythonapi/examples/mgxs-part-iv.ipynb
--- a/docs/source/pythonapi/examples/mgxs-part-iv.rst
+++ b/docs/source/pythonapi/examples/mgxs-part-iv.rst
--- a/docs/source/pythonapi/examples/nuclear-data.ipynb
+++ b/docs/source/pythonapi/examples/nuclear-data.ipynb
--- a/docs/source/pythonapi/examples/nuclear-data.rst
+++ b/docs/source/pythonapi/examples/nuclear-data.rst
--- a/docs/source/pythonapi/examples/pandas-dataframes.ipynb
+++ b/docs/source/pythonapi/examples/pandas-dataframes.ipynb
--- a/docs/source/pythonapi/examples/pandas-dataframes.rst
+++ b/docs/source/pythonapi/examples/pandas-dataframes.rst
--- a/docs/source/pythonapi/examples/post-processing.ipynb
+++ b/docs/source/pythonapi/examples/post-processing.ipynb
--- a/docs/source/pythonapi/examples/post-processing.rst
+++ b/docs/source/pythonapi/examples/post-processing.rst
--- a/docs/source/pythonapi/examples/tally-arithmetic.ipynb
+++ b/docs/source/pythonapi/examples/tally-arithmetic.ipynb
--- a/docs/source/pythonapi/examples/tally-arithmetic.rst
+++ b/docs/source/pythonapi/examples/tally-arithmetic.rst
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@ -32,6 +32,7 @@ the latest developmental version of the develop branch can be found on
    :maxdepth: 1

    quickinstall
+    examples/index
    releasenotes
    methods/index
    usersguide/index
--- a/docs/source/pythonapi/examples/images/mdgxs.png
+++ b/docs/source/pythonapi/examples/images/mdgxs.png
--- a/docs/source/pythonapi/examples/images/mgxs.png
+++ b/docs/source/pythonapi/examples/images/mgxs.png
--- a/docs/source/pythonapi/index.rst
+++ b/docs/source/pythonapi/index.rst
@ -13,24 +13,6 @@ online. We recommend going through the modules from Codecademy_ and/or the
 `Scipy lectures`_. The full API documentation serves to provide more information
 on a given module or class.

-------------------------
-Example Jupyter Notebooks
-------------------------
-
-.. toctree::
-    :maxdepth: 1
-
-    examples/post-processing
-    examples/pandas-dataframes
-    examples/tally-arithmetic
-    examples/mgxs-part-i
-    examples/mgxs-part-ii
-    examples/mgxs-part-iii
-    examples/mgxs-part-iv
-    examples/mdgxs-part-i
-    examples/mdgxs-part-ii
-    examples/nuclear-data
-
 ------------------------------------
 :mod:`openmc` -- Basic Functionality
 ------------------------------------