consistent file name

SimPEG/Examples/EM_FDEM_SusEffects.py

@@ -5,7 +5,7 @@ from scipy.constants import mu_0
 
 def run(plotIt=True):
     """
-        FDEM: Effects of susceptibility
+        EM: FDEM: Effects of susceptibility
         ===============================
 
         When airborne freqeuncy domain EM (AFEM) survey is flown over
@@ -138,8 +138,9 @@ def run(plotIt=True):
                 axtemp.set_xlim(10, 100.)
                 axtemp.set_title(titles[i])
             plt.show()
-        vizfields(1, primsec="primary", realimag="real")
-        vizfields(1, primsec="secondary", realimag="real")
+            return fig, ax
+        fig1, ax1 = vizfields(1, primsec="primary", realimag="real")
+        fig2, ax2 = vizfields(1, primsec="secondary", realimag="real")
 
 if __name__ == '__main__':
     run()

SimPEG/Examples/__init__.py

@@ -1,9 +1,10 @@
 # Run this file to add imports.
 
 ##### AUTOIMPORTS #####
-import EM_FDEM_SusEffects
 import DC_PseudoSection_Simulation
+import EM_FDEM_1D_Inversion
 import EM_FDEM_Analytic_MagDipoleWholespace
+import EM_FDEM_SusEffects
 import EM_TDEM_1D_Inversion
 import FLOW_Richards_1D_Celia1990
 import Forward_BasicDirectCurrent
@@ -16,8 +17,7 @@ import Mesh_QuadTree_FaceDiv
 import Mesh_QuadTree_HangingNodes
 import Mesh_Tensor_Creation
 
-
-__examples__ = ["EM_FDEM_SusEffects","DC_PseudoSection_Simulation", "EM_FDEM_Analytic_MagDipoleWholespace", "EM_TDEM_1D_Inversion", "FLOW_Richards_1D_Celia1990", "Forward_BasicDirectCurrent", "Inversion_Linear", "Mesh_Basic_PlotImage", "Mesh_Basic_Types", "Mesh_Operators_CahnHilliard", "Mesh_QuadTree_Creation", "Mesh_QuadTree_FaceDiv", "Mesh_QuadTree_HangingNodes", "Mesh_Tensor_Creation"]
+__examples__ = ["DC_PseudoSection_Simulation", "EM_FDEM_1D_Inversion", "EM_FDEM_Analytic_MagDipoleWholespace", "EM_FDEM_SusEffects", "EM_TDEM_1D_Inversion", "FLOW_Richards_1D_Celia1990", "Forward_BasicDirectCurrent", "Inversion_Linear", "Mesh_Basic_PlotImage", "Mesh_Basic_Types", "Mesh_Operators_CahnHilliard", "Mesh_QuadTree_Creation", "Mesh_QuadTree_FaceDiv", "Mesh_QuadTree_HangingNodes", "Mesh_Tensor_Creation"]
 
 ##### AUTOIMPORTS #####
 

docs/examples/EM_FDEM_1D_Inversion.rst

@@ -1,26 +0,0 @@
-.. _examples_EM_FDEM_1D_Inversion:
-
-.. --------------------------------- ..
-..                                   ..
-..    THIS FILE IS AUTO GENEREATED   ..
-..                                   ..
-..    SimPEG/Examples/__init__.py    ..
-..                                   ..
-.. --------------------------------- ..
-
-
-EM: FDEM: 1D: Inversion
-=======================
-
-Here we will create and run a FDEM 1D inversion.
-
-
-
-.. plot::
-
-    from SimPEG import Examples
-    Examples.EM_FDEM_1D_Inversion.run()
-
-.. literalinclude:: ../../SimPEG/Examples/EM_FDEM_1D_Inversion.py
-    :language: python
-    :linenos:

docs/examples/EM_FDEM_SusEffects.rst

@@ -0,0 +1,41 @@
+.. _examples_EM_FDEM_SusEffects:
+
+.. --------------------------------- ..
+..                                   ..
+..    THIS FILE IS AUTO GENEREATED   ..
+..                                   ..
+..    SimPEG/Examples/__init__.py    ..
+..                                   ..
+.. --------------------------------- ..
+
+
+FDEM: Effects of susceptibility
+===============================
+
+When airborne freqeuncy domain EM (AFEM) survey is flown over
+the earth including significantly susceptible bodies (magnetite-rich rocks),
+negative data is often observed in the real part of the lowest frequency
+(e.g. Dighem system 900 Hz). This phenomenon mostly based upon magnetization
+occurs due to a susceptible body when the magnetic field applied.
+
+To clarify what is happening in the earth when we are exciting the earth with
+a loop source in the frequency domain we run three forward modelling:
+
+    - F[:math:`\sigma`, :math:`\mu`]: Anomalous conductivity and susceptibility
+    - F[:math:`\sigma`, :math:`\mu_0`]: Anomalous conductivity
+    - F[:math:`\sigma_{air}`, :math:`\mu_0`]: primary field
+
+We plot vector magnetic fields in the earth. For secondary fields we provide
+F[:math:`\sigma`, :math:`\mu`]-F[:math:`\sigma`, :math:`\mu_0`]. Following
+figure show only real part, since that is our interest.
+
+
+
+.. plot::
+
+    from SimPEG import Examples
+    Examples.EM_FDEM_SusEffects.run()
+
+.. literalinclude:: ../../SimPEG/Examples/EM_FDEM_SusEffects.py
+    :language: python
+    :linenos: