Document adaptive localization

equinor · Dec 1, 2023 · b1c21b7 · b1c21b7
1 parent 70d07bf
commit b1c21b7
Show file tree

Hide file tree

Showing 6 changed files with 294 additions and 1 deletion.
diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
@@ -166,8 +166,12 @@ jobs:
 
     - name: Install PlantUML
       run: |
-        sudo apt-get install plantuml
+        sudo apt install plantuml
 
+    - name: Install pandoc 
+      run: |
+        sudo apt install pandoc
+      
     - uses: actions/setup-python@v4
       id: setup_python
       with:

diff --git a/docs/conf.py b/docs/conf.py
@@ -57,6 +57,7 @@
     "sphinxcontrib.datatemplates",
     "sphinxcontrib.plantuml",
     "ert_jobs",
+    "nbsphinx",
 ]
 
 # Autodoc settings:

diff --git a/docs/getting_started/howto/adaptive_localization.ipynb b/docs/getting_started/howto/adaptive_localization.ipynb
diff --git a/docs/getting_started/howto/ert_screenshot_adaptive_loc.png b/docs/getting_started/howto/ert_screenshot_adaptive_loc.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -27,6 +27,7 @@ To understand the theoretical foundations of ensemble-based methods, head over t
    getting_started/setup
    getting_started/configuration/poly_new/guide
    getting_started/howto/esmda_restart
+   getting_started/howto/adaptive_localization.ipynb
    getting_started/howto/plugin_system
    getting_started/webviz-ert/webviz-ert
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -116,6 +116,9 @@ dev = [
     "sphinx-copybutton",
     "sphinxcontrib-plantuml",
     "sphinxcontrib.datatemplates",
+    "seaborn",
+    "nbsphinx",
+    "jupyter",
     "testpath",
 ]
 style = [