Hyperparameter cross validation (#25)

* fix: add zref and density args to inversion

* fix: removes references to density and zref

* fix: remove python 3.12 support, add test for 3.10

* chore: specify semantic release options

* chore: remove pypy from testing versions

* feat: add cross validation module

* feat: add cross validation plot function

* build: add tqdm and seaborn deps

* docs: update simple_inversion.ipynb

Lower the grid resolution to run faster, add more detailed comments, use same zref as true topography, change choosen damping value

* docs: add damping_cross_validation.ipynb

new notebook to demonstrate how to perform a CV to find the optimal damping value.

* docs: add damping_cross_validation.ipynb to guide

* style: formatting cross_validation.py

* fix: allow matplotlib and seaborn to be optional

* chore: update deps in .yml and  mapping

* chore: add github action workflow

run a python-semantic-release in no operation mode to see what will be done. Runs one all commits to PR's

* style: pre-commit fixes

* style: format fix

* chore: update release check

* chore: updating release check

* chore: remove semantic release check action

* fix: restructure damping cross validation

associated functions are termed "gravity" cross validation since they use the observed and predicted gravity data to determine the score.

* feat: add constraints cv functions

termed "constraints" since they use the difference between constraint point elevations and inverted topography to determine the score. Used for zref and density cross validations

* docs: reorganized damping CV notebook

* docs: restructured simple inversion notebook

* docs: restructured starting model notebook

* docs: add density and zref CV notebooks

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

docs/conf.py

@@ -37,20 +37,32 @@
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
+    #
+    # Runtime deps
+    #
     "numpy": ("https://docs.scipy.org/doc/numpy/", None),
     "pandas": ("http://pandas.pydata.org/pandas-docs/stable/", None),
     "xarray": ("http://xarray.pydata.org/en/stable/", None),
     "verde": ("https://www.fatiando.org/verde/latest/", None),
     "rioxarray": ("https://corteva.github.io/rioxarray/stable/", None),
-    # pykdgree
+    # pykdtree
     "xrft": ("https://xrft.readthedocs.io/en/stable/", None),
     "harmonica": ("https://www.fatiando.org/harmonica/latest/", None),
     "antarctic_plots": ("https://antarctic-plots.readthedocs.io/en/latest/", None),
     "numba": ("https://numba.pydata.org/numba-doc/latest/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
     # nptyping
-    # "matplotlib": ("https://matplotlib.org/", None),
+    # numba_progress
+    "tqdq": ("https://tqdm.github.io/", None),
     # "pygmt": ("https://www.pygmt.org/latest/", None),
+    #
+    # Viz deps
+    #
+    "pyvista": ("https://docs.pyvista.org/", None),
+    # trame
+    # ipywidgets
+    "matplotlib": ("https://matplotlib.org/", None),
+    "seaborn": ("https://seaborn.pydata.org/", None),
 }
 
 nitpick_ignore = [

docs/index.md

@@ -14,6 +14,9 @@ gallery/index
 :hidden:
 :caption: User guide
 user_guide/simple_inversion
+user_guide/damping_cross_validation
+user_guide/density_cross_validation
+user_guide/reference_level_cross_validation
 user_guide/including_starting_model
 user_guide/adhering_to_constraints
 ```