prepare docs

GeoStat-Framework · Jul 12, 2024 · 63a547a · 63a547a
1 parent e9de9c9
commit 63a547a
Show file tree

Hide file tree

Showing 11 changed files with 266 additions and 623 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,8 @@
-# Welcome to GSTools
+# Welcome to GSTools-Cython
 [![GMD](https://img.shields.io/badge/GMD-10.5194%2Fgmd--15--3161--2022-orange)](https://doi.org/10.5194/gmd-15-3161-2022)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1313628.svg)](https://doi.org/10.5281/zenodo.1313628)
-[![PyPI version](https://badge.fury.io/py/gstools.svg)](https://badge.fury.io/py/gstools)
-[![Conda Version](https://img.shields.io/conda/vn/conda-forge/gstools.svg)](https://anaconda.org/conda-forge/gstools)
-[![Build Status](https://github.com/GeoStat-Framework/GSTools/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/GeoStat-Framework/GSTools/actions)
-[![Coverage Status](https://coveralls.io/repos/github/GeoStat-Framework/GSTools/badge.svg?branch=main)](https://coveralls.io/github/GeoStat-Framework/GSTools?branch=main)
-[![Documentation Status](https://readthedocs.org/projects/gstools/badge/?version=latest)](https://geostat-framework.readthedocs.io/projects/gstools/en/stable/?badge=stable)
+[![Build Status](https://github.com/GeoStat-Framework/GSTools-Cython/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/GeoStat-Framework/GSTools-Cython/actions)
+[![Coverage Status](https://coveralls.io/repos/github/GeoStat-Framework/GSTools-Cython/badge.svg?branch=main)](https://coveralls.io/github/GeoStat-Framework/GSTools-Cython?branch=main)
+[![Documentation Status](https://readthedocs.org/projects/gstools-cython/badge/?version=latest)](https://geostat-framework.readthedocs.io/projects/gstools-cython/en/stable/?badge=stable)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
 <p align="center">
@@ -15,36 +12,10 @@
 <p align="center"><b>Get in Touch!</b></p>
 <p align="center">
 <a href="https://github.com/GeoStat-Framework/GSTools/discussions"><img src="https://img.shields.io/badge/GitHub-Discussions-f6f8fa?logo=github&style=flat" alt="GH-Discussions"/></a>
-<a href="https://swung.slack.com/messages/gstools"><img src="https://img.shields.io/badge/Swung-Slack-4A154B?style=flat&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABoAAAAaCAYAAACpSkzOAAAABmJLR0QA%2FwD%2FAP%2BgvaeTAAAACXBIWXMAAA7DAAAOwwHHb6hkAAAAB3RJTUUH5AYaFSENGSa5qgAABmZJREFUSMeFlltsVNcVhr%2B1z5m7Zzy%2BxaBwcQrGQOpgCAkKtSBQIqJepKhPBULpQ6sKBVWVKqXtSy%2BR0qYXqa2qRmlDCzjBEZGKUCK1TWqlNiGIEKDQBtf4Fki4OIxnxrex53LOXn2YwbjEtOvlHG3tvX%2Btf%2B21%2Fl%2BYJ1QVEbn1vwLYBWwCVgG1lW0ZoA%2FoAQ6LSP%2BdZ%2BeGzAMiIqK%2Bem0GpxNYVeBj3j2b4NCfM2QnfAAaa11al4fZuCZK24owQJ9v%2BbLryIVbd9wVSNUaEWNVtQPYfXHmAD0T32ZJeBM1Q8d0zzMDUpMwAFgLJU%2BxClURw9NfqedLWxMAHSKyR1WNiNhPAM0B6c%2FbdPORTLuOeUMSNkmMBHgyeo32bwwRDMh8bDM%2BZVl0j6uvPrdYknFnSESWzwUzt%2BkyVlUHx7zh5j%2BmPkXBjosjLkWdominiMQ%2BoiEZxuq8OFRXGXJ5K5%2Fde5nha8VlqjooIlZVBcBUiqeqemjGppd1ptfhSpS8pmmN7GVf4whPNY4Di9m%2BMcR03nK3sBbCQeFbv7gBsExVOyp3l6nz1VtjcM4fTK3Uok5IXtPsrHuPevcBXk8d4dWPX6I%2BsIB9wf1s%2B2Y%2FVbFynUIBIeDeplIECiXl5Iv3kbLogogRgbWukfNumT%2FnlYszBxj3hwXg0cQvqXcfYNu5tVyYPE%2B1G8dXn%2BfW72fH49U8sSlOPGr4SccoF4cKs3WzFrY%2BFCMUNmz%2Ba0aeWR1l15JwJ7DaVPpk1YnJ7xIxtQRNjDXRvTx%2F9ef0Tl0g6SYQhAlvmkH%2Fgv74qUaiTSG8ewJ0%2FGgRK5aG8Cts5ouWDa1RxoDRovK9i9MAq1S12QA7b5ROUdBxBIeQ1ACG49m%2FEXPis7Qk3ChHbx6Qw1dgXVeWB7uyDOctP%2Fx6w2zdrIVIyFCyiq8wXlJOZzyAXQbY%2FGGhC8EAilJ%2BVg7ufxU6IAHeSvewfQEadiDuCr%2B6NE1LU4hwUFAF1xFGRkvEjVDlgiPwVqoEsNkAq0ZKp3EIYrFM2xGm7Uc8u%2FzXjHkTmHIHoCiDM73E3IIsDCtRV3gn7QHQ0hTCt0ooKLw%2FWCAM1AcNISOcHSsBrDRAbc7eQMQBFFciHM18kaZIMz3r%2F0HO5mazytsiw%2FmTtCYiGGCkQlltwkEVjMDVmyUA6oIGR%2BDGjAWoM3f2giHAhH%2BFI5nPsDrWxqWNE9S4tUz5k1S7cQ5df4k9S6qY9JRipXtr4w5WQYH0eHkWrqxy8FTn3AvpmFmIqj%2B76EiQjNfHH1JNWFKc3vABj9V9npw%2FRXfmBNsaoTRnRAQDAgqqMJr1KBWUtUmHaR8WRgzAqAH6FgYexqd4R2Yuns5wcLSFK4U36bj%2FdbbUbGdoZoCi3uS%2Bqtt73TlNWygpqXGfZTGXnKesrwkA9BmgZ0noMZT5R0tQ4hzLfo4rhS46W%2F%2BCAn3T7%2BhDySiWMl2RkHArP8dAesKjPixYVbbUBwB6DHB4QWADIamuHPtkhE0t3ZP7ANhe9zgvXP2dfK0pymRJmQLiEYNW6mEVljYGuDzlkwwaHq51AQ4bERkAetvjP2XCT6H480AJeZsB4N7QYt7OnuSROtRXJV2wNNS4qIJvlbUtERJxhxcv5%2FlNWwygV0QGyzKBv%2FP%2ByFfZXf%2ButoR3UuXcS95mKNgxSjpN3qZZFHwUgFPjx5n2c9wo9ktrtcOZtMeWB2NEw4b2thivPLuIS1M%2BAzmrTy4O4ys7Zv1B5fsnVdWCr7PxYf7vej73ex2YeU1VVY9nu7ShG63vRo%2Fe%2FK1%2B518FbXkjo3OjO1XU2LFRzRZ9VdWDczFQ1VsCOHgpd1G%2FcG6jHrj2vPbn%2BjVdHNfr%2BRH92eXva2MPuvxEQpe%2BHdEnzm%2FQf4%2BrRo%2BldMUbGd393oS2dWU0cDSlw1OequrALVG9Q8rLsquqg2OlzLL2Myu1N5eShgB4CjEnSMSJYrX8Oj0t8UH7NMnX0iSDwmhBWRl3tKs9IcmgGRSRZqtqzFwpL4uWWKvWiMjyZKC24%2F1HbsrLn95Pwk3gCpS0yIw%2Fg6clPC2RLc3QmzvJupoARQsvrItxZmtSkkFz6E6Q%2F2m3PFta44jbCaw%2BO3GK7uybnJs8xfXC1fLYCdTz9NIfsCS0mYVhAHp9ZYdr5J%2F%2F127dxUA2AzuBzRUDWVfZlq4YyG6gs9ImdzWQ%2FwFNRlgCFdG5bAAAAABJRU5ErkJggg%3D%3D" alt="Slack-Swung"/></a>
-<a href="https://gitter.im/GeoStat-Framework/GSTools"><img src="https://img.shields.io/badge/Gitter-GeoStat--Framework-ed1965?logo=gitter&style=flat" alt="Gitter-GSTools"/></a>
 <a href="mailto:[email protected]"><img src="https://img.shields.io/badge/Email-GeoStat--Framework-468a88?style=flat&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbDpzcGFjZT0icHJlc2VydmUiIHdpZHRoPSI1MDAiIGhlaWdodD0iNTAwIj48cGF0aCBkPSJNNDQ4IDg4SDUyYy0yNyAwLTQ5IDIyLTQ5IDQ5djIyNmMwIDI3IDIyIDQ5IDQ5IDQ5aDM5NmMyNyAwIDQ5LTIyIDQ5LTQ5VjEzN2MwLTI3LTIyLTQ5LTQ5LTQ5em0xNiA0OXYyMjZsLTIgNy0xMTUtMTE2IDExNy0xMTd6TTM2IDM2M1YxMzdsMTE3IDExN0wzOCAzNzBsLTItN3ptMjE5LTYzYy0zIDMtNyAzLTEwIDBMNjYgMTIxaDM2OHptLTc5LTIzIDQ2IDQ2YTM5IDM5IDAgMCAwIDU2IDBsNDYtNDYgMTAxIDEwMkg3NXoiIHN0eWxlPSJmaWxsOiNmNWY1ZjU7ZmlsbC1vcGFjaXR5OjEiLz48L3N2Zz4=" alt="Email"/></a>
 <a href="https://twitter.com/GSFramework"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/GSFramework?style=social"></a>
 </p>
 
-<p align="center"><b>Youtube Tutorial on GSTools</b><br></p>
-
-<p align="center">
-<a href="http://www.youtube.com/watch?feature=player_embedded&v=qZBJ-AZXq6Q" target="_blank">
-<img src="http://img.youtube.com/vi/qZBJ-AZXq6Q/0.jpg" alt="GSTools Transform 22 tutorial" width="480" height="360" border="0" />
-</a>
-</p>
-
-## Purpose
-
-<img align="right" width="450" src="https://raw.githubusercontent.com/GeoStat-Framework/GSTools/main/docs/source/pics/demonstrator.png" alt="">
-
-GeoStatTools provides geostatistical tools for various purposes:
-- random field generation
-- simple, ordinary, universal and external drift kriging
-- conditioned field generation
-- incompressible random vector field generation
-- (automated) variogram estimation and fitting
-- directional variogram estimation and modelling
-- data normalization and transformation
-- many readily provided and even user-defined covariance models
-- metric spatio-temporal modelling
-- plotting and exporting routines
-
 
 ## Installation
 
@@ -88,10 +59,10 @@ You can cite the Zenodo code publication of GSTools by:
 If you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.1313628).
 
 
-## Documentation for GSTools
-
-You can find the documentation under [geostat-framework.readthedocs.io][doc_link].
+## Documentation
 
+- GSTools: https://https://gstools.readthedocs.io/
+- GSTools-Cython: https://https://gstools-cython.readthedocs.io/
 
 ## Cython backend
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -66,9 +66,7 @@ def setup(app):
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",  # parameters look better than with numpydoc only
     "numpydoc",
-    "sphinx_gallery.gen_gallery",
     "m2r2",
-    "sphinxcontrib.youtube",
 ]
 
 # autosummaries from source-files
@@ -217,8 +215,8 @@ def setup(app):
 latex_documents = [
     (
         master_doc,
-        "GeoStatTools.tex",
-        "GeoStatTools Documentation",
+        "GeoStatTools-Cython.tex",
+        "GeoStatTools-Cython Documentation",
         "Sebastian Müller, Lennart Schüler",
         "manual",
     )
@@ -230,7 +228,7 @@ def setup(app):
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, "geostattools", "GeoStatTools Documentation", [author], 1)
+    (master_doc, "geostattools-cython", "GeoStatTools-Cython Documentation", [author], 1)
 ]
 
 
@@ -242,11 +240,11 @@ def setup(app):
 texinfo_documents = [
     (
         master_doc,
-        "GeoStatTools",
-        "GeoStatTools Documentation",
+        "GeoStatTools-Cython",
+        "GeoStatTools-Cython Documentation",
         author,
-        "GeoStatTools",
-        "Geo-statistical toolbox.",
+        "GeoStatTools-Cython",
+        "Cython backend for GSTools.",
         "Miscellaneous",
     )
 ]
@@ -260,73 +258,4 @@ def setup(app):
 intersphinx_mapping = {
     "Python": ("https://docs.python.org/", None),
     "NumPy": ("https://numpy.org/doc/stable/", None),
-    "SciPy": ("https://docs.scipy.org/doc/scipy/", None),
-    "matplotlib": ("https://matplotlib.org/stable/", None),
-    "hankel": ("https://hankel.readthedocs.io/en/latest/", None),
-    "emcee": ("https://emcee.readthedocs.io/en/latest/", None),
-}
-
-# -- Sphinx Gallery Options
-from sphinx_gallery.sorting import FileNameSortKey
-
-# Use pyvista's image scraper for example gallery
-# import pyvista
-# https://github.com/tkoyama010/pyvista-doc-translations/blob/85c835a3ada3a2adefac06ba70e15a101ffa9162/conf.py#L21
-# https://github.com/simpeg/discretize/blob/f414dd7ee7c5ba9a141cb2c37d4b71fdc531eae8/docs/conf.py#L334
-# Make sure off screen is set to true when building locally
-# pyvista.OFF_SCREEN = True
-# # necessary when building the sphinx gallery
-# pyvista.BUILDING_GALLERY = True
-# # Optional - set parameters like theme or window size
-# pyvista.set_plot_theme("document")
-
-sphinx_gallery_conf = {
-    # "image_scrapers": ("pyvista", "matplotlib"),
-    "remove_config_comments": True,
-    # only show "print" output as output
-    "capture_repr": (),
-    # path to your examples scripts
-    "examples_dirs": [
-        "../../examples/00_misc/",
-        "../../examples/01_random_field/",
-        "../../examples/02_cov_model/",
-        "../../examples/03_variogram/",
-        "../../examples/04_vector_field/",
-        "../../examples/05_kriging/",
-        "../../examples/06_conditioned_fields/",
-        "../../examples/07_transformations/",
-        "../../examples/08_geo_coordinates/",
-        "../../examples/09_spatio_temporal/",
-        "../../examples/10_normalizer/",
-    ],
-    # path where to save gallery generated examples
-    "gallery_dirs": [
-        "examples/00_misc/",
-        "examples/01_random_field/",
-        "examples/02_cov_model/",
-        "examples/03_variogram/",
-        "examples/04_vector_field/",
-        "examples/05_kriging/",
-        "examples/06_conditioned_fields/",
-        "examples/07_transformations/",
-        "examples/08_geo_coordinates/",
-        "examples/09_spatio_temporal/",
-        "examples/10_normalizer/",
-    ],
-    # Pattern to search for example files
-    "filename_pattern": r"\.py",
-    # Remove the "Download all examples" button from the top level gallery
-    "download_all_examples": False,
-    # Sort gallery example by file name instead of number of lines (default)
-    "within_subsection_order": FileNameSortKey,
-    # directory where function granular galleries are stored
-    "backreferences_dir": None,
-    # Modules for which function level galleries are created.  In
-    "doc_module": "gstools_cython",
-    # "first_notebook_cell": (
-    #     "%matplotlib inline\n"
-    #     "from pyvista import set_plot_theme\n"
-    #     "set_plot_theme('document')"
-    # ),
-    "matplotlib_animations": True,
 }
diff --git a/docs/source/contents.rst b/docs/source/contents.rst
@@ -7,6 +7,5 @@ Contents
    :maxdepth: 3
 
    index
-   tutorials
    api
    changelog