mirror of
https://github.com/wassname/simpeg.git
synced 2026-06-27 21:38:39 +08:00
Documentation updates.
This commit is contained in:
+2
-2
@@ -21,7 +21,7 @@ class BaseData(object):
|
||||
"""
|
||||
The geophysical problem that explains this data, use::
|
||||
|
||||
data.setProblem(prob)
|
||||
data.pair(prob)
|
||||
"""
|
||||
return getattr(self, '_prob', None)
|
||||
|
||||
@@ -67,7 +67,7 @@ class BaseData(object):
|
||||
|
||||
|
||||
.. math::
|
||||
d_\\text{pred} = Pu(m)
|
||||
d_\\text{pred} = P(u(m))
|
||||
"""
|
||||
return u
|
||||
|
||||
|
||||
+1
-1
@@ -48,7 +48,7 @@ class BaseProblem(object):
|
||||
@property
|
||||
def data(self):
|
||||
"""
|
||||
The data object for this problem. Data
|
||||
The data object for this problem.
|
||||
"""
|
||||
return getattr(self, '_data', None)
|
||||
|
||||
|
||||
@@ -152,11 +152,14 @@ def requires(var):
|
||||
def requiresVar(f):
|
||||
if var is 'prob':
|
||||
extra = """
|
||||
To use data.%s(), SimPEG requires that a problem be bound to the data.
|
||||
If a problem has not been bound, an Exception will be raised.
|
||||
To bind a problem to the Data object::
|
||||
|
||||
data.setProblem(myProblem)
|
||||
.. note::
|
||||
|
||||
To use data.%s(), SimPEG requires that a problem be bound to the data.
|
||||
If a problem has not been bound, an Exception will be raised.
|
||||
To bind a problem to the Data object::
|
||||
|
||||
data.pair(myProblem)
|
||||
|
||||
""" % f.__name__
|
||||
else:
|
||||
|
||||
@@ -1,6 +1,24 @@
|
||||
.. _api_Problem:
|
||||
.. _api_Forward:
|
||||
|
||||
|
||||
Model
|
||||
*****
|
||||
|
||||
.. automodule:: SimPEG.Model
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
|
||||
Data
|
||||
****
|
||||
|
||||
.. automodule:: SimPEG.Data
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
|
||||
Problem
|
||||
*******
|
||||
|
||||
@@ -10,23 +28,3 @@ Problem
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
|
||||
|
||||
DCProblem
|
||||
*********
|
||||
|
||||
.. automodule:: SimPEG.Examples.DC
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
|
||||
|
||||
|
||||
Linear Problem
|
||||
**************
|
||||
|
||||
.. automodule:: SimPEG.Examples.Linear
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
+1
-1
@@ -40,7 +40,7 @@ Forward Problems
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api_Problem
|
||||
api_Forward
|
||||
|
||||
Inversion
|
||||
=========
|
||||
|
||||
Reference in New Issue
Block a user