docs updates and notation changes

SimPEG/Mesh/InnerProducts.py

@@ -22,25 +22,25 @@ class InnerProducts(object):
         V = sp.kron(sp.identity(d), sdiag(np.sqrt((2**(-d))*self.vol)))
 
         if d == 1:
-            Px = _getFacePx(self)
-            P000 = V*Px('fXm')
-            P100 = V*Px('fXp')
+            fP = _getFacePx(self)
+            P000 = V*fP('fXm')
+            P100 = V*fP('fXp')
         elif d == 2:
-            Pxx = _getFacePxx(self)
-            P000 = V*Pxx('fXm', 'fYm')
-            P100 = V*Pxx('fXp', 'fYm')
-            P010 = V*Pxx('fXm', 'fYp')
-            P110 = V*Pxx('fXp', 'fYp')
+            fP = _getFacePxx(self)
+            P000 = V*fP('fXm', 'fYm')
+            P100 = V*fP('fXp', 'fYm')
+            P010 = V*fP('fXm', 'fYp')
+            P110 = V*fP('fXp', 'fYp')
         elif d == 3:
-            Pxxx = _getFacePxxx(self)
-            P000 = V*Pxxx('fXm', 'fYm', 'fZm')
-            P100 = V*Pxxx('fXp', 'fYm', 'fZm')
-            P010 = V*Pxxx('fXm', 'fYp', 'fZm')
-            P110 = V*Pxxx('fXp', 'fYp', 'fZm')
-            P001 = V*Pxxx('fXm', 'fYm', 'fZp')
-            P101 = V*Pxxx('fXp', 'fYm', 'fZp')
-            P011 = V*Pxxx('fXm', 'fYp', 'fZp')
-            P111 = V*Pxxx('fXp', 'fYp', 'fZp')
+            fP = _getFacePxxx(self)
+            P000 = V*fP('fXm', 'fYm', 'fZm')
+            P100 = V*fP('fXp', 'fYm', 'fZm')
+            P010 = V*fP('fXm', 'fYp', 'fZm')
+            P110 = V*fP('fXp', 'fYp', 'fZm')
+            P001 = V*fP('fXm', 'fYm', 'fZp')
+            P101 = V*fP('fXp', 'fYm', 'fZp')
+            P011 = V*fP('fXm', 'fYp', 'fZp')
+            P111 = V*fP('fXp', 'fYp', 'fZp')
 
         Mu = makePropertyTensor(self, materialProperty)
         A = P000.T*Mu*P000 + P100.T*Mu*P100
@@ -70,7 +70,6 @@ class InnerProducts(object):
 
         if d == 1:
             raise NotImplementedError('getEdgeInnerProduct not implemented for 1D')
-        # We will multiply by V on each side to keep symmetry
         elif d == 2:
             eP = _getEdgePxx(self)
             P000 = V*eP('eX0', 'eY0')

docs/api_DiffOps.rst

@@ -0,0 +1,8 @@
+.. _api_DiffOps:
+
+Differential Operators
+======================
+
+.. automodule:: SimPEG.Mesh.DiffOperators
+    :members:
+    :undoc-members:

docs/api_Mesh.rst

@@ -8,13 +8,13 @@ Tensor Mesh
     :show-inheritance:
     :members:
     :undoc-members:
-    :inherited-members:
 
 
 Cylindrical 1D Mesh
 ===================
 
 .. automodule:: SimPEG.Mesh.Cyl1DMesh
+    :show-inheritance:
     :members:
     :undoc-members:
 
@@ -26,7 +26,6 @@ Logically Orthogonal Mesh
     :show-inheritance:
     :members:
     :undoc-members:
-    :inherited-members:
 
 
 Base Mesh
@@ -37,9 +36,3 @@ Base Mesh
     :undoc-members:
 
 
-Differential Operators
-======================
-
-.. automodule:: SimPEG.Mesh.DiffOperators
-    :members:
-    :undoc-members:

docs/api_Solver.rst

@@ -0,0 +1,10 @@
+.. _api_Solver:
+
+
+Solver
+******
+
+.. automodule:: SimPEG.Solver
+    :members:
+    :undoc-members:
+

docs/api_Utils.rst

@@ -1,14 +1,6 @@
 .. _api_Utils:
 
 
-Solver
-******
-
-.. automodule:: SimPEG.Solver
-    :members:
-    :undoc-members:
-
-
 Utilities
 *********
 

docs/index.rst

@@ -11,12 +11,10 @@ The vision is to create a package for finite volume simulation and parameter est
 applications to geophysical imaging and subsurface flow. To enable
 these goals, this package has the following features:
 
-
-   * is modular with respect to discretization, physics, optimization, and regularization
-   * is built with the (large-scale) inverse problem in mind
-   * provides a framework for geophysical and hydrogeologic problems
-   * supports 1D, 2D and 3D problems
-
+- is modular with respect to discretization, physics, optimization, and regularization
+- is built with the (large-scale) inverse problem in mind
+- provides a framework for geophysical and hydrogeologic problems
+- supports 1D, 2D and 3D problems
 
 .. image:: simpeg-framework.png
    :width: 400 px
@@ -30,6 +28,7 @@ Meshing & Operators
    :maxdepth: 2
 
    api_Mesh
+   api_DiffOps
    api_InnerProducts
 
 Forward Problems
@@ -49,6 +48,16 @@ Inversion
    api_Inverse
    api_Parameters
 
+Utility Codes
+*************
+
+.. toctree::
+   :maxdepth: 2
+
+   api_Solver
+   api_Utils
+
+
 Testing SimPEG
 **************
 
@@ -63,21 +72,6 @@ Testing SimPEG
       :alt: Master Branch
       :align: center
 
-* Develop Branch
-   .. image:: https://travis-ci.org/simpeg/simpeg.png?branch*develop
-      :target: https://travis-ci.org/simpeg/simpeg
-      :alt: Develop Branch
-      :align: center
-
-
-Utility Codes
-*************
-
-.. toctree::
-   :maxdepth: 2
-
-   api_Utils
-
 
 Project Index & Search
 **********************