oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#2472: integrating jupyter notebooks into documentation

Browse Source
This commit is contained in:
Czar Echavez
2024-05-09 13:43:55 +01:00
parent d02b7744ae
commit 81c523dc67
8 changed files with 94 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/example_notebooks.rst
View File

@@ -5,9 +5,14 @@
Example Jupyter Notebooks
=========================
Executed Notebooks
------------------
There are a few example notebooks included which help with the understanding of PrimAITE's capabilities.
The Jupyter Notebooks can be run via the 2 examples below. These assume that the instructions to install PrimAITE from the :ref:`Getting Started <getting-started>` page is completed as a prerequisite.
The PrimAITE documentation includes a pre executed example of notebooks. See :ref:`Executed Notebooks`.
The Jupyter notebooks can also be run interactively via the 2 examples below. These assume that the instructions to install PrimAITE from the :ref:`Getting Started <getting-started>` page is completed as a prerequisite.
Running Jupyter Notebooks
-------------------------