Skip to main content

SciKit-GStat

https://img.shields.io/pypi/v/scikit-gstat?color=green&logo=pypi&logoColor=yellow&style=flat-square:alt:PyPI https://img.shields.io/github/v/release/mmaelicke/scikit-gstat?color=green&logo=github&style=flat-square:alt:GitHubrelease(latestbydate) https://github.com/mmaelicke/scikit-gstat/workflows/Test%20and%20build%20docs/badge.svg Codecov https://zenodo.org/badge/98853365.svg

How to cite

In case you use SciKit-GStat in other software or scientific publications, please reference this module. There is a GMD publication. Please cite it like:

Mälicke, M.: SciKit-GStat 1.0: a SciPy-flavored geostatistical variogram estimation toolbox written in Python, Geosci. Model Dev., 15, 2505–2532, https://doi.org/10.5194/gmd-15-2505-2022, 2022.

The code itself is published and has a DOI. It can be cited as:

Mirko Mälicke, Romain Hugonnet, Helge David Schneider, Sebastian Müller, Egil Möller, & Johan Van de Wauw. (2022). mmaelicke/scikit-gstat: Version 1.0 (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.5970098

Full Documentation

The full documentation can be found at: https://mmaelicke.github.io/scikit-gstat

Description

SciKit-Gstat is a scipy-styled analysis module for geostatistics. It includes two base classes Variogram and OrdinaryKriging. Additionally, various variogram classes inheriting from Variogram are available for solving directional or space-time related tasks. The module makes use of a rich selection of semi-variance estimators and variogram model functions, while being extensible at the same time. The estimators include:

  • matheron

  • cressie

  • dowd

  • genton

  • entropy

  • two experimental ones: quantiles, minmax

The models include:

  • sperical

  • exponential

  • gaussian

  • cubic

  • stable

  • matérn

with all of them in a nugget and no-nugget variation. All the estimator are implemented using numba’s jit decorator. The usage of numba might be subject to change in future versions.

Installation

PyPI

pip install scikit-gstat

Note: It can happen that the installation of numba or numpy is failing using pip. Especially on Windows systems. Usually, a missing Dll (see eg. #31) or visual c++ redistributable is the reason.

GIT:

git clone https://github.com/mmaelicke/scikit-gstat.git
cd scikit-gstat
pip install -r requirements.txt
pip install -e .

Conda-Forge:

From Version 0.5.5 on scikit-gstat is also available on conda-forge. Note that for versions < 1.0 conda-forge will not always be up to date, but from 1.0 on, each minor release will be available.

conda install -c conda-forge scikit-gstat

Quickstart

The Variogram class needs at least a list of coordiantes and values. All other attributes are set by default. You can easily set up an example by using the skgstat.data sub-module, that includes a growing list of sample data.

import skgstat as skg

# the data functions return a dict of 'sample' and 'description'
coordinates, values = skg.data.pancake(N=300).get('sample')

V = skg.Variogram(coordinates=coordinates, values=values)
print(V)
spherical Variogram
-------------------
Estimator:         matheron
Effective Range:   353.64
Sill:              1512.24
Nugget:            0.00

All variogram parameters can be changed in place and the class will automatically invalidate and update dependent results and parameters.

V.model = 'exponential'
V.n_lags = 15
V.maxlag = 500

# plot - matplotlib and plotly are available backends
fig = V.plot()
./example.png

Metadata

Release files for scikit-gstat 1.0.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scikit-gstat 1.0.26
File Size Uploaded Provenance Actions
scikit_gstat-1.0.26.tar.gz 707.5 kB Without provenance Details for scikit_gstat-1.0.26.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for scikit-gstat 1.0.26
File Interpreter ABI Platform Actions
scikit_gstat-1.0.26-py3-none-any.whl Python 3 none any Details for scikit_gstat-1.0.26-py3-none-any.whl

Total release size: 1.4 MB

Release files / scikit_gstat-1.0.26.tar.gz

Download URL scikit_gstat-1.0.26.tar.gz
Size 707.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f2ea695b1878577dafebe242e8c8581316f7e93990c49fee6099ae00a612cbfc
BLAKE2b-256 checksum
How to use checksums
3ada4601f5cd924911cc130cdf9301424d3e5d584ab27d0eb922ec8c4b478dd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / scikit_gstat-1.0.26-py3-none-any.whl

Download URL scikit_gstat-1.0.26-py3-none-any.whl
Size 725.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
467285027318f2e59403f47e6317e332e458ea427243db175846e2576d08b367
BLAKE2b-256 checksum
How to use checksums
4a5486b1749dc4f37a951ac88953ab6af763ba87fe7c14c2707e06c9a76d7a5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for scikit-gstat 1.0.26

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.26 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page