wassname/simpeg
1
0
Fork 0
mirror of https://github.com/wassname/simpeg.git synced 2026-09-12 12:51:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean Up Documentation

Browse Source
This commit is contained in:
rowanc1
2014-01-19 13:39:50 -07:00
parent 583f3ed8d0
commit 25d79d3636
27 changed files with 109 additions and 4216 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api_BaseMesh.rst
+1 -1
View File
@@ -3,6 +3,6 @@
Base Mesh
*********
.. automodule:: SimPEG.mesh.BaseMesh
.. automodule:: SimPEG.Mesh.BaseMesh
:members:
:undoc-members:
docs/api_Cyl1DMesh.rst
+2 -2
View File
@@ -3,6 +3,6 @@
Cylindrical 1D Mesh
*******************
.. automodule:: SimPEG.mesh.Cyl1DMesh
.. automodule:: SimPEG.Mesh.Cyl1DMesh
:members:
:undoc-members:
:undoc-members:
docs/api_DiffOperators.rst
+1 -1
View File
@@ -3,6 +3,6 @@
Differential Operators
**********************
.. automodule:: SimPEG.mesh.DiffOperators
.. automodule:: SimPEG.Mesh.DiffOperators
:members:
:undoc-members:
docs/api_InnerProducts.rst
+1 -1
View File
@@ -3,6 +3,6 @@
Inner Products
**************
.. automodule:: SimPEG.mesh.InnerProducts
.. automodule:: SimPEG.Mesh.InnerProducts
:members:
:undoc-members:
docs/api_LogicallyOrthogonalMesh.rst
+1 -9
View File
@@ -3,16 +3,8 @@
Logically Orthogonal Mesh
*************************
.. automodule:: SimPEG.mesh.LogicallyOrthogonalMesh
.. automodule:: SimPEG.Mesh.LogicallyOrthogonalMesh
:show-inheritance:
:members:
:undoc-members:
:inherited-members:
LOM View
********
.. automodule:: SimPEG.mesh.LomView
:members:
:undoc-members:
docs/api_Optimize.rst
+12 -11
View File
@@ -1,35 +1,36 @@
.. _api_Inverse:
Objective Function
******************
.. automodule:: SimPEG.ObjFunction
:members:
:undoc-members:
Optimize
********
.. automodule:: SimPEG.inverse.Optimize
.. automodule:: SimPEG.Optimization
:show-inheritance:
:private-members:
:members:
:undoc-members:
Inversion
*********
.. automodule:: SimPEG.inverse.Inversion
.. automodule:: SimPEG.Inversion
:show-inheritance:
:members:
:undoc-members:
Beta Schedule
*************
.. automodule:: SimPEG.inverse.BetaSchedule
:members:
:undoc-members:
Regularization
**************
.. automodule:: SimPEG.inverse.Regularization
.. automodule:: SimPEG.Regularization
:show-inheritance:
:members:
:undoc-members:
docs/api_Problem.rst
+3 -3
View File
@@ -4,7 +4,7 @@
Problem
*******
.. automodule:: SimPEG.forward.Problem
.. automodule:: SimPEG.Problem
:show-inheritance:
:members:
:undoc-members:
@@ -14,7 +14,7 @@ Problem
DCProblem
*********
.. automodule:: SimPEG.examples.DC
.. automodule:: SimPEG.Examples.DC
:show-inheritance:
:members:
:undoc-members:
@@ -25,7 +25,7 @@ DCProblem
Linear Problem
**************
.. automodule:: SimPEG.examples.Linear
.. automodule:: SimPEG.Examples.Linear
:show-inheritance:
:members:
:undoc-members:
docs/api_TensorMesh.rst
+1 -8
View File
@@ -3,15 +3,8 @@
Tensor Mesh
***********
.. automodule:: SimPEG.mesh.TensorMesh
.. automodule:: SimPEG.Mesh.TensorMesh
:show-inheritance:
:members:
:undoc-members:
:inherited-members:
Tensor View
***********
.. automodule:: SimPEG.mesh.TensorView
:members:
:undoc-members:
docs/api_TestResults.rst
-3994
View File
File diff suppressed because it is too large Load Diff
docs/api_Tests.rst
+1 -1
View File
@@ -3,6 +3,6 @@
Testing SimPEG
**************
.. automodule:: SimPEG.tests.TestUtils
.. automodule:: SimPEG.Tests.TestUtils
:members:
:undoc-members:
docs/api_Utils.rst
+8 -8
View File
@@ -4,7 +4,7 @@
Solver
******
.. automodule:: SimPEG.utils.Solver
.. automodule:: SimPEG.Solver
:members:
:undoc-members:
@@ -12,49 +12,49 @@ Solver
Utilities
*********
.. automodule:: SimPEG.utils
.. automodule:: SimPEG.Utils
:members:
:undoc-members:
Matrix Utilities
****************
.. automodule:: SimPEG.utils.matutils
.. automodule:: SimPEG.Utils.matutils
:members:
:undoc-members:
Sparse Utilities
****************
.. automodule:: SimPEG.utils.sputils
.. automodule:: SimPEG.Utils.sputils
:members:
:undoc-members:
LOM Utilities
*************
.. automodule:: SimPEG.utils.lomutils
.. automodule:: SimPEG.Utils.lomutils
:members:
:undoc-members:
Mesh Utilities
**************
.. automodule:: SimPEG.utils.meshutils
.. automodule:: SimPEG.Utils.meshutils
:members:
:undoc-members:
Model Builder Utilities
***********************
.. automodule:: SimPEG.utils.ModelBuilder
.. automodule:: SimPEG.Utils.ModelBuilder
:members:
:undoc-members:
Interpolation Utilities
***********************
.. automodule:: SimPEG.utils.interputils
.. automodule:: SimPEG.Utils.interputils
:members:
:undoc-members:
docs/examples/mesh/plot_LogicallyOrthogonalMesh.py
-7
View File
@@ -1,7 +0,0 @@
from SimPEG.mesh import LogicallyOrthogonalMesh
from SimPEG import utils
import matplotlib.pyplot as plt
X, Y = utils.exampleLomGird([3,3],'rotate')
M = LogicallyOrthogonalMesh([X, Y])
M.plotGrid()
plt.show()
docs/examples/mesh/plot_grid_2D.py
-11
View File
@@ -1,11 +0,0 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG.mesh import TensorMesh
h1 = np.linspace(.1,.5,3)
h2 = np.linspace(.1,.5,5)
mesh = TensorMesh([h1, h2])
mesh.plotGrid(nodes=True, faces=True, centers=True, lines=True)
plt.show()
docs/examples/mesh/plot_grid_3D.py
-12
View File
@@ -1,12 +0,0 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG.mesh import TensorMesh
h1 = np.linspace(.1,.5,3)
h2 = np.linspace(.1,.5,5)
h3 = np.linspace(.1,.5,3)
mesh = TensorMesh([h1,h2,h3])
mesh.plotGrid(nodes=True, faces=True, centers=True, lines=True)
plt.show()
docs/examples/mesh/plot_image_2D.py
-11
View File
@@ -1,11 +0,0 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG.mesh import TensorMesh
n = 20
h = np.ones(n)/n
M = TensorMesh([h, h])
I = np.sin(M.gridCC[:,0]*2*np.pi)*np.sin(M.gridCC[:,1]*2*np.pi)
M.plotImage(I)
plt.show()
docs/examples/mesh/plot_image_3D.py
-12
View File
@@ -1,12 +0,0 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG.mesh import TensorMesh
n = 20
h = np.ones(n)/n
M = TensorMesh([h,h,h])
I = np.sin(M.gridCC[:,0]*2*np.pi)*np.sin(M.gridCC[:,1]*2*np.pi)*np.sin(M.gridCC[:,2]*2*np.pi)
M.plotImage(I, annotationColor='k')
plt.show()
docs/examples/mesh/plot_nodes.py
-13
View File
@@ -1,13 +0,0 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG.mesh import TensorMesh
x0 = np.zeros(2)
h1 = np.linspace(.1,.5,3)
h2 = np.linspace(.1,.5,5)
M = TensorMesh([h1,h2],x0)
M.plotGrid()
plt.hold()
plt.plot(M.gridN[:,0], M.gridN[:,1], 'ks', markersize=10)
plt.show()
docs/index.rst
+8 -8
View File
@@ -64,16 +64,16 @@ Build Results
=============
* Master Branch
.. image:: https://travis-ci.org/simpeg/simpeg.png?branch=master
:target: https://travis-ci.org/simpeg/simpeg
:alt: Master Branch
:align: center
.. image:: https://travis-ci.org/simpeg/simpeg.png?branch=master
:target: https://travis-ci.org/simpeg/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
.. image:: https://travis-ci.org/simpeg/simpeg.png?branch=develop
:target: https://travis-ci.org/simpeg/simpeg
:alt: Develop Branch
:align: center
Utility Codes