Add Tutorials

Author: patnr

docs/javascripts/extra.js

@@ -7,3 +7,12 @@ document.addEventListener("DOMContentLoaded", function() {
     document.body.classList.add('document-is-notebook');
   }
 });
+
+// Using the document$ observable from mkdocs-material to get notified of page "reload" also if using `navigation.instant` (SSA)
+// https://github.com/danielfrg/mkdocs-jupyter/issues/99#issuecomment-2455307893
+document$.subscribe(function() {
+  // First check if the page contains a notebook-related class
+  if (document.querySelector('.jp-Notebook')) {
+    document.querySelector("div.md-sidebar.md-sidebar--primary").remove();
+  }
+});

docs/tutorials/README.md

@@ -0,0 +1,6 @@
+# Examples
+
+Here are some tutorials.
+
+- [`tutorial_pipt.ipynb`](pipt/tutorial_pipt): Tutorial for running PIPT
+- [`tutorial_pipt.ipynb`](popt/tutorial_popt): Tutorial for running POPT

docs/tutorials/pipt/tutorial_pipt.ipynb

@@ -8,7 +8,7 @@
     "\n",
     "<font size=4em>As an illustrative example we choose a small 3D-field with three producers and three (water) injectors. The figure below shows the true (data generating) permeability field and the well positions. The grid is 10x10x2, and the porosity is 0.2. The inverse problem is to find the permeability for the reservoir by assimilation produced water and oil and injected water. \n",
     "\n",
-    "<img src=\"./permx.png?lastmod=12345678\" alt=\"drawing\" width=\"500\"/>\n",
+    "<img src=\"../permx.png?lastmod=12345678\" alt=\"drawing\" width=\"500\"/>\n",
     "<br>\n",
     "<font size=4em>The first step is to load neccessary external and local modules. "
    ]

docs/tutorials/popt/tutorial_popt.ipynb

@@ -8,7 +8,7 @@
     "\n",
     "<font size=4em>As an illustrative example we choose a 2D-field with one producer and two (water) injectors. The figure below shows the permeability field and the well positions. The grid is 100x100, and the porosity is 0.18. The optimization problem is to find the pressure control for the wells in order to maximize net present value. \n",
     "\n",
-    "<img src=\"permx.png\" alt=\"drawing\" width=\"500\"/>\n",
+    "<img src=\"../permx.png\" alt=\"drawing\" width=\"500\"/>\n",
     "    \n",
     "<br>\n",
     "<font size=4em>The first step is to load neccessary external and local modules. "

mkdocs.yml

@@ -10,7 +10,7 @@ watch: [.]
 nav:
   - Home: index.md
   - Reference: reference/
-  # - Examples: examples/
+  - Tutorials: tutorials/
   # - Bibliography: references.md
   - dev_guide.md
 
@@ -64,11 +64,13 @@ plugins:
   - search
   - autorefs # enable anchor/heading links without specifying its page
   # - meta # [insiders only] enable front-matter defaults as in Jekyll
-  # - mkdocs-jupyter:
-  #     include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"]
-  #     ignore:
-  #       - ".ipynb_checkpoints/*"
-  #     execute: false
+  - mkdocs-jupyter:
+      include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"]
+      ignore:
+        - ".ipynb_checkpoints/*"
+      # show_input: False
+      # no_input: True
+      execute: false
   # - bibtex:
   #     # NB: does not work with mkdocstrings (https://github.com/shyamd/mkdocs-bibtex/issues/246)
   #     # PS: requires pandoc installed on system and markdown_extensions: footnotes