From 0b4215f33e10d25d8ca6134ee4ca026cd16f5c96 Mon Sep 17 00:00:00 2001
From: Rowan Cockett <rowan@3ptscience.com>
Date: Sun, 29 May 2016 17:45:49 -0700
Subject: [PATCH] Add DC and IP docs.

---
 docs/{api_DC.rst => dc/index.rst} | 25 ++++++++++++++++---------
 docs/index.rst                    |  2 ++
 docs/ip/index.rst                 | 14 ++++++++++++++
 3 files changed, 32 insertions(+), 9 deletions(-)
 rename docs/{api_DC.rst => dc/index.rst} (89%)
 create mode 100644 docs/ip/index.rst

diff --git a/docs/api_DC.rst b/docs/dc/index.rst
similarity index 89%
rename from docs/api_DC.rst
rename to docs/dc/index.rst
index f6c98d09..27ec89bd 100644
--- a/docs/api_DC.rst
+++ b/docs/dc/index.rst
@@ -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:
diff --git a/docs/index.rst b/docs/index.rst
index 1293c21a..8b27ee1b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -59,6 +59,8 @@ Packages
    :maxdepth: 3
 
    em/index
+   dc/index
+   ip/index
    mt/index
    flow/index
 
diff --git a/docs/ip/index.rst b/docs/ip/index.rst
new file mode 100644
index 00000000..68def737
--- /dev/null
+++ b/docs/ip/index.rst
@@ -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: