crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

removed unneeded notebooks, allowed openmc.Settings.max_order to take a None parameter, and revised notebooks according to comments from @paulromano, @wbinventor and @smharper.

Browse source
This commit is contained in:
Adam Nelson 2017-03-09 09:20:42 -05:00
parent 966169de08
commit 8f08529551
10 changed files with 198 additions and 1537 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/source/examples/index.rst
View file

@ -1,13 +1,13 @@
.. _examples:
=========================
Example Jupyter Notebooks
=========================
=================
Example Notebooks
=================
The following series of Jupyter Notebooks provide examples for usage of OpenMC
features via the `Python API`_.
The following series of Jupyter_ Notebooks provide examples for usage of OpenMC
features via the :ref:`pythonapi`.
.. _Python API: ../pythonapi/index.html
.. _Jupyter: https://jupyter.org/
.. toctree::
:maxdepth: 1

6
docs/source/examples/mdgxs-part-i.rst
View file

@ -1,8 +1,8 @@
.. _notebook_mdgxs_part_i:
==========================
MDGXS Part I: Introduction
==========================
===================================================================
Multi-Group (Delayed) Cross Section Generation Part I: Introduction
===================================================================
.. only:: html

6
docs/source/examples/mdgxs-part-ii.rst
View file

@ -1,8 +1,8 @@
.. _notebook_mdgxs_part_ii:
================================
MDGXS Part II: Advanced Features
================================
=========================================================================
Multi-Group (Delayed) Cross Section Generation Part II: Advanced Features
=========================================================================
.. only:: html

103
docs/source/examples/mg-mode-part-i.ipynb
View file

File diff suppressed because one or more lines are too long

134
docs/source/examples/mg-mode-part-ii.ipynb
View file

File diff suppressed because one or more lines are too long

95
docs/source/examples/mg-mode-part-iii.ipynb
View file

File diff suppressed because one or more lines are too long

1345
docs/source/examples/mgxs-part-iv.ipynb
View file

File diff suppressed because one or more lines are too long

13
docs/source/examples/mgxs-part-iv.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mgxs_part_iv:
====================================================
MGXS Part IV: Multi-Group Mode Cross-Section Library
====================================================
.. only:: html
.. notebook:: mgxs-part-iv.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/pythonapi/index.rst
View file

@ -6,12 +6,13 @@ 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
example Jupyter_ notebooks provided. However, this assumes that you are already
familiar with Python and common third-party packages such as NumPy_. If you have
never programmed in Python before, there are many good tutorials available
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 provided in the :ref:`examples` section of the
documentation. However, this assumes that you are already familiar with Python
and common third-party packages such as NumPy_. If you have never programmed in
Python before, there are many good tutorials available 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.
------------------------------------
:mod:`openmc` -- Basic Functionality