Documentation updates

This commit is contained in:
rowanc1
2014-05-17 22:10:31 -07:00
parent 23e6ece0cd
commit bdb62e8046
6 changed files with 153 additions and 39 deletions
+11 -8
View File
@@ -4,6 +4,9 @@
SimPEG Maps
***********
Thats not a map...?!
====================
A SimPEG Map operates on a vector and transforms it to another space.
We will use an example commonly applied in electromagnetics (EM) of the
log-conductivity model.
@@ -70,14 +73,6 @@ When these are used in the inverse problem, this is extremely important!!
expMap.test(m, plotIt=True)
The API
=======
.. autoclass:: SimPEG.Maps.IdentityMap
:members:
:undoc-members:
Combining Maps
==============
@@ -127,6 +122,14 @@ Just to be sure that the derivative is correct, you should always run the test
on the mapping that you create.
The API
=======
.. autoclass:: SimPEG.Maps.IdentityMap
:members:
:undoc-members:
Common Maps
===========