mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 06:05:58 -04:00
Merge pull request #1857 from paulromano/remove-notebooks
Remove Jupyter notebooks from documentation
This commit is contained in:
Adam Nelson
GitHub
commit
c373d9548f
70 changed files with 10 additions and 28960 deletions
|
|
@ -44,7 +44,6 @@ extensions = [
|
|||
'sphinx.ext.viewcode',
|
||||
'sphinxcontrib.katex',
|
||||
'sphinx_numfig',
|
||||
'nbsphinx'
|
||||
]
|
||||
if not on_rtd:
|
||||
extensions.append('sphinxcontrib.rsvgconverter')
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/cad-based-geometry.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/candu.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/capi.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/expansion-filters.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/hexagonal-lattice.ipynb
|
||||
|
|
@ -1,73 +0,0 @@
|
|||
.. _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
|
||||
capi
|
||||
expansion-filters
|
||||
search
|
||||
nuclear-data
|
||||
nuclear-data-resonance-covariance
|
||||
pincell_depletion
|
||||
|
||||
--------
|
||||
Geometry
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
hexagonal-lattice
|
||||
triso
|
||||
candu
|
||||
cad-based-geometry
|
||||
|
||||
-----------------------------------
|
||||
Multigroup Cross Section Generation
|
||||
-----------------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
mgxs-part-i
|
||||
mgxs-part-ii
|
||||
mgxs-part-iii
|
||||
mdgxs-part-i
|
||||
mdgxs-part-ii
|
||||
|
||||
---------------
|
||||
Multigroup Mode
|
||||
---------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
mg-mode-part-i
|
||||
mg-mode-part-ii
|
||||
mg-mode-part-iii
|
||||
|
||||
-----------------
|
||||
Unstructured Mesh
|
||||
-----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
unstructured-mesh-part-i
|
||||
unstructured-mesh-part-ii
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mdgxs-part-i.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mdgxs-part-ii.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mg-mode-part-i.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mg-mode-part-ii.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mg-mode-part-iii.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mgxs-part-i.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mgxs-part-ii.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/mgxs-part-iii.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/nuclear-data-resonance-covariance.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/nuclear-data.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/pandas-dataframes.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/pincell.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/pincell_depletion.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/post-processing.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/search.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/tally-arithmetic.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/triso.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/unstructured-mesh-part-i.ipynb
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../examples/jupyter/unstructured-mesh-part-ii.ipynb
|
||||
|
|
@ -36,7 +36,7 @@ Forum <https://openmc.discourse.group/>`_.
|
|||
:maxdepth: 1
|
||||
|
||||
quickinstall
|
||||
examples/index
|
||||
Examples <https://github.com/openmc-dev/openmc/wiki/Example-Jupyter-Notebooks>
|
||||
releasenotes/index
|
||||
methods/index
|
||||
usersguide/index
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ Python API
|
|||
|
||||
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
|
||||
:ref:`examples`. This assumes that you are already familiar with Python and
|
||||
common third-party packages such as `NumPy <https://numpy.org/>`_. If you have
|
||||
never used Python before, the prospect of learning a new code *and* a
|
||||
programming language might sound daunting. However, you should keep in mind that
|
||||
there are many substantial benefits to using the Python API, including:
|
||||
examples_. This assumes that you are already familiar with Python and common
|
||||
third-party packages such as `NumPy <https://numpy.org/>`_. If you have never
|
||||
used Python before, the prospect of learning a new code *and* a programming
|
||||
language might sound daunting. However, you should keep in mind that there are
|
||||
many substantial benefits to using the Python API, including:
|
||||
|
||||
- The ability to define dimensions using variables.
|
||||
- Availability of standard-library modules for working with files.
|
||||
|
|
@ -50,3 +50,5 @@ or class.
|
|||
data
|
||||
capi
|
||||
openmoc
|
||||
|
||||
.. _examples: https://github.com/openmc-dev/openmc/wiki/Example-Jupyter-Notebooks
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue