Directional variogram example

Author: SimonMolinsky

CHANGELOG.rst

@@ -42,16 +42,18 @@ Changes - from version >= 1.x
 * [docs] `CITATION.cff`, citation section in readme has been moved up, bibtex citation has been added
 * [docs] corrected broken links to `CONTRIBUTING.md` file in readme and docs
 * [setup] links to documentation have been added to `pyproject.toml`
-* [docs] docstring examples - all user-facing API endpoints has examples in docstrings, using new input types (values | geometries)
+* [docs] docstring examples - all user-facing API endpoints have examples in docstrings, using new input types (values | geometries)
 * [docs] updated docstrings (examples) in: `PointSupportDistance`, `core.block_filter`, `pipelines.interpolate`, `pyinterpolate.distance.block.calc_block_to_block_distance`, `validate_kriging`, `metrics` module functions, `inverse_distance_weighting`, `centroid_poisson_kriging`, `area_to_area_pk`, `area_to_point_pk`, `area_to_point_pk`, `area_to_point_pk`, `ordinary_kriging`, `simple_kriging`, `IndicatorKriging`, `UniversalKriging`, `Deconvolution`,
 * [enhancement] `ExperimentalVariogram` has new property - `lag_semivariance_array` that returns numpy array with lags and semivariances
 * [enhancement] `TheoreticalVariogram` has new property - `lag_yhat_array` that returns numpy array with lags and predicted semivariances
 * [api change] `Deviation` class parameters have been renamed to clearly point what is passed as the input
 * [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()`, `calculate_semivariance()`, used parameters `values` and `geometries`
-* [docs] docstring examples for `calculate_covariance()`, used parameters `values` and `geometries`
+* [docs] docstring example for `AggregatedVariogram` and `regularize()`
+* [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] 
 
 2025-10-11
 ----------

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

@@ -92,6 +92,26 @@ class DirectionalVariogram:
 
     show()
         Plot all variograms.
+
+    Examples
+    --------
+    >>> import numpy as np
+    >>> from pyinterpolate import DirectionalVariogram
+    >>>
+    >>>
+    >>> ds = np.load('armstrong_data.npy')
+    >>> step_size = 1.5
+    >>> max_range = 6
+    >>> directional_variogram = DirectionalVariogram(
+    ...     step_size=STEP_SIZE,
+    ...     max_range=MAX_RANGE,
+    ...     values=ds[:, -1],
+    ...     geometries=ds[:, :-1]
+    ... )
+    >>> variograms = directional_variogram.get()
+    >>> print(variograms.keys())
+    dict_keys(['ISO', 'NS', 'WE', 'NE-SW', 'NW-SE'])
+    >>> directional_variogram.show()  # shows variograms in all directions
     """
 
     def __init__(self,