Restructure file tree of notebooks

myst.yml

@@ -73,48 +73,48 @@ project:
 
   toc:
     - file: index.md
-    - file: notebooks/gravity_index.md
+    - file: notebooks/gravity/index.md
       children:
-      - file: notebooks/03-gravity/fwd_gravity_anomaly_3d.ipynb
-      - file: notebooks/03-gravity/fwd_gravity_gradiometry_3d.ipynb
-      - file: notebooks/03-gravity/inv_gravity_anomaly_3d.ipynb
-      - file: notebooks/03-gravity/weighting_strategies.ipynb
-    - file: notebooks/magnetics_index.md
+      - file: notebooks/gravity/fwd_gravity_anomaly_3d.ipynb
+      - file: notebooks/gravity/fwd_gravity_gradiometry_3d.ipynb
+      - file: notebooks/gravity/inv_gravity_anomaly_3d.ipynb
+      - file: notebooks/gravity/weighting_strategies.ipynb
+    - file: notebooks/magnetics/index.md
       children:
-      - file: notebooks/04-magnetics/fwd_magnetics_induced_3d.ipynb
-      - file: notebooks/04-magnetics/fwd_magnetics_mvi_3d.ipynb
-      - file: notebooks/04-magnetics/inv_magnetics_induced_3d.ipynb
-    - file: notebooks/dcr_index.md
+      - file: notebooks/magnetics/fwd_magnetics_induced_3d.ipynb
+      - file: notebooks/magnetics/fwd_magnetics_mvi_3d.ipynb
+      - file: notebooks/magnetics/inv_magnetics_induced_3d.ipynb
+    - file: notebooks/dc-resistivity/index.md
       children:
-      - file: notebooks/05-dcr/fwd_dcr_1d.ipynb
-      - file: notebooks/05-dcr/fwd_dcr_2d.ipynb
-      - file: notebooks/05-dcr/fwd_dcr_3d.ipynb
-      - file: notebooks/05-dcr/inv_dcr_1d.ipynb
-      - file: notebooks/05-dcr/inv_dcr_2d.ipynb
-      - file: notebooks/05-dcr/inv_dcr_3d.ipynb
-    - file: notebooks/ip_index.md
+      - file: notebooks/dc-resistivity/fwd_dcr_1d.ipynb
+      - file: notebooks/dc-resistivity/fwd_dcr_2d.ipynb
+      - file: notebooks/dc-resistivity/fwd_dcr_3d.ipynb
+      - file: notebooks/dc-resistivity/inv_dcr_1d.ipynb
+      - file: notebooks/dc-resistivity/inv_dcr_2d.ipynb
+      - file: notebooks/dc-resistivity/inv_dcr_3d.ipynb
+    - file: notebooks/induced-polarization/index.md
       children:
-      - file: notebooks/06-ip/fwd_ip_2d.ipynb
-      - file: notebooks/06-ip/fwd_ip_3d.ipynb
-      - file: notebooks/06-ip/inv_ip_2d.ipynb
-      - file: notebooks/06-ip/inv_ip_3d.ipynb
-    - file: notebooks/fdem_index.md
+      - file: notebooks/induced-polarization/fwd_ip_2d.ipynb
+      - file: notebooks/induced-polarization/fwd_ip_3d.ipynb
+      - file: notebooks/induced-polarization/inv_ip_2d.ipynb
+      - file: notebooks/induced-polarization/inv_ip_3d.ipynb
+    - file: notebooks/frequency-domain-em/index.md
       children:
-      - file: notebooks/07-fdem/fwd_fdem_1d.ipynb
-      - file: notebooks/07-fdem/inv_fdem_1d.ipynb
-    - file: notebooks/tdem_index.md
+      - file: notebooks/frequency-domain-em/fwd_fdem_1d.ipynb
+      - file: notebooks/frequency-domain-em/inv_fdem_1d.ipynb
+    - file: notebooks/time-domain-em/index.md
       children:
-      - file: notebooks/08-tdem/fwd_tdem_1d.ipynb
-      - file: notebooks/08-tdem/fwd_tdem_fundamentals.ipynb
-      - file: notebooks/08-tdem/fwd_utem_3d.ipynb
-      - file: notebooks/08-tdem/inv_tdem_1d.ipynb
+      - file: notebooks/time-domain-em/fwd_tdem_1d.ipynb
+      - file: notebooks/time-domain-em/fwd_tdem_fundamentals.ipynb
+      - file: notebooks/time-domain-em/fwd_utem_3d.ipynb
+      - file: notebooks/time-domain-em/inv_tdem_1d.ipynb
     - title: Joint Inversion
       children:
-        - file: notebooks/11-joint-inversion/plot_inv_3_cross_gradient_pf.ipynb
+        - file: notebooks/joint-inversion/plot_inv_3_cross_gradient_pf.ipynb
     - title: PGI Inversion
       children:
-        - file: notebooks/12-pgi-inversion/plot_inv_1_joint_pf_pgi_full_info_tutorial.ipynb
-        - file: notebooks/12-pgi-inversion/plot_inv_2_joint_pf_pgi_no_info_tutorial.ipynb
+        - file: notebooks/pgi/plot_inv_1_joint_pf_pgi_full_info_tutorial.ipynb
+        - file: notebooks/pgi/plot_inv_2_joint_pf_pgi_no_info_tutorial.ipynb
 
 site:
   template: book-theme

notebooks/dc-resistivity/index.md

@@ -0,0 +1,33 @@
+Direct Current Resistivity
+======================
+
+Direct current resistivity data are simulated using functionality within the ``SimPEG.electromagnetics.static.resistivity`` module. Here, we provide a multitude of introductory and indermediate level tutorials for forward simulation and inversion of direct current resistivity data. Links to each tutorial can be accessed below or from the left-side menu.
+
+```{figure} ../../assets/website_images/dcip_physics.png
+:width: 800px
+:align: center
+
+Schematic illustrating the physics of the DC/IP method ([image source](https://em.geosci.xyz/content/geophysical_surveys/ip/physics.html))
+```
+
+## Tutorial Notebooks
+
+
+[1D Forward Simulation for a Single Sounding](dc-resistivity/fwd_dcr_1d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
+<br />
+
+[2.5D Forward Simulation](dc-resistivity/fwd_dcr_2d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
+<br />
+
+[3D Forward Simulation](dc-resistivity/fwd_dcr_3d) $({\color{orange}Intermediate}$, ${\color{orange}Moderate})$
+<br />
+
+[1D Inversion for a Single Sounding](dc-resistivity/inv_dcr_1d) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
+<br />
+
+[2.5D DC Resistivity Inversion](dc-resistivity/inv_dcr_2d) $({\color{orange}Intermediate}$, ${\color{orange}Moderate})$
+<br />
+
+[3D DC Resistivity Inversion](dc-resistivity/inv_dcr_3d) $({\color{orange}Intermediate}$, ${\color{orange}Moderate})$
+<br />
+

notebooks/05-dcr/inv_dcr_1d.ipynb → notebooks/dc-resistivity/inv_dcr_1d.ipynb

@@ -135,22 +135,22 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "overwriting /home/ssoler/git/user-tutorials/notebooks/05-dcr/inv_dcr_1d_files.tar.gz\n",
-      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/05-dcr/inv_dcr_1d_files.tar.gz\n"
+      "overwriting /home/ssoler/git/user-tutorials/notebooks/dc-resistivity/inv_dcr_1d_files.tar.gz\n",
+      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/dc-resistivity/inv_dcr_1d_files.tar.gz\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "   saved to: /home/ssoler/git/user-tutorials/notebooks/05-dcr/inv_dcr_1d_files.tar.gz\n",
+      "   saved to: /home/ssoler/git/user-tutorials/notebooks/dc-resistivity/inv_dcr_1d_files.tar.gz\n",
       "Download completed!\n"
      ]
     }
    ],
    "source": [
     "# URL to download from repository assets\n",
-    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/05-dcr/inv_dcr_1d_files.tar.gz\"\n",
+    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/dc-resistivity/inv_dcr_1d_files.tar.gz\"\n",
     "\n",
     "# download the data\n",
     "downloaded_data = download(data_source, overwrite=True)\n",

notebooks/05-dcr/inv_dcr_2d.ipynb → notebooks/dc-resistivity/inv_dcr_2d.ipynb

@@ -146,22 +146,22 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "overwriting /home/ssoler/git/user-tutorials/notebooks/05-dcr/inv_dcr_2d_files.tar.gz\n",
-      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/05-dcr/inv_dcr_2d_files.tar.gz\n"
+      "overwriting /home/ssoler/git/user-tutorials/notebooks/dc-resistivity/inv_dcr_2d_files.tar.gz\n",
+      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/dc-resistivity/inv_dcr_2d_files.tar.gz\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "   saved to: /home/ssoler/git/user-tutorials/notebooks/05-dcr/inv_dcr_2d_files.tar.gz\n",
+      "   saved to: /home/ssoler/git/user-tutorials/notebooks/dc-resistivity/inv_dcr_2d_files.tar.gz\n",
       "Download completed!\n"
      ]
     }
    ],
    "source": [
     "# URL to download from repository assets\n",
-    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/05-dcr/inv_dcr_2d_files.tar.gz\"\n",
+    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/dc-resistivity/inv_dcr_2d_files.tar.gz\"\n",
     "\n",
     "# download the data\n",
     "downloaded_data = download(data_source, overwrite=True)\n",

notebooks/05-dcr/inv_dcr_3d.ipynb → notebooks/dc-resistivity/inv_dcr_3d.ipynb

@@ -143,22 +143,22 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "overwriting /home/ssoler/git/user-tutorials/notebooks/05-dcr/inv_dcr_3d_files.tar.gz\n",
-      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/05-dcr/inv_dcr_3d_files.tar.gz\n"
+      "overwriting /home/ssoler/git/user-tutorials/notebooks/dc-resistivity/inv_dcr_3d_files.tar.gz\n",
+      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/dc-resistivity/inv_dcr_3d_files.tar.gz\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "   saved to: /home/ssoler/git/user-tutorials/notebooks/05-dcr/inv_dcr_3d_files.tar.gz\n",
+      "   saved to: /home/ssoler/git/user-tutorials/notebooks/dc-resistivity/inv_dcr_3d_files.tar.gz\n",
       "Download completed!\n"
      ]
     }
    ],
    "source": [
     "# URL to download from repository assets\n",
-    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/05-dcr/inv_dcr_3d_files.tar.gz\"\n",
+    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/dc-resistivity/inv_dcr_3d_files.tar.gz\"\n",
     "\n",
     "# download the data\n",
     "downloaded_data = download(data_source, overwrite=True)\n",

notebooks/fdem_index.md → notebooks/frequency-domain-em/index.md

@@ -4,7 +4,7 @@ Frequency-Domain Electromagnetics
 In this chapter, we publish code comparisons and validations for frequency-domain electromagnetic modeling packages.
 In SimPEG, the *SimPEG.electromagnetics.frequency_domain* module is used for modeling frequency-domain data.
 
-```{figure} ../assets/website_images/fem_physics.png
+```{figure} ../../assets/website_images/fem_physics.png
 :width: 800px
 :align: center
 
@@ -13,8 +13,8 @@ Schematic illustrating the physics of the FEM method for an inductive source.
 
 ## Tutorial Notebooks
 
-[1D Forward Simulation for a Single Sounding](07-fdem/fwd_fdem_1d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
+[1D Forward Simulation for a Single Sounding](frequency-domain-em/fwd_fdem_1d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
 <br />
 
-[1D Inversion for a Single Sounding](07-fdem/inv_fdem_1d) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
+[1D Inversion for a Single Sounding](frequency-domain-em/inv_fdem_1d) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
 <br />

notebooks/07-fdem/inv_fdem_1d.ipynb → notebooks/frequency-domain-em/inv_fdem_1d.ipynb

@@ -132,22 +132,22 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "overwriting /home/ssoler/git/user-tutorials/notebooks/07-fdem/inv_fdem_1d_files.tar.gz\n",
-      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/07-fdem/inv_fdem_1d_files.tar.gz\n"
+      "overwriting /home/ssoler/git/user-tutorials/notebooks/frequency-domain-em/inv_fdem_1d_files.tar.gz\n",
+      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/frequency-domain-em/inv_fdem_1d_files.tar.gz\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "   saved to: /home/ssoler/git/user-tutorials/notebooks/07-fdem/inv_fdem_1d_files.tar.gz\n",
+      "   saved to: /home/ssoler/git/user-tutorials/notebooks/frequency-domain-em/inv_fdem_1d_files.tar.gz\n",
       "Download completed!\n"
      ]
     }
    ],
    "source": [
     "# URL to assets\n",
-    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/07-fdem/inv_fdem_1d_files.tar.gz\"\n",
+    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/frequency-domain-em/inv_fdem_1d_files.tar.gz\"\n",
     "\n",
     "# download the data\n",
     "downloaded_data = download(data_source, overwrite=True)\n",

notebooks/gravity_index.md → notebooks/gravity/index.md

@@ -12,14 +12,14 @@ Earth's gravity anomalies ([image source](https://upload.wikimedia.org/wikipedia
 
 ## Tutorial Notebooks
 
-[3D Forward Simulation of Gravity Anomaly Data](03-gravity/fwd_gravity_anomaly_3d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
+[3D Forward Simulation of Gravity Anomaly Data](gravity/fwd_gravity_anomaly_3d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
 <br />
 
-[3D Forward Simulation of Gravity Gradiometry Data](03-gravity/fwd_gravity_gradiometry_3d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
+[3D Forward Simulation of Gravity Gradiometry Data](gravity/fwd_gravity_gradiometry_3d) $({\color{green}Introductory}$, ${\color{green}Lightweight})$
 <br />
 
-[3D Inversion of Gravity Anomaly Data](03-gravity/inv_gravity_anomaly_3d) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
+[3D Inversion of Gravity Anomaly Data](gravity/inv_gravity_anomaly_3d) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
 <br />
 
-[Compare weighting strategy with Inversion of surface Gravity Anomaly Data](03-gravity/weighting_strategies) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
+[Compare weighting strategy with Inversion of surface Gravity Anomaly Data](gravity/weighting_strategies) $({\color{orange}Intermediate}$, ${\color{green}Lightweight})$
 <br />

notebooks/03-gravity/inv_gravity_anomaly_3d.ipynb → notebooks/gravity/inv_gravity_anomaly_3d.ipynb

@@ -139,22 +139,22 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "overwriting /home/ssoler/git/user-tutorials/notebooks/03-gravity/inv_gravity_anomaly_3d_files.tar.gz\n",
-      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/03-gravity/inv_gravity_anomaly_3d_files.tar.gz\n"
+      "overwriting /home/ssoler/git/user-tutorials/notebooks/gravity/inv_gravity_anomaly_3d_files.tar.gz\n",
+      "Downloading https://github.com/simpeg/user-tutorials/raw/main/assets/gravity/inv_gravity_anomaly_3d_files.tar.gz\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "   saved to: /home/ssoler/git/user-tutorials/notebooks/03-gravity/inv_gravity_anomaly_3d_files.tar.gz\n",
+      "   saved to: /home/ssoler/git/user-tutorials/notebooks/gravity/inv_gravity_anomaly_3d_files.tar.gz\n",
       "Download completed!\n"
      ]
     }
    ],
    "source": [
     "# URL to download from repository assets\n",
-    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/03-gravity/inv_gravity_anomaly_3d_files.tar.gz\"\n",
+    "data_source = \"https://github.com/simpeg/user-tutorials/raw/main/assets/gravity/inv_gravity_anomaly_3d_files.tar.gz\"\n",
     "\n",
     "# download the data\n",
     "downloaded_data = download(data_source, overwrite=True)\n",

notebooks/03-gravity/weighting_strategies.ipynb → notebooks/gravity/weighting_strategies.ipynb

@@ -141,9 +141,9 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "overwriting /home/ssoler/git/user-tutorials/notebooks/03-gravity/gravity.tar.gz\n",
+      "overwriting /home/ssoler/git/user-tutorials/notebooks/gravity/gravity.tar.gz\n",
       "Downloading https://storage.googleapis.com/simpeg/doc-assets/gravity.tar.gz\n",
-      "   saved to: /home/ssoler/git/user-tutorials/notebooks/03-gravity/gravity.tar.gz\n",
+      "   saved to: /home/ssoler/git/user-tutorials/notebooks/gravity/gravity.tar.gz\n",
       "Download completed!\n"
      ]
     }