Finalize example

ubcgif · Oct 6, 2020 · f0b0d93 · f0b0d93
1 parent 27036df
commit f0b0d93
Show file tree

Hide file tree

Showing 19 changed files with 16 additions and 17 deletions.
diff --git a/_ext/__pycache__/edit_on_github.cpython-38.pyc b/_ext/__pycache__/edit_on_github.cpython-38.pyc
diff --git a/conf.py b/conf.py
@@ -35,9 +35,7 @@
 extensions = [
     'sphinx.ext.mathjax',
     'sphinxcontrib.bibtex',
-    'edit_on_github',
-    'purpose',
-    'example'
+    'edit_on_github'
 ]
 
 # Number figures

diff --git a/content/elements.rst b/content/elements.rst
@@ -31,7 +31,6 @@ There are seven general files which are used in MAG3D. All are in ASCII text for
     Mesh <files/meshfile>
     Topography <files/topo>
     Observation/Location <files/magfile>
-    Model <files/model>
+    Model <files/modelfile>
     Weighting <files/weight>
-    Active model <files/model>
 
diff --git a/content/example/fwd.rst b/content/example/fwd.rst
@@ -1,19 +1,21 @@
 .. _example_fwd:
 
 
+.. note:: This example has been developed to demonstrate functionality specific to v6.0. The example can be completed using v5.0, however some functionality may not exist in v5.0 and the format of certain input files may differ slightly.
+
 Forward Modeling
 ================
 
-Here the code **gzfor3d.exe** is used to forward model the gravity anomaly for the mesh and density contrast model provided. We consider a ground-based survey with a uniform station spacing of 40 m.
+Here the code **magfor3d_v60.exe** is used to forward model the magnetic anomaly for the mesh and susceptibility model provided. We consider an airborne survey with a uniform station spacing of 40 m and a flight height of 30 m. The inclination, declination and background field intensity are 60 degrees, 25 degrees and 50,000 nT, respectively.
 
 Files relevant to this part of the example are in the sub-folder *fwd*. We used the same model that was created in the :ref:`create model <example_model>` section. Before running this example, you may want to do the following:
 
-	- `Download and open the zip folder containing the entire grav3d example <https://github.com/ubcgif/grav3d/raw/master/assets/grav3d_example.zip>`__ (if not done already)
-	- Learn how to run :ref:`gzfor3d<gzfor3d>`
+	- `Download and open the zip folder containing the entire mag3d example <https://github.com/ubcgif/mag3d/raw/master/assets/mag3d_example.zip>`__ (if not done already)
+	- Learn how to run :ref:`magfor3d_v60 <magfor3d>`
 	- There is no input file
 
 
-The resulting gravity anomaly (mgal) is shown below. According to the convention used by *grav3d*, a positive density contrast results in a positive gravity anomaly.
+The total magnetic intensity anomaly (nT) is shown below.
 
 
 .. figure:: images/fwd_anomaly.png

diff --git a/content/example/images/distance_weights.png b/content/example/images/distance_weights.png
diff --git a/content/example/images/fwd_anomaly.png b/content/example/images/fwd_anomaly.png
diff --git a/content/example/images/inv_L2_input.png b/content/example/images/inv_L2_input.png
diff --git a/content/example/images/inv_sparse_input.png b/content/example/images/inv_sparse_input.png
diff --git a/content/example/images/model_L2.png b/content/example/images/model_L2.png
diff --git a/content/example/images/model_input.png b/content/example/images/model_input.png
diff --git a/content/example/images/model_sparse.png b/content/example/images/model_sparse.png
diff --git a/content/example/images/pfweight_input.png b/content/example/images/pfweight_input.png
diff --git a/content/example/images/sensitivity_L2_input.png b/content/example/images/sensitivity_L2_input.png
diff --git a/content/example/images/sensitivity_sparse_input.png b/content/example/images/sensitivity_sparse_input.png
diff --git a/content/example/images/true_model.png b/content/example/images/true_model.png
diff --git a/content/example/inv.rst b/content/example/inv.rst
@@ -5,16 +5,16 @@
 Inversion
 =========
 
-Here the code **gzinv3d_v60.exe** invert synthetic gravity anomaly data to recover a density contrast model. We perform both a smooth and a sparse inversion. We use the same data that were computed in :ref:`forward modeling example <example_fwd>`. Gaussian noise were added to these data with a standard deviation of 5e-4 mgal. Uncertainties of 5e-4 mgal were assigned to all data
+Here the code **maginv3d_v60.exe** invert synthetic magntic data to recover a susceptibility model. We perform both a smooth and a sparse inversion. We use the same data that were computed in :ref:`forward modeling example <example_fwd>`. Gaussian noise were added to these data with a standard deviation of 0.5 nT. Uncertainties of 0.5 nT were assigned to all data
 
 Before running this example, you may want to do the following:
 
-     - `Download and open the zip folder containing the entire grav3d example <https://github.com/ubcgif/grav3d/raw/master/assets/grav3d_example.zip>`__ (if not done already)
-     - Learn how to :ref:`run gzinv3d_v60 and learn the format of the input files <gzinv3d>`
+     - `Download and open the zip folder containing the entire mag3d example <https://github.com/ubcgif/mag3d/raw/master/assets/mag3d_example.zip>`__ (if not done already)
+     - Learn how to :ref:`run maginv3d_v60 and learn the format of the input files <maginv3d>`
 
 
 
-.. important:: Since the sensitivities output by **gzsen3d_v60.exe** produce a large file, we have not provided them in the zip file. You need to complete the :ref:`compute sensitivities <example_sensitivity>` example to run the inversion.
+.. important:: Since the sensitivities output by **magsen3d_v60.exe** produce a large file, we have not provided them in the zip file. You need to complete the :ref:`compute sensitivities <example_sensitivity>` example to run the inversion.
 
 
 Smooth Inversion

diff --git a/content/example/sensitivity.rst b/content/example/sensitivity.rst
@@ -6,12 +6,12 @@
 Computing Sensitivities
 =======================
 
-Here the code **gzsen3d_v60.exe** is used to compute and output the sensitivities for use in the inversion. Here, we generate we use the input file **sensitivity_L2.inp** to generate sensitivities for a standard smooth inversion. We then use the input file **sensitivity_sparse.inp** to generate sensitivities that can be used for sparse inversion.
+Here the code **magsen3d_v60.exe** is used to compute and output the sensitivities for use in the inversion. Here, we generate we use the input file **sensitivity_L2.inp** to generate sensitivities for a standard smooth inversion. We then use the input file **sensitivity_sparse.inp** to generate sensitivities that can be used for sparse inversion.
 
 Before running this example, you may want to do the following:
 
-	- `Download and open the zip folder containing the entire grav3d example <https://github.com/ubcgif/grav3d/raw/master/assets/grav3d_example.zip>`__ (if not done already)
-	- Learn how to :ref:`compute sensitivities and learn the format of the input files <gzsen3d>`
+	- `Download and open the zip folder containing the entire mag3d example <https://github.com/ubcgif/mag3d/raw/master/assets/mag3d_example.zip>`__ (if not done already)
+	- Learn how to :ref:`compute sensitivities and learn the format of the input files <magsen3d>`
 
 
 Smooth Inversion

diff --git a/content/example/weights.rst b/content/example/weights.rst
@@ -6,7 +6,7 @@ Depth/Distance Weighting
 
 Here the code **pfweight.exe** and the input file **pfweight.inp** is used to generate distance weighting for the inversion. Files relevant to this part of the example are in the sub-folder *pfweights*. Before running this example, you may want to do the following:
 
-	- `Download and open the zip folder containing the entire grav3d example <https://github.com/ubcgif/grav3d/raw/master/assets/grav3d_example.zip>`__ (if not done already)
+	- `Download and open the zip folder containing the entire mag3d example <https://github.com/ubcgif/mag3d/raw/master/assets/mag3d_example.zip>`__ (if not done already)
 	- Learn how to :ref:`run pfweight and learn the format of the input files <pfweight>`
 
 

diff --git a/content/files/model.rst → content/files/modelfile.rst b/content/files/model.rst → content/files/modelfile.rst