diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ad1f8139..8dabad68 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,8 +1,8 @@ Changes - from version >= 1.x ============================= -2025-0 ------- +2025-10-11 +---------- **version 1.1.0** @@ -12,6 +12,7 @@ Changes - from version >= 1.x * [docs] updated missing DOI in Indicator Variogram * [enhancement] representative point in `Blocks` is sampled from the largest `Polygon` when `MultiPolygon` is passed * [enhancement] `Blocks` object might be altered during CRS transformation or new object might be created (`inplace` parameter and copying mechanism) +* [bug] incosistent documenation - `sill` represents *partial sill*, not *total sill*, and documentation might be misleading 2025-07-17 ---------- diff --git a/README.md b/README.md index a7061afa..657ec65a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Pyinterpolate -**version 1.0.3** +**version 1.1.0**  diff --git a/docs/build/doctrees/api/core/core.doctree b/docs/build/doctrees/api/core/core.doctree index 1e3ba20f..0089fcee 100644 Binary files a/docs/build/doctrees/api/core/core.doctree and b/docs/build/doctrees/api/core/core.doctree differ diff --git a/docs/build/doctrees/api/semivariogram/indicator.doctree b/docs/build/doctrees/api/semivariogram/indicator.doctree index 87bf1e53..92908b9e 100644 Binary files a/docs/build/doctrees/api/semivariogram/indicator.doctree and b/docs/build/doctrees/api/semivariogram/indicator.doctree differ diff --git a/docs/build/doctrees/api/semivariogram/theoretical.doctree b/docs/build/doctrees/api/semivariogram/theoretical.doctree index fcd85233..2a3ecfa1 100644 Binary files a/docs/build/doctrees/api/semivariogram/theoretical.doctree and b/docs/build/doctrees/api/semivariogram/theoretical.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 79bcab66..b1956989 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/usage/tutorials/functional/2-1-directional-semivariogram.doctree b/docs/build/doctrees/usage/tutorials/functional/2-1-directional-semivariogram.doctree index 80445774..595fc5ef 100644 Binary files a/docs/build/doctrees/usage/tutorials/functional/2-1-directional-semivariogram.doctree and b/docs/build/doctrees/usage/tutorials/functional/2-1-directional-semivariogram.doctree differ diff --git a/docs/build/html/_modules/pyinterpolate/core/data_models/blocks.html b/docs/build/html/_modules/pyinterpolate/core/data_models/blocks.html index 3a3aa37c..05bdcbb5 100644 --- a/docs/build/html/_modules/pyinterpolate/core/data_models/blocks.html +++ b/docs/build/html/_modules/pyinterpolate/core/data_models/blocks.html @@ -434,6 +434,7 @@
pyinterpolate 1.0.2 documentation
+pyinterpolate 1.1.0 documentation
pyinterpolate 1.0.2 documentation
+pyinterpolate 1.1.0 documentation
pyinterpolate 1.0.0 documentation
+pyinterpolate 1.1.0 documentation
pyinterpolate 1.0.0 documentation
+pyinterpolate 1.1.0 documentation
Function transforms Blocks CRS
When set to True then transform object’s instance on the fly, +otherwise return modified object and do leave the old instance +unchanged.
+How many bins are tested between
min_range and max_range.
If given, then sill is fixed to this value.
+Partial sill, or sill when nugget is set to zero. Total sill is +a sum of partial sill and nugget. If given, then partial sill +is fixed to this value.
The last n experimental semivariance records for sill estimation.
(Used only when sill_from_variance is set to False).
Estimate sill from the variance (semivariance at distance 0).
The minimal fraction of the value chosen with the sill estimation
-method. The value is: for sill_from_values - the mean of
-the last n_sill_values number of experimental semivariances,
-for sill_from_variance - the experimental variogram variance.
The minimal fraction of the variogram variance at lag 0 to
+find partial sill, 0 <= min_sill <= max_sill.
The maximum fraction of the value chosen with the sill estimation
-method. The value is: for sill_from_values - the mean of
-the last n_sill_values number of experimental semivariances,
-for sill_from_variance - the experimental variogram variance.
The maximum fraction of the variogram variance at lag 0 to find +partial sill.
How many equally spaced sill values are tested between
min_sill and max_sill.
The nugget parameter (bias at the zero distance).
A value at which dissimilarity is close to its maximum if model is -bounded. Otherwise, it is usually close to the observations variance.
+Partial sill, or sill when nugget is set to zero. Total sill is +a sum of partial sill and nugget. If given, then partial sill +is fixed to this value.
The semivariogram range is a distance at which spatial correlation might be observed. It shouldn’t be set at a distance larger than @@ -617,19 +618,21 @@
How many equally spaced ranges are tested between
min_range and max_range.
If given, then sill is fixed to this value.
+Partial sill, or sill when nugget is set to zero. Total sill is +a sum of partial sill and nugget. If given, then partial sill +is fixed to this value.
The last n experimental semivariance records for sill estimation.
(Used only when sill_from_variance is set to False).
Estimate sill from the variance (semivariance at distance 0).
The minimal fraction of the value chosen with the sill estimation +
The minimal fraction of the value chosen with the sill estimation
method. The value is: for sill_from_values - the mean of
the last n_sill_values number of experimental semivariances,
for sill_from_variance - the experimental variogram variance.
The maximum fraction of the value chosen with the sill estimation +
The maximum fraction of the value chosen with the sill estimation
method. The value is: for sill_from_values - the mean of
the last n_sill_values number of experimental semivariances,
for sill_from_variance - the experimental variogram variance.
A value at which dissimilarity is close to its maximum if model is -bounded. Otherwise, it is usually close to observations variance.
+Partial sill, or sill when nugget is set to zero. Total sill is +a sum of partial sill and nugget. If given, then partial sill +is fixed to this value.
The semivariogram range is a distance at which spatial correlation exists. It shouldn’t be set at a distance larger than a half @@ -940,13 +944,15 @@
How many equally spaced ranges are tested between
min_range and max_range.
If given, then sill is fixed to this value.
+Partial sill, or sill when nugget is set to zero. Total sill is +a sum of partial sill and nugget. If given, then partial sill +is fixed to this value.
The minimal fraction of the variogram variance at lag 0 to
-find a sill, 0 <= min_sill <= max_sill.
0 <= min_sill <= max_sill.
The maximum fraction of the variogram variance at lag 0 to find -a sill. It should be lower or equal to 1. +partial sill. It should be lower or equal to 1. It is possible to set it above 1, but then warning is printed.
How many equally spaced sill values are tested between @@ -993,7 +999,8 @@
Semivariogram nugget.
Semivariogram sill.
+Partial sill, difference between total sill and nugget. If given, +then partial sill is fixed to this value.
| \n | longitude | \nlatitude | \ndem | \n
|---|---|---|---|
| 0 | \n15.115241 | \n52.765146 | \n91.275597 | \n
| 1 | \n15.115241 | \n52.742790 | \n96.548294 | \n
| 2 | \n15.115241 | \n52.710706 | \n51.254551 | \n
| 3 | \n15.115241 | \n52.708844 | \n48.958282 | \n
| 4 | \n15.115241 | \n52.671378 | \n16.817863 | \n
| \n", + " | longitude | \n", + "latitude | \n", + "dem | \n", + "
|---|---|---|---|
| 0 | \n", + "15.115241 | \n", + "52.765146 | \n", + "91.275597 | \n", + "
| 1 | \n", + "15.115241 | \n", + "52.742790 | \n", + "96.548294 | \n", + "
| 2 | \n", + "15.115241 | \n", + "52.710706 | \n", + "51.254551 | \n", + "
| 3 | \n", + "15.115241 | \n", + "52.708844 | \n", + "48.958282 | \n", + "
| 4 | \n", + "15.115241 | \n", + "52.671378 | \n", + "16.817863 | \n", + "