SciKit-GStat
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()
Metadata
Release files for scikit-gstat 1.0.27
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scikit_gstat-1.0.27.tar.gz | 710.0 kB | Without provenance | Details for scikit_gstat-1.0.27.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scikit_gstat-1.0.27-py3-none-any.whl | Python 3 | none | any | Details for scikit_gstat-1.0.27-py3-none-any.whl |
Total release size: 1.4 MB
Release files / scikit_gstat-1.0.27.tar.gz
| Download URL | scikit_gstat-1.0.27.tar.gz |
|---|---|
| Size | 710.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ae258b0ae4e0922b2b7fe435b41688a1f0d03f22ccae3cf1d9e23151493bab55
|
|
BLAKE2b-256 checksum How to use checksums |
a1d8d5ad06b6509dd87cfdb78683bb2ef7c9b44b5a5c1073961872c7811d2c4a
|
| 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.27-py3-none-any.whl
| Download URL | scikit_gstat-1.0.27-py3-none-any.whl |
|---|---|
| Size | 726.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
633f845d80b32c571cbcbd7baf83dd7bfdc33a372d4dbcf539741c05cb3913e7
|
|
BLAKE2b-256 checksum How to use checksums |
a86a8a5f1b20a17506b17ce04b37e7e9fbc7f28ba4958c4fec3695832f7fe2a3
|
| 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.27
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.