Merge pull request #206 from simpeg/examples

Mag Dipole Analytic Wholespace Example

SimPEG/Examples/EM_FDEM_Analytic_MagDipoleWholespace.py

@@ -0,0 +1,43 @@
+from SimPEG import *
+import SimPEG.EM as EM
+
+def run(XYZ=None, sig=1.0, freq=1.0, orientation='Z', plotIt=True):
+    """
+        EM: Magnetic Dipole in a Whole-Space
+        ====================================
+
+        Here we plot the magnetic flux density from a harmonic dipole in a wholespace.
+
+    """
+
+    if XYZ is None:
+        x = np.arange(-100.5,100.5,step = 1.) #(avoid putting measurement points where source is located)
+        y = np.r_[0]
+        z = x
+        XYZ = Utils.ndgrid(x,y,z)
+
+
+    Bx, By, Bz = EM.Analytics.FDEM.MagneticDipoleWholeSpace(XYZ, np.r_[0.,0.,0.], sig, freq, orientation=orientation)
+    absB = np.sqrt(Bx*Bx.conj()+By*By.conj()+Bz*Bz.conj()).real
+
+
+    if plotIt:
+        import matplotlib.pyplot as plt
+        from matplotlib.colors import LogNorm
+        fig, ax = plt.subplots(1,1,figsize=(6,5))
+        bxplt = Bx.reshape(x.size,z.size)
+        bzplt = Bz.reshape(x.size,z.size)
+        pc = ax.pcolor(x,z,absB.reshape(x.size,z.size),norm=LogNorm())
+        ax.streamplot(x,z,bxplt.real,bzplt.real,color='k',density=1)
+        ax.set_xlim([x.min(),x.max()])
+        ax.set_ylim([z.min(),z.max()])
+        ax.set_xlabel('x')
+        ax.set_ylabel('z')
+        cb = plt.colorbar(pc,ax = ax)
+        cb.set_label('|B| (T)')
+        plt.show()
+
+        return fig, ax
+
+if __name__ == '__main__':
+    run()

SimPEG/Examples/__init__.py

@@ -1,6 +1,7 @@
 # Run this file to add imports.
 
 ##### AUTOIMPORTS #####
+import EM_FDEM_Analytic_MagDipoleWholespace
 import EM_TDEM_1D_Inversion
 import FLOW_Richards_1D_Celia1990
 import Forward_BasicDirectCurrent
@@ -13,7 +14,7 @@ import Mesh_QuadTree_FaceDiv
 import Mesh_QuadTree_HangingNodes
 import Mesh_Tensor_Creation
 
-__examples__ = ["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__ = ["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"]
 
 ##### AUTOIMPORTS #####
 
@@ -28,16 +29,17 @@ if __name__ == '__main__':
     from SimPEG import Examples
 
     # Create the examples dir in the docs folder.
-    docExamplesDir = os.path.sep.join(os.path.realpath(__file__).split(os.path.sep)[:-3] + ['docs', 'examples'])
+    fName = os.path.realpath(__file__)
+    docExamplesDir = os.path.sep.join(fName.split(os.path.sep)[:-3] + ['docs', 'examples'])
     shutil.rmtree(docExamplesDir)
     os.makedirs(docExamplesDir)
 
     # Get all the python examples in this folder
-    thispath = os.path.sep.join(__file__.split(os.path.sep)[:-1])
+    thispath = os.path.sep.join(fName.split(os.path.sep)[:-1])
     exfiles  = [f[:-3] for f in os.listdir(thispath) if os.path.isfile(os.path.join(thispath, f)) and f.endswith('.py') and not f.startswith('_')]
 
     # Add the imports to the top in the AUTOIMPORTS section
-    f = file(__file__, 'r')
+    f = file(fName, 'r')
     inimports = False
     out = ''
     for line in f:
@@ -52,7 +54,7 @@ if __name__ == '__main__':
                 out += '\n##### AUTOIMPORTS #####\n'
     f.close()
 
-    f = file(__file__, 'w')
+    f = file(fName, 'w')
     f.write(out)
     f.close()
 

docs/examples/EM_FDEM_Analytic_MagDipoleWholespace.rst

@@ -0,0 +1,26 @@
+.. _examples_EM_FDEM_Analytic_MagDipoleWholespace:
+
+.. --------------------------------- ..
+..                                   ..
+..    THIS FILE IS AUTO GENEREATED   ..
+..                                   ..
+..    SimPEG/Examples/__init__.py    ..
+..                                   ..
+.. --------------------------------- ..
+
+
+EM: Magnetic Dipole in a Whole-Space
+====================================
+
+Here we plot the magnetic flux density from a harmonic dipole in a wholespace.
+
+
+
+.. plot::
+
+    from SimPEG import Examples
+    Examples.EM_FDEM_Analytic_MagDipoleWholespace.run()
+
+.. literalinclude:: ../../SimPEG/Examples/EM_FDEM_Analytic_MagDipoleWholespace.py
+    :language: python
+    :linenos: