diff --git a/SimPEG/Data.py b/SimPEG/Data.py index 948b1c83..fa37b09a 100644 --- a/SimPEG/Data.py +++ b/SimPEG/Data.py @@ -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 diff --git a/SimPEG/Problem.py b/SimPEG/Problem.py index e53c4675..386fac9d 100644 --- a/SimPEG/Problem.py +++ b/SimPEG/Problem.py @@ -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) diff --git a/SimPEG/Utils/__init__.py b/SimPEG/Utils/__init__.py index 437f1387..1daa2e29 100644 --- a/SimPEG/Utils/__init__.py +++ b/SimPEG/Utils/__init__.py @@ -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: diff --git a/docs/api_Problem.rst b/docs/api_Forward.rst similarity index 67% rename from docs/api_Problem.rst rename to docs/api_Forward.rst index 09a4d5b6..91009294 100644 --- a/docs/api_Problem.rst +++ b/docs/api_Forward.rst @@ -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: diff --git a/docs/index.rst b/docs/index.rst index 5ba56947..9ed98291 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,7 +40,7 @@ Forward Problems .. toctree:: :maxdepth: 2 - api_Problem + api_Forward Inversion =========