VariogramCloud example

Author: SimonMolinsky

CHANGELOG.rst

@@ -53,7 +53,7 @@ Changes - from version >= 1.x
 * [docs] docstring example for `ExperimentalVariogram` and `build_experimental_variogram()`, `calculate_semivariance()`, used parameters `values` and `geometries`
 * [docs] docstring example for `calculate_covariance()`, used parameters `values` and `geometries`
 * [docs] docstring example for `DirectionalVariogram`, used parameters `values` and `geometries`
-* [docs] 
+* [docs] docstring example for `VariogramCloud`, used parameters `values` and `geometries`
 
 2025-10-11
 ----------

src/pyinterpolate/semivariogram/experimental/classes/variogram_cloud.py

@@ -170,6 +170,41 @@ class VariogramCloud:
     --------
     ExperimentalVariogram : class that calculates experimental semivariogram,
         experimental covariogram and data variance.
+
+    Examples
+    --------
+    >>> import numpy as np
+    >>> from pyinterpolate import VariogramCloud
+    >>>
+    >>>
+    >>> REFERENCE_INPUT = np.array([
+    ...    [0, 0, 8],
+    ...    [1, 0, 6],
+    ...    [2, 0, 4],
+    ...    [3, 0, 3],
+    ...    [4, 0, 6],
+    ...    [5, 0, 5],
+    ...    [6, 0, 7],
+    ...    [7, 0, 2],
+    ...    [8, 0, 8],
+    ...    [9, 0, 9],
+    ...    [10, 0, 5],
+    ...    [11, 0, 6],
+    ...    [12, 0, 3]
+    ...    ])
+    >>> STEP_SIZE = 1
+    >>> MAX_RANGE = 4
+    >>> vc = VariogramCloud(
+    ...     values=REFERENCE_INPUT[:, -1],
+    ...     geometries=REFERENCE_INPUT[:, :-1],
+    ...     step_size=STEP_SIZE,
+    ...     max_range=MAX_RANGE
+    ... )
+    >>> stats = vc.describe()
+    >>> print(stats[1]['count'])
+    24
+    >>> print(stats[2]['median'])
+    9
     """
 
     def __init__(self,