Add DC and IP docs.

This commit is contained in:
Rowan Cockett
2016-05-29 17:45:49 -07:00
parent 5e2a8232a3
commit 0b4215f33e
3 changed files with 32 additions and 9 deletions
+16 -9
View File
@@ -1,5 +1,3 @@
.. _api_DC:
.. math::
\renewcommand{\div}{\nabla\cdot\,}
@@ -38,8 +36,16 @@
\renewcommand {\u} { {\vec u} }
\newcommand{\I}{\vec{I}}
Direct Current Resistivity
**************************
`SimPEG.DCIP` uses SimPEG as the framework for the forward and inverse
direct current (DC) resistivity and induced polarization (IP) geophysical problems.
DC resistivity survey
*********************
=====================
Electrical resistivity of subsurface materials is measured by causing an electrical current to flow in the earth between one pair of electrodes while the voltage across a second pair of electrodes is measured. The result is an "apparent" resistivity which is a value representing the weighted average resistivity over a volume of the earth. Variations in this measurement are caused by variations in the soil, rock, and pore fluid electrical resistivity. Surveys require contact with the ground, so they can be labour intensive. Results are sometimes interpreted directly, but more commonly, 1D, 2D or 3D models are estimated using inversion procedures (`GPG <http://www.eos.ubc.ca/courses/eosc350/content/>`_).
@@ -55,7 +61,7 @@ As direct current (DC) implies, in DC resistivity survey, we assume steady-state
\curl \e = 0
Then by taking \\(\\curl\\) for the first equation, we have
Then by taking \\(\\div\\) of the first equation, we have
.. math::
@@ -137,13 +143,14 @@ Comparing to the analytic function:
.. plot::
import simpegDC as DC
DC.Examples.Verification.run(plotIt=True)
from SimPEG import Examples
Examples.DC_Analytic_Dipole.run(plotIt=True)
API
===
.. automodule:: simpegDC.BaseDC
API for DC codes
================
.. automodule:: SimPEG.DCIP.BaseDC
:show-inheritance:
:members:
:undoc-members:
+2
View File
@@ -59,6 +59,8 @@ Packages
:maxdepth: 3
em/index
dc/index
ip/index
mt/index
flow/index
+14
View File
@@ -0,0 +1,14 @@
Induced Polarization
********************
Todo: docs for IP!
API for IP codes
================
.. automodule:: SimPEG.DCIP.BaseIP
:show-inheritance:
:members:
:undoc-members:
:inherited-members: