calculate_semivariance() example

Author: SimonMolinsky

CHANGELOG.rst

@@ -50,7 +50,7 @@ Changes - from version >= 1.x
 * [tests] `Deviation` class tests and debug (method selection)
 * [docs] docstring example for `Deviation`
 * [docs] docstring examples for `AggregatedVariogram` and `regularize()`
-* [docs] docstring examples for `ExperimentalVariogram` and `build_experimental_variogram()`, used parameters `values` and `geometries`
+* [docs] docstring examples for `ExperimentalVariogram` and `build_experimental_variogram()`, `calculate_semivariance()`, used parameters `values` and `geometries`
 * [docs]
 
 2025-10-11

src/pyinterpolate/semivariogram/experimental/experimental_semivariogram.py

@@ -171,6 +171,9 @@ def calculate_semivariance(ds: Union[ArrayLike, VariogramPoints] = None,
     Examples
     --------
     >>> import numpy as np
+    >>> from pyinterpolate import calculate_semivariance
+    >>>
+    >>>
     >>> REFERENCE_INPUT = np.array([
     ...    [0, 0, 8],
     ...    [1, 0, 6],
@@ -189,7 +192,8 @@ def calculate_semivariance(ds: Union[ArrayLike, VariogramPoints] = None,
     >>> STEP_SIZE = 1
     >>> MAX_RANGE = 4
     >>> semivariances = calculate_semivariance(
-    ...    REFERENCE_INPUT,
+    ...    values=REFERENCE_INPUT[:, -1],
+    ...    geometries=REFERENCE_INPUT[:, :-1],
     ...    step_size=STEP_SIZE,
     ...    max_range=MAX_RANGE)
     >>> print(semivariances[0])