Skip to content

Commit

Permalink
Improve documentation for base simulation classes (#1295)
Browse files Browse the repository at this point in the history
Extend documentation for base simulation classes and in `SyntheticData`
class. Fix typo and rst style in `mesh_utils.py`. Add `pymatsolver` to
the list of `intersphinx_mapping` in Sphinx's `docs/conf.py`.

---------

Co-authored-by: Devin C. Cowan <devinccowan@gmail.com>
Co-authored-by: Santiago Soler <santisoler@fastmail.com>
Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
  • Loading branch information
4 people committed Apr 2, 2024
1 parent 489851f commit eeb406f
Show file tree
Hide file tree
Showing 4 changed files with 511 additions and 145 deletions.
12 changes: 7 additions & 5 deletions SimPEG/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def dobs(self):
numpy.ndarray
Notes
--------
-----
This array can also be modified by directly indexing the data object
using the a tuple of the survey's sources and receivers.
Expand Down Expand Up @@ -363,8 +363,10 @@ def fromvec(self, v):


class SyntheticData(Data):
r"""
Class for creating synthetic data.
r"""Synthetic data class.
The ``SyntheticData`` class is a :py:class:`SimPEG.data.Data` class that allows the
user to keep track of both clean and noisy data.
Parameters
----------
Expand All @@ -375,12 +377,12 @@ class SyntheticData(Data):
Observed data.
dclean : (nD) numpy.ndarray
Noiseless data.
relative_error : SimPEG.data.UncertaintyArray
relative_error : float or np.ndarray
Assign relative uncertainties to the data using relative error; sometimes
referred to as percent uncertainties. For each datum, we assume the
standard deviation of Gaussian noise is the relative error times the
absolute value of the datum; i.e. :math:`C_{err} \times |d|`.
noise_floor : UncertaintyArray
noise_floor : float or np.ndarray
Assign floor/absolute uncertainties to the data. For each datum, we assume
standard deviation of Gaussian noise is equal to *noise_floor*.
"""
Expand Down

0 comments on commit eeb406f

Please sign in to comment.