mirror of
https://github.com/wassname/simpeg.git
synced 2026-06-29 03:04:53 +08:00
Documentation Updates
This commit is contained in:
+13
-4
@@ -1,11 +1,20 @@
|
||||
.. _api_FDEM:
|
||||
|
||||
|
||||
Base Classes
|
||||
************
|
||||
The API
|
||||
=======
|
||||
|
||||
.. automodule:: simpegEM.FDEM
|
||||
.. automodule:: simpegEM.FDEM.FDEM
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
|
||||
|
||||
FDEM Survey
|
||||
-----------
|
||||
|
||||
.. automodule:: simpegEM.FDEM.SurveyFDEM
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
+6
-6
@@ -49,7 +49,7 @@
|
||||
|
||||
|
||||
TDEM - B formulation
|
||||
********************
|
||||
====================
|
||||
|
||||
.. automodule:: simpegEM.TDEM.TDEM_b
|
||||
:show-inheritance:
|
||||
@@ -59,7 +59,7 @@ TDEM - B formulation
|
||||
|
||||
|
||||
Field Storage
|
||||
*************
|
||||
=============
|
||||
|
||||
.. automodule:: simpegEM.TDEM.FieldsTDEM
|
||||
:show-inheritance:
|
||||
@@ -68,10 +68,10 @@ Field Storage
|
||||
:inherited-members:
|
||||
|
||||
|
||||
TDEM Data Classes
|
||||
*****************
|
||||
TDEM Survey Classes
|
||||
===================
|
||||
|
||||
.. automodule:: simpegEM.TDEM.DataTDEM
|
||||
.. automodule:: simpegEM.TDEM.SurveyTDEM
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
@@ -79,7 +79,7 @@ TDEM Data Classes
|
||||
|
||||
|
||||
Base Classes
|
||||
************
|
||||
============
|
||||
|
||||
.. automodule:: simpegEM.TDEM.BaseTDEM
|
||||
:show-inheritance:
|
||||
|
||||
@@ -56,7 +56,7 @@ The following shows the derivation for the TDEM problem. We use the b-formulatio
|
||||
|
||||
|
||||
Sensitivity Calculation
|
||||
***********************
|
||||
=======================
|
||||
|
||||
.. math::
|
||||
|
||||
@@ -233,7 +233,7 @@ with
|
||||
|
||||
|
||||
Implementing **J** times a vector
|
||||
*********************************
|
||||
=================================
|
||||
|
||||
Multiplying **J** onto a vector can be broken into three steps
|
||||
|
||||
@@ -297,8 +297,8 @@ and
|
||||
|
||||
|
||||
|
||||
Implementing \\(\\mathbf{J}^\\top\\) times a vector
|
||||
*********************************
|
||||
Implementing **J** transpose times a vector
|
||||
===========================================
|
||||
|
||||
Multiplying \\(\\mathbf{J}^\\top\\) onto a vector can be broken into three steps
|
||||
|
||||
|
||||
+11
-2
@@ -1,9 +1,15 @@
|
||||
.. _api_Utils:
|
||||
|
||||
|
||||
Analytic Functions
|
||||
simpegEM Utilities
|
||||
******************
|
||||
|
||||
SimPEG for EM provides a few EM specific utility codes,
|
||||
sources, and analytic functions.
|
||||
|
||||
Analytic Functions - Time
|
||||
=========================
|
||||
|
||||
.. automodule:: simpegEM.Utils.Ana.TEM
|
||||
:show-inheritance:
|
||||
:members:
|
||||
@@ -11,6 +17,9 @@ Analytic Functions
|
||||
:inherited-members:
|
||||
|
||||
|
||||
Analytic Functions - Frequency
|
||||
==============================
|
||||
|
||||
.. automodule:: simpegEM.Utils.Ana.FEM
|
||||
:show-inheritance:
|
||||
:members:
|
||||
@@ -19,7 +28,7 @@ Analytic Functions
|
||||
|
||||
|
||||
Sources
|
||||
*******
|
||||
=======
|
||||
|
||||
.. automodule:: simpegEM.Utils.Sources.magneticDipole
|
||||
:show-inheritance:
|
||||
|
||||
+8
-10
@@ -3,6 +3,10 @@
|
||||
:alt: SimPEG
|
||||
:align: center
|
||||
|
||||
|
||||
SimPEG for Electromagnetics
|
||||
===========================
|
||||
|
||||
SimPEG (Simulation and Parameter Estimation in Geophysics) is a python
|
||||
package for simulation and gradient based parameter estimation in the
|
||||
context of geoscience applications.
|
||||
@@ -44,21 +48,15 @@ Utils
|
||||
api_Utils
|
||||
|
||||
|
||||
Testing SimPEG
|
||||
==============
|
||||
Testing simpegEM
|
||||
================
|
||||
|
||||
* Master Branch
|
||||
.. image:: https://travis-ci.org/simpeg/simpegdc.png?branch=master
|
||||
:target: https://travis-ci.org/simpeg/simpegdc
|
||||
.. image:: https://travis-ci.org/simpeg/simpegem.png?branch=master
|
||||
:target: https://travis-ci.org/simpeg/simpegem
|
||||
:alt: Master Branch
|
||||
:align: center
|
||||
|
||||
* Develop Branch
|
||||
.. image:: https://travis-ci.org/simpeg/simpegdc.png?branch=develop
|
||||
:target: https://travis-ci.org/simpeg/simpegdc
|
||||
:alt: Develop Branch
|
||||
:align: center
|
||||
|
||||
|
||||
Project Index & Search
|
||||
======================
|
||||
|
||||
Reference in New Issue
Block a user