Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for base simulation classes #1295

Merged
merged 36 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from 35 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
114bc5c
Much of the work done in simulation.py.
ghwilliams Oct 16, 2023
c6da84e
I think that it is ready for a PR.
ghwilliams Oct 16, 2023
d9a6fd7
Merge branch 'main' into Doc_BaseSimulations
dccowan Nov 28, 2023
a13152c
start working through base simulation docstrings
dccowan Nov 29, 2023
27eaaf7
final draft docstring simulation.py
dccowan Nov 29, 2023
262a6ed
fix typos in mesh_utils and data
dccowan Nov 29, 2023
323c4c2
bug in intersphinx to pymatsolver
dccowan Nov 29, 2023
7ac37b9
reactivate gen gallery
dccowan Nov 29, 2023
c30a3f8
Correcting a few more conventions.
ghwilliams Dec 20, 2023
89f9337
Minor editings.
ghwilliams Dec 20, 2023
fa2cf26
Merge remote-tracking branch 'upstream/main' into Doc_BaseSimulations
ghwilliams Dec 20, 2023
58af906
Merge branch 'main' into Doc_BaseSimulations
dccowan Jan 3, 2024
7bc2861
Merge branch 'main' into Doc_BaseSimulations
dccowan Jan 10, 2024
0fc2c90
Merge branch 'main' into Doc_BaseSimulations
santisoler Jan 11, 2024
a9a2ad6
Merge branch 'simpeg:main' into Doc_BaseSimulations
ghwilliams Jan 13, 2024
5758b8d
Making changes according to Santi's suggestions.
ghwilliams Jan 13, 2024
42ff18c
Improve rst syntax on shape for jacobian
santisoler Mar 13, 2024
7a7b1ad
Mark simulation arguments as optional
santisoler Mar 13, 2024
ba4c9d0
Improve rst syntax for shape of time_steps
santisoler Mar 13, 2024
744ca7f
Improve rst syntax for shape of time_steps
santisoler Mar 13, 2024
49e3eef
Improve rst syntax for shape in docstring
santisoler Mar 13, 2024
31ef9c4
Fix flake errors
santisoler Mar 13, 2024
ec50ad1
Merge branch 'Doc_BaseSimulations' of github.com:ghwilliams/simpeg in…
santisoler Mar 13, 2024
a4354de
Merge branch 'main' into Doc_BaseSimulations
santisoler Mar 13, 2024
7d637bc
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
65cb9f2
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
81e6a7c
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
2bdccd8
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
8439c7f
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
5e1d43a
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
12694da
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
b45abb3
Update SimPEG/simulation.py
ghwilliams Mar 28, 2024
d8dd641
Replace UncertaintyArray for numpy.ndarray in docstrings
santisoler Apr 2, 2024
54cad2e
Capitalize first letter of string
santisoler Apr 2, 2024
b6e18c9
Merge branch 'main' into Doc_BaseSimulations
santisoler Apr 2, 2024
c762ce9
Replace UncertaintyArrays for np.ndarray in docstrings
santisoler Apr 2, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 SimPEG.data.UncertaintyArray
santisoler marked this conversation as resolved.
Show resolved Hide resolved
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 SimPEG.data.UncertaintyArray
santisoler marked this conversation as resolved.
Show resolved Hide resolved
Assign floor/absolute uncertainties to the data. For each datum, we assume
standard deviation of Gaussian noise is equal to *noise_floor*.
"""
Expand Down