496 missing examples

CHANGELOG.rst

@@ -1,7 +1,7 @@
 Changes - from version >= 1.x
 =============================
 
-2025-11-0
+2025-11-1
 ----------
 
 **version 1.2.0**
@@ -42,7 +42,24 @@ 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`
-* # todo [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 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] docstring example for `VariogramCloud`, used parameters `values` and `geometries`
+* [docs] `ExperimentalIndicatorVariogram` and `TheoreticalIndicatorVariogram` - updated examples in docstrings
+* [docs] `TheoreticalVariogram`, and `build_theoretical_variogram()` examples
+* [docs] `calculate_spatial_dependence_index()` example
+* [bug/feature] `ExperimentalVariogram` class removes lags with NaN values (in covariance and semivariance)
+* [docs] Example in `interpolate_raster()` function
+
 
 2025-10-11
 ----------

docs/build/doctrees/nbsphinx/usage/tutorials/functional/1-2-semivariogram-models.ipynb

@@ -50,8 +50,8 @@
    "id": "6dfcd9fe-518d-41f0-aadc-8f7533aedc9d",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:49.266666Z",
-     "start_time": "2025-11-07T11:18:45.678869Z"
+     "end_time": "2025-11-23T08:50:01.777328Z",
+     "start_time": "2025-11-23T08:49:58.439351Z"
     }
    },
    "outputs": [],
@@ -101,8 +101,8 @@
    "id": "61b3c30e-f1b2-4f2d-aaae-a6806185adda",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:49.447721Z",
-     "start_time": "2025-11-07T11:18:49.444488Z"
+     "end_time": "2025-11-23T08:50:01.912910Z",
+     "start_time": "2025-11-23T08:50:01.908953Z"
     }
    },
    "outputs": [],
@@ -124,8 +124,8 @@
    "id": "2303386c-2a55-41c7-9fb5-144e743f45e6",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:49.566671Z",
-     "start_time": "2025-11-07T11:18:49.560988Z"
+     "end_time": "2025-11-23T08:50:01.931629Z",
+     "start_time": "2025-11-23T08:50:01.926204Z"
     }
    },
    "outputs": [],
@@ -139,8 +139,8 @@
    "id": "b42b9099-8ee9-4fdd-8d18-2003f492411c",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:50.378662Z",
-     "start_time": "2025-11-07T11:18:50.185546Z"
+     "end_time": "2025-11-23T08:50:02.138296Z",
+     "start_time": "2025-11-23T08:50:01.950167Z"
     }
    },
    "outputs": [
@@ -177,8 +177,8 @@
    "id": "3e86b2ca-ffd7-49e7-8a83-16842993e88a",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:52.657691Z",
-     "start_time": "2025-11-07T11:18:52.654528Z"
+     "end_time": "2025-11-23T08:50:02.156696Z",
+     "start_time": "2025-11-23T08:50:02.153888Z"
     }
    },
    "outputs": [],
@@ -192,8 +192,8 @@
    "id": "db00574b-f3b1-475f-aad3-394d563421a3",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:53.279858Z",
-     "start_time": "2025-11-07T11:18:53.057197Z"
+     "end_time": "2025-11-23T08:50:02.417012Z",
+     "start_time": "2025-11-23T08:50:02.177428Z"
     }
    },
    "outputs": [
@@ -228,8 +228,8 @@
    "id": "a6919e42-7c39-49ce-a0a3-2f6e60070c95",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:55.372100Z",
-     "start_time": "2025-11-07T11:18:55.366268Z"
+     "end_time": "2025-11-23T08:50:02.437458Z",
+     "start_time": "2025-11-23T08:50:02.431759Z"
     }
    },
    "outputs": [],
@@ -247,8 +247,8 @@
    "id": "36e911d6-1b9a-42e8-9805-b505f2eba475",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:55.946642Z",
-     "start_time": "2025-11-07T11:18:55.804948Z"
+     "end_time": "2025-11-23T08:50:02.608189Z",
+     "start_time": "2025-11-23T08:50:02.470519Z"
     }
    },
    "outputs": [
@@ -297,8 +297,8 @@
    "id": "bff02585-3196-4b19-977f-597f024b08bc",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:18:59.214984Z",
-     "start_time": "2025-11-07T11:18:59.209827Z"
+     "end_time": "2025-11-23T08:50:02.630136Z",
+     "start_time": "2025-11-23T08:50:02.626061Z"
     }
    },
    "outputs": [],
@@ -314,8 +314,8 @@
    "id": "e78b927f-c18d-475a-a4ef-4ba51829adfa",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:01.272309Z",
-     "start_time": "2025-11-07T11:19:01.268983Z"
+     "end_time": "2025-11-23T08:50:02.648854Z",
+     "start_time": "2025-11-23T08:50:02.645168Z"
     }
    },
    "outputs": [],
@@ -341,8 +341,8 @@
    "id": "a7f7fb90-7ed8-4c37-9e8d-29ac86ad1d61",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:44.392739Z",
-     "start_time": "2025-11-07T11:19:36.633082Z"
+     "end_time": "2025-11-23T08:50:12.120970Z",
+     "start_time": "2025-11-23T08:50:02.667490Z"
     }
    },
    "outputs": [],
@@ -361,8 +361,8 @@
    "id": "b1cffc47-a5db-4b7d-99db-2a6c88786ab0",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:44.603869Z",
-     "start_time": "2025-11-07T11:19:44.457421Z"
+     "end_time": "2025-11-23T08:50:12.357585Z",
+     "start_time": "2025-11-23T08:50:12.193714Z"
     }
    },
    "outputs": [
@@ -401,8 +401,8 @@
    "id": "d425b5d3-cfe6-4796-9c3b-40e39c43ddb0",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:44.650457Z",
-     "start_time": "2025-11-07T11:19:44.647501Z"
+     "end_time": "2025-11-23T08:50:12.405658Z",
+     "start_time": "2025-11-23T08:50:12.402537Z"
     }
    },
    "outputs": [],
@@ -438,8 +438,8 @@
    "id": "c7638281-61b1-421a-bed7-899c2510dfd7",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:45.895731Z",
-     "start_time": "2025-11-07T11:19:45.887806Z"
+     "end_time": "2025-11-23T08:50:12.453692Z",
+     "start_time": "2025-11-23T08:50:12.445959Z"
     }
    },
    "outputs": [],
@@ -510,8 +510,8 @@
    "id": "d52f4e78-2c2e-4110-95ea-c0c77450fa86",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:47.432571Z",
-     "start_time": "2025-11-07T11:19:47.297074Z"
+     "end_time": "2025-11-23T08:50:12.626781Z",
+     "start_time": "2025-11-23T08:50:12.505985Z"
     }
    },
    "outputs": [
@@ -538,8 +538,8 @@
    "id": "3bfe9935-6101-4586-8648-1ce217b91362",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:47.772684Z",
-     "start_time": "2025-11-07T11:19:47.641158Z"
+     "end_time": "2025-11-23T08:50:12.799736Z",
+     "start_time": "2025-11-23T08:50:12.671527Z"
     }
    },
    "outputs": [
@@ -566,8 +566,8 @@
    "id": "128dad7a-2499-471f-9100-550c869ed7b5",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:48.179193Z",
-     "start_time": "2025-11-07T11:19:48.047500Z"
+     "end_time": "2025-11-23T08:50:13.004317Z",
+     "start_time": "2025-11-23T08:50:12.850483Z"
     }
    },
    "outputs": [
@@ -594,8 +594,8 @@
    "id": "f8743b52-08a1-48d1-b771-f3562e6e124f",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:48.524467Z",
-     "start_time": "2025-11-07T11:19:48.385965Z"
+     "end_time": "2025-11-23T08:50:13.201969Z",
+     "start_time": "2025-11-23T08:50:13.064986Z"
     }
    },
    "outputs": [
@@ -622,8 +622,8 @@
    "id": "ed2986f1-dcb2-4efd-9d3a-350690a670d0",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:49.104245Z",
-     "start_time": "2025-11-07T11:19:48.975165Z"
+     "end_time": "2025-11-23T08:50:13.412102Z",
+     "start_time": "2025-11-23T08:50:13.249402Z"
     }
    },
    "outputs": [
@@ -650,8 +650,8 @@
    "id": "a7fbbc6d-03ff-4c58-a943-0f266b85aae3",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:49.606402Z",
-     "start_time": "2025-11-07T11:19:49.462958Z"
+     "end_time": "2025-11-23T08:50:13.605266Z",
+     "start_time": "2025-11-23T08:50:13.458678Z"
     }
    },
    "outputs": [
@@ -678,8 +678,8 @@
    "id": "3ee590a9-35aa-4eb2-8fd0-3a76222ce445",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:50.028243Z",
-     "start_time": "2025-11-07T11:19:49.898376Z"
+     "end_time": "2025-11-23T08:50:13.784928Z",
+     "start_time": "2025-11-23T08:50:13.657248Z"
     }
    },
    "outputs": [
@@ -730,8 +730,8 @@
    "id": "58a7316a-60bf-450e-bd16-37c0d51f96c3",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:19:55.189013Z",
-     "start_time": "2025-11-07T11:19:54.960558Z"
+     "end_time": "2025-11-23T08:50:14.119910Z",
+     "start_time": "2025-11-23T08:50:13.828898Z"
     }
    },
    "outputs": [
@@ -807,7 +807,12 @@
    "cell_type": "code",
    "execution_count": null,
    "id": "bb5e080fa23c755b",
-   "metadata": {},
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2025-11-23T08:50:14.173193Z",
+     "start_time": "2025-11-23T08:50:14.171260Z"
+    }
+   },
    "outputs": [],
    "source": []
   }

docs/build/doctrees/nbsphinx/usage/tutorials/functional/1-3-spatial-dependency-index.ipynb

@@ -93,8 +93,8 @@
    "id": "2341aa78e62d7ccb",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:30:04.358783Z",
-     "start_time": "2025-11-07T11:30:01.112010Z"
+     "end_time": "2025-11-23T08:54:18.550665Z",
+     "start_time": "2025-11-23T08:54:15.406086Z"
     }
    },
    "outputs": [],
@@ -110,8 +110,8 @@
    "id": "2114c4c981cd72f0",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:30:07.551854Z",
-     "start_time": "2025-11-07T11:30:07.548160Z"
+     "end_time": "2025-11-23T08:54:18.719293Z",
+     "start_time": "2025-11-23T08:54:18.716188Z"
     }
    },
    "outputs": [],
@@ -136,8 +136,8 @@
    "id": "7efad3523a0a4ee5",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:30:09.216854Z",
-     "start_time": "2025-11-07T11:30:09.196873Z"
+     "end_time": "2025-11-23T08:54:18.759637Z",
+     "start_time": "2025-11-23T08:54:18.740409Z"
     }
    },
    "outputs": [
@@ -253,8 +253,8 @@
    "id": "4526739f05341efb",
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2025-11-07T11:31:10.172971Z",
-     "start_time": "2025-11-07T11:31:08.028342Z"
+     "end_time": "2025-11-23T08:54:21.322633Z",
+     "start_time": "2025-11-23T08:54:18.893658Z"
     }
    },
    "outputs": [