diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst new file mode 100644 index 000000000..42d19a851 --- /dev/null +++ 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 diff --git a/docs/source/pythonapi/examples/mdgxs-part-i.ipynb b/docs/source/examples/mdgxs-part-i.ipynb similarity index 100% rename from docs/source/pythonapi/examples/mdgxs-part-i.ipynb rename to docs/source/examples/mdgxs-part-i.ipynb diff --git a/docs/source/pythonapi/examples/mdgxs-part-i.rst b/docs/source/examples/mdgxs-part-i.rst similarity index 100% rename from docs/source/pythonapi/examples/mdgxs-part-i.rst rename to docs/source/examples/mdgxs-part-i.rst diff --git a/docs/source/pythonapi/examples/mdgxs-part-ii.ipynb b/docs/source/examples/mdgxs-part-ii.ipynb similarity index 100% rename from docs/source/pythonapi/examples/mdgxs-part-ii.ipynb rename to docs/source/examples/mdgxs-part-ii.ipynb diff --git a/docs/source/pythonapi/examples/mdgxs-part-ii.rst b/docs/source/examples/mdgxs-part-ii.rst similarity index 100% rename from docs/source/pythonapi/examples/mdgxs-part-ii.rst rename to docs/source/examples/mdgxs-part-ii.rst diff --git a/docs/source/pythonapi/examples/mgxs-part-i.ipynb b/docs/source/examples/mgxs-part-i.ipynb similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-i.ipynb rename to docs/source/examples/mgxs-part-i.ipynb diff --git a/docs/source/pythonapi/examples/mgxs-part-i.rst b/docs/source/examples/mgxs-part-i.rst similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-i.rst rename to docs/source/examples/mgxs-part-i.rst diff --git a/docs/source/pythonapi/examples/mgxs-part-ii.ipynb b/docs/source/examples/mgxs-part-ii.ipynb similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-ii.ipynb rename to docs/source/examples/mgxs-part-ii.ipynb diff --git a/docs/source/pythonapi/examples/mgxs-part-ii.rst b/docs/source/examples/mgxs-part-ii.rst similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-ii.rst rename to docs/source/examples/mgxs-part-ii.rst diff --git a/docs/source/pythonapi/examples/mgxs-part-iii.ipynb b/docs/source/examples/mgxs-part-iii.ipynb similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-iii.ipynb rename to docs/source/examples/mgxs-part-iii.ipynb diff --git a/docs/source/pythonapi/examples/mgxs-part-iii.rst b/docs/source/examples/mgxs-part-iii.rst similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-iii.rst rename to docs/source/examples/mgxs-part-iii.rst diff --git a/docs/source/pythonapi/examples/mgxs-part-iv.ipynb b/docs/source/examples/mgxs-part-iv.ipynb similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-iv.ipynb rename to docs/source/examples/mgxs-part-iv.ipynb diff --git a/docs/source/pythonapi/examples/mgxs-part-iv.rst b/docs/source/examples/mgxs-part-iv.rst similarity index 100% rename from docs/source/pythonapi/examples/mgxs-part-iv.rst rename to docs/source/examples/mgxs-part-iv.rst diff --git a/docs/source/pythonapi/examples/nuclear-data.ipynb b/docs/source/examples/nuclear-data.ipynb similarity index 100% rename from docs/source/pythonapi/examples/nuclear-data.ipynb rename to docs/source/examples/nuclear-data.ipynb diff --git a/docs/source/pythonapi/examples/nuclear-data.rst b/docs/source/examples/nuclear-data.rst similarity index 100% rename from docs/source/pythonapi/examples/nuclear-data.rst rename to docs/source/examples/nuclear-data.rst diff --git a/docs/source/pythonapi/examples/pandas-dataframes.ipynb b/docs/source/examples/pandas-dataframes.ipynb similarity index 100% rename from docs/source/pythonapi/examples/pandas-dataframes.ipynb rename to docs/source/examples/pandas-dataframes.ipynb diff --git a/docs/source/pythonapi/examples/pandas-dataframes.rst b/docs/source/examples/pandas-dataframes.rst similarity index 100% rename from docs/source/pythonapi/examples/pandas-dataframes.rst rename to docs/source/examples/pandas-dataframes.rst diff --git a/docs/source/pythonapi/examples/post-processing.ipynb b/docs/source/examples/post-processing.ipynb similarity index 100% rename from docs/source/pythonapi/examples/post-processing.ipynb rename to docs/source/examples/post-processing.ipynb diff --git a/docs/source/pythonapi/examples/post-processing.rst b/docs/source/examples/post-processing.rst similarity index 100% rename from docs/source/pythonapi/examples/post-processing.rst rename to docs/source/examples/post-processing.rst diff --git a/docs/source/pythonapi/examples/tally-arithmetic.ipynb b/docs/source/examples/tally-arithmetic.ipynb similarity index 100% rename from docs/source/pythonapi/examples/tally-arithmetic.ipynb rename to docs/source/examples/tally-arithmetic.ipynb diff --git a/docs/source/pythonapi/examples/tally-arithmetic.rst b/docs/source/examples/tally-arithmetic.rst similarity index 100% rename from docs/source/pythonapi/examples/tally-arithmetic.rst rename to docs/source/examples/tally-arithmetic.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 8fe680a70..a18dd5e87 100644 --- 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 diff --git a/docs/source/pythonapi/examples/images/mdgxs.png b/docs/source/pythonapi/examples/images/mdgxs.png deleted file mode 100644 index b93d0f042..000000000 Binary files a/docs/source/pythonapi/examples/images/mdgxs.png and /dev/null differ diff --git a/docs/source/pythonapi/examples/images/mgxs.png b/docs/source/pythonapi/examples/images/mgxs.png deleted file mode 100644 index 3946a5b3c..000000000 Binary files a/docs/source/pythonapi/examples/images/mgxs.png and /dev/null differ diff --git a/docs/source/pythonapi/index.rst b/docs/source/pythonapi/index.rst index d07cf60d3..5cdac17db 100644 --- 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 ------------------------------------