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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for base simulation classes #1295

Merged
merged 36 commits into from
Apr 2, 2024
Merged

Improve documentation for base simulation classes #1295

merged 36 commits into from
Apr 2, 2024

Commits on Oct 16, 2023

  1. Much of the work done in simulation.py.

    @ghwilliams
    ghwilliams committed Oct 16, 2023
    Configuration menu
    Copy the full SHA
    114bc5c View commit details
    Browse the repository at this point in the history

  2. I think that it is ready for a PR. 

    But I would like in a very near future to look
closer at PDESimulation classes.
    @ghwilliams
    ghwilliams committed Oct 16, 2023
    Configuration menu
    Copy the full SHA
    c6da84e View commit details
    Browse the repository at this point in the history

Commits on Nov 28, 2023

  1. Merge branch 'main' into Doc_BaseSimulations

    @dccowan
    dccowan committed Nov 28, 2023
    Configuration menu
    Copy the full SHA
    d9a6fd7 View commit details
    Browse the repository at this point in the history

Commits on Nov 29, 2023

  1. start working through base simulation docstrings

    @dccowan
    dccowan committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    a13152c View commit details
    Browse the repository at this point in the history

  2. final draft docstring simulation.py

    @dccowan
    dccowan committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    27eaaf7 View commit details
    Browse the repository at this point in the history

  3. fix typos in mesh_utils and data

    @dccowan
    dccowan committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    262a6ed View commit details
    Browse the repository at this point in the history

  4. bug in intersphinx to pymatsolver

    @dccowan
    dccowan committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    323c4c2 View commit details
    Browse the repository at this point in the history

  5. reactivate gen gallery

    @dccowan
    dccowan committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    7ac37b9 View commit details
    Browse the repository at this point in the history

Commits on Dec 20, 2023

  1. Correcting a few more conventions.

    @ghwilliams
    ghwilliams committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    c30a3f8 View commit details
    Browse the repository at this point in the history

  2. Minor editings.

    @ghwilliams
    ghwilliams committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    89f9337 View commit details
    Browse the repository at this point in the history

  3. Merge remote-tracking branch 'upstream/main' into Doc_BaseSimulations

    @ghwilliams
    ghwilliams committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    fa2cf26 View commit details
    Browse the repository at this point in the history

Commits on Jan 3, 2024

  1. Merge branch 'main' into Doc_BaseSimulations

    @dccowan
    dccowan committed Jan 3, 2024
    Configuration menu
    Copy the full SHA
    58af906 View commit details
    Browse the repository at this point in the history

Commits on Jan 10, 2024

  1. Merge branch 'main' into Doc_BaseSimulations

    @dccowan
    dccowan committed Jan 10, 2024
    Configuration menu
    Copy the full SHA
    7bc2861 View commit details
    Browse the repository at this point in the history

Commits on Jan 11, 2024

  1. Merge branch 'main' into Doc_BaseSimulations

    @santisoler
    santisoler committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    0fc2c90 View commit details
    Browse the repository at this point in the history

Commits on Jan 13, 2024

  1. Merge branch 'simpeg:main' into Doc_BaseSimulations

    @ghwilliams
    ghwilliams committed Jan 13, 2024
    Configuration menu
    Copy the full SHA
    a9a2ad6 View commit details
    Browse the repository at this point in the history

  2. Making changes according to Santi's suggestions.

    @ghwilliams
    ghwilliams committed Jan 13, 2024
    Configuration menu
    Copy the full SHA
    5758b8d View commit details
    Browse the repository at this point in the history

Commits on Mar 13, 2024

  1. Improve rst syntax on shape for jacobian

    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    42ff18c View commit details
    Browse the repository at this point in the history

  2. Mark simulation arguments as optional

    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    7a7b1ad View commit details
    Browse the repository at this point in the history

  3. Improve rst syntax for shape of time_steps

    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    ba4c9d0 View commit details
    Browse the repository at this point in the history

  4. Improve rst syntax for shape of time_steps

    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    744ca7f View commit details
    Browse the repository at this point in the history

  5. Improve rst syntax for shape in docstring

    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    49e3eef View commit details
    Browse the repository at this point in the history

  6. Fix flake errors 

    Use r-string when including backslashes in the docstring. Fix syntax for
the tip admonition.
    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    31ef9c4 View commit details
    Browse the repository at this point in the history

  7. Merge branch 'Doc_BaseSimulations' of github.com:ghwilliams/simpeg in… 

    …to Doc_BaseSimulations
    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    ec50ad1 View commit details
    Browse the repository at this point in the history

  8. Merge branch 'main' into Doc_BaseSimulations

    @santisoler
    santisoler committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    a4354de View commit details
    Browse the repository at this point in the history

Commits on Mar 28, 2024

  1. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    7d637bc View commit details
    Browse the repository at this point in the history

  2. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    65cb9f2 View commit details
    Browse the repository at this point in the history

  3. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    81e6a7c View commit details
    Browse the repository at this point in the history

  4. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    2bdccd8 View commit details
    Browse the repository at this point in the history

  5. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    8439c7f View commit details
    Browse the repository at this point in the history

  6. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    5e1d43a View commit details
    Browse the repository at this point in the history

  7. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    12694da View commit details
    Browse the repository at this point in the history

  8. Update SimPEG/simulation.py 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @ghwilliams @lheagy
    ghwilliams and lheagy committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    b45abb3 View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2024

  1. Replace UncertaintyArray for numpy.ndarray in docstrings 

    Co-authored-by: Lindsey Heagy <lindseyheagy@gmail.com>
    @santisoler @lheagy
    santisoler and lheagy committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    d8dd641 View commit details
    Browse the repository at this point in the history

  2. Capitalize first letter of string

    @santisoler
    santisoler committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    54cad2e View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into Doc_BaseSimulations

    @santisoler
    santisoler committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    b6e18c9 View commit details
    Browse the repository at this point in the history

  4. Replace UncertaintyArrays for np.ndarray in docstrings

    @santisoler
    santisoler committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    c762ce9 View commit details
    Browse the repository at this point in the history