mmaelicke/scikit-gstat repository overview

PyPI
^^^^
.. code-block:: bash

  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 <https://github.com/mmaelicke/scikit-gstat/issues/31>`_) or visual c++ redistributable is the reason. 

GIT:
^^^^

.. code-block:: bash

  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.

.. code-block:: bash

  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.

.. code-block:: python

  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)

.. code-block:: bash

  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.

.. code-block:: python

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

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

.. image:: ./example.png