wassname/simpeg
1
0
Fork 0
mirror of https://github.com/wassname/simpeg.git synced 2026-07-08 04:02:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs reorganization.

Browse Source
This commit is contained in:
rowanc1
2014-02-25 09:51:39 -08:00
parent 33431c4e5f
commit 30fd9a3c3d
13 changed files with 82 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api_BaseMesh.rst
-8
View File
@@ -1,8 +0,0 @@
.. _api_BaseMesh:
Base Mesh
*********
.. automodule:: SimPEG.Mesh.BaseMesh
:members:
:undoc-members:
docs/api_Cyl1DMesh.rst
-8
View File
@@ -1,8 +0,0 @@
.. _api_Cyl1DMesh:
Cylindrical 1D Mesh
*******************
.. automodule:: SimPEG.Mesh.Cyl1DMesh
:members:
:undoc-members:
docs/api_DiffOperators.rst
-8
View File
@@ -1,8 +0,0 @@
.. _api_DiffOperators:
Differential Operators
**********************
.. automodule:: SimPEG.Mesh.DiffOperators
:members:
:undoc-members:
docs/api_Forward.rst
+3 -3
View File
@@ -2,7 +2,7 @@
Model
*****
=====
.. automodule:: SimPEG.Model
:show-inheritance:
@@ -11,7 +11,7 @@ Model
:inherited-members:
Data
****
====
.. automodule:: SimPEG.Data
:show-inheritance:
@@ -20,7 +20,7 @@ Data
:inherited-members:
Problem
*******
=======
.. automodule:: SimPEG.Problem
:show-inheritance:
docs/api_InnerProducts.rst
-8
View File
@@ -1,8 +0,0 @@
.. _api_InnerProducts:
Inner Products
**************
.. automodule:: SimPEG.Mesh.InnerProducts
:members:
:undoc-members:
docs/api_Inverse.rst
+4 -4
View File
@@ -2,7 +2,7 @@
Regularization
**************
==============
.. automodule:: SimPEG.Regularization
:show-inheritance:
@@ -11,7 +11,7 @@ Regularization
Objective Function
******************
==================
.. automodule:: SimPEG.ObjFunction
:members:
@@ -19,7 +19,7 @@ Objective Function
Optimize
********
========
.. automodule:: SimPEG.Optimization
:show-inheritance:
@@ -28,7 +28,7 @@ Optimize
:undoc-members:
Inversion
*********
=========
.. automodule:: SimPEG.Inversion
:show-inheritance:
docs/api_LogicallyOrthogonalMesh.rst
-10
View File
@@ -1,10 +0,0 @@
.. _api_LogicallyOrthogonalMesh:
Logically Orthogonal Mesh
*************************
.. automodule:: SimPEG.Mesh.LogicallyOrthogonalMesh
:show-inheritance:
:members:
:undoc-members:
:inherited-members:
docs/api_Mesh.rst
+53
View File
@@ -0,0 +1,53 @@
.. _api_Mesh:
Tensor Mesh
===========
.. automodule:: SimPEG.Mesh.TensorMesh
:show-inheritance:
:members:
:undoc-members:
:inherited-members:
Cylindrical 1D Mesh
===================
.. automodule:: SimPEG.Mesh.Cyl1DMesh
:members:
:undoc-members:
Logically Orthogonal Mesh
=========================
.. automodule:: SimPEG.Mesh.LogicallyOrthogonalMesh
:show-inheritance:
:members:
:undoc-members:
:inherited-members:
Base Mesh
=========
.. automodule:: SimPEG.Mesh.BaseMesh
:members:
:undoc-members:
Inner Products
==============
.. automodule:: SimPEG.Mesh.InnerProducts
:members:
:undoc-members:
Differential Operators
======================
.. automodule:: SimPEG.Mesh.DiffOperators
:members:
:undoc-members:
docs/api_Parameters.rst
+1 -1
View File
@@ -2,7 +2,7 @@
Parameters
**********
==========
.. automodule:: SimPEG.Parameters
:show-inheritance:
docs/api_TensorMesh.rst
-10
View File
@@ -1,10 +0,0 @@
.. _api_TensorMesh:
Tensor Mesh
***********
.. automodule:: SimPEG.Mesh.TensorMesh
:show-inheritance:
:members:
:undoc-members:
:inherited-members:
docs/api_Tests.rst
+1 -1
View File
@@ -1,7 +1,7 @@
.. _api_Tests:
Testing SimPEG
**************
==============
.. automodule:: SimPEG.Tests.TestUtils
:members:
docs/api_Utils.rst
+5 -12
View File
@@ -17,42 +17,35 @@ Utilities
:undoc-members:
Matrix Utilities
****************
================
.. automodule:: SimPEG.Utils.matutils
:members:
:undoc-members:
Sparse Utilities
****************
.. automodule:: SimPEG.Utils.sputils
:members:
:undoc-members:
LOM Utilities
*************
=============
.. automodule:: SimPEG.Utils.lomutils
:members:
:undoc-members:
Mesh Utilities
**************
==============
.. automodule:: SimPEG.Utils.meshutils
:members:
:undoc-members:
Model Builder Utilities
***********************
=======================
.. automodule:: SimPEG.Utils.ModelBuilder
:members:
:undoc-members:
Interpolation Utilities
***********************
=======================
.. automodule:: SimPEG.Utils.interputils
:members:
docs/index.rst
+15 -18
View File
@@ -11,10 +11,12 @@ 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
@@ -22,20 +24,15 @@ these goals, this package has the following features:
:align: center
Meshing & Operators
===================
*******************
.. toctree::
:maxdepth: 2
api_BaseMesh
api_TensorMesh
api_LogicallyOrthogonalMesh
api_Cyl1DMesh
api_DiffOperators
api_InnerProducts
api_Mesh
Forward Problems
================
****************
.. toctree::
:maxdepth: 2
@@ -43,7 +40,7 @@ Forward Problems
api_Forward
Inversion
=========
*********
.. toctree::
:maxdepth: 2
@@ -52,7 +49,7 @@ Inversion
api_Parameters
Testing SimPEG
==============
**************
.. toctree::
:maxdepth: 2
@@ -60,20 +57,20 @@ Testing SimPEG
api_Tests
* Master Branch
.. image:: https://travis-ci.org/simpeg/simpeg.png?branch=master
.. 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
.. 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
@@ -82,7 +79,7 @@ Utility Codes
Project Index & Search
======================
**********************
* :ref:`genindex`
* :ref:`modindex`