Simple distance calculation and bins selection added for version 1.0

DataverseLabs · Feb 18, 2024 · 5475871 · 5475871
1 parent fda2355
commit 5475871
Show file tree

Hide file tree

Showing 140 changed files with 2,400 additions and 1,592 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 # Pyinterpolate
 
-**version 0.5** - *Mykolaiv*
+**version 0.5.1** - *Mykolaiv*
 
 ---
 

diff --git a/changelog.rst b/changelog.rst
@@ -6,13 +6,14 @@ Pyinterpolate is the Python library for **geostatistics** and **spatial statisti
 Changes by date
 ===============
 
-2024-02-
---------
+2024-02-19
+----------
 
 **version 0.5.1** (*pre production development*)
 
-* (refactoring) `point_distance` and `select_values_in_range` functions,
-*
+* (refactoring) `calc_point_to_point_distance` function refactored to `point_distance`, changed input parameters' schema,
+* (refactoring) new selection method for unequally spaced bins: `select_values_between_lags`
+* (debug) `np.float` type casting has been changed to `float`
 
 2023-09-16
 ----------

diff --git a/docs/build/doctrees/api/api.doctree b/docs/build/doctrees/api/api.doctree
diff --git a/docs/build/doctrees/api/datatypes/core.doctree b/docs/build/doctrees/api/datatypes/core.doctree
diff --git a/docs/build/doctrees/api/distance/distance.doctree b/docs/build/doctrees/api/distance/distance.doctree
diff --git a/docs/build/doctrees/api/idw/idw.doctree b/docs/build/doctrees/api/idw/idw.doctree
diff --git a/docs/build/doctrees/api/io/io.doctree b/docs/build/doctrees/api/io/io.doctree
diff --git a/docs/build/doctrees/api/kriging/block/block_kriging.doctree b/docs/build/doctrees/api/kriging/block/block_kriging.doctree
diff --git a/docs/build/doctrees/api/kriging/indicator/indicator_kriging.doctree b/docs/build/doctrees/api/kriging/indicator/indicator_kriging.doctree
diff --git a/docs/build/doctrees/api/kriging/kriging.doctree b/docs/build/doctrees/api/kriging/kriging.doctree
diff --git a/docs/build/doctrees/api/kriging/point/point_kriging.doctree b/docs/build/doctrees/api/kriging/point/point_kriging.doctree
diff --git a/docs/build/doctrees/api/pipelines/data/download.doctree b/docs/build/doctrees/api/pipelines/data/download.doctree
diff --git a/docs/build/doctrees/api/pipelines/kriging_based/kriging_based_processes.doctree b/docs/build/doctrees/api/pipelines/kriging_based/kriging_based_processes.doctree
diff --git a/docs/build/doctrees/api/pipelines/pipelines.doctree b/docs/build/doctrees/api/pipelines/pipelines.doctree
diff --git a/docs/build/doctrees/api/validation/validation.doctree b/docs/build/doctrees/api/validation/validation.doctree
diff --git a/docs/build/doctrees/api/variogram/block/block.doctree b/docs/build/doctrees/api/variogram/block/block.doctree
diff --git a/docs/build/doctrees/api/variogram/deconvolution/deconvolution.doctree b/docs/build/doctrees/api/variogram/deconvolution/deconvolution.doctree
diff --git a/docs/build/doctrees/api/variogram/experimental/experimental.doctree b/docs/build/doctrees/api/variogram/experimental/experimental.doctree
diff --git a/docs/build/doctrees/api/variogram/indicator/indicator.doctree b/docs/build/doctrees/api/variogram/indicator/indicator.doctree
diff --git a/docs/build/doctrees/api/variogram/theoretical/theoretical.doctree b/docs/build/doctrees/api/variogram/theoretical/theoretical.doctree
diff --git a/docs/build/doctrees/api/variogram/variogram.doctree b/docs/build/doctrees/api/variogram/variogram.doctree
diff --git a/docs/build/doctrees/api/viz/viz.doctree b/docs/build/doctrees/api/viz/viz.doctree
diff --git a/docs/build/doctrees/community/community.doctree b/docs/build/doctrees/community/community.doctree
diff --git a/docs/build/doctrees/community/doc_parts/contributors.doctree b/docs/build/doctrees/community/doc_parts/contributors.doctree
diff --git a/docs/build/doctrees/community/doc_parts/forum.doctree b/docs/build/doctrees/community/doc_parts/forum.doctree
diff --git a/docs/build/doctrees/community/doc_parts/use_cases.doctree b/docs/build/doctrees/community/doc_parts/use_cases.doctree
diff --git a/docs/build/doctrees/developer/dev.doctree b/docs/build/doctrees/developer/dev.doctree
diff --git a/docs/build/doctrees/developer/doc_parts/bugs.doctree b/docs/build/doctrees/developer/doc_parts/bugs.doctree
diff --git a/docs/build/doctrees/developer/doc_parts/development.doctree b/docs/build/doctrees/developer/doc_parts/development.doctree
diff --git a/docs/build/doctrees/developer/doc_parts/package.doctree b/docs/build/doctrees/developer/doc_parts/package.doctree
diff --git a/docs/build/doctrees/developer/doc_parts/reqs.doctree b/docs/build/doctrees/developer/doc_parts/reqs.doctree
diff --git a/docs/build/doctrees/developer/doc_parts/tests_and_contribution.doctree b/docs/build/doctrees/developer/doc_parts/tests_and_contribution.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/science/biblio.doctree b/docs/build/doctrees/science/biblio.doctree
diff --git a/docs/build/doctrees/science/cite.doctree b/docs/build/doctrees/science/cite.doctree
diff --git a/docs/build/doctrees/setup/setup.doctree b/docs/build/doctrees/setup/setup.doctree
diff --git a/docs/build/doctrees/usage/good_practices.doctree b/docs/build/doctrees/usage/good_practices.doctree
diff --git a/docs/build/doctrees/usage/learning_materials.doctree b/docs/build/doctrees/usage/learning_materials.doctree
diff --git a/docs/build/doctrees/usage/quickstart.doctree b/docs/build/doctrees/usage/quickstart.doctree
diff --git a/docs/build/doctrees/usage/tutorials.doctree b/docs/build/doctrees/usage/tutorials.doctree
diff --git a/docs/build/doctrees/usage/tutorials/A11-Semivariogram-Estimation.doctree b/docs/build/doctrees/usage/tutorials/A11-Semivariogram-Estimation.doctree
diff --git a/docs/build/doctrees/usage/tutorials/A12-Theoretical-Models.doctree b/docs/build/doctrees/usage/tutorials/A12-Theoretical-Models.doctree
diff --git a/docs/build/doctrees/usage/tutorials/A13-Spatial-Dependence-Index.doctree b/docs/build/doctrees/usage/tutorials/A13-Spatial-Dependence-Index.doctree
diff --git a/docs/build/doctrees/usage/tutorials/A21-Directional-Semivariogram.doctree b/docs/build/doctrees/usage/tutorials/A21-Directional-Semivariogram.doctree
diff --git a/docs/build/doctrees/usage/tutorials/A22-Variogram-Points-Cloud.doctree b/docs/build/doctrees/usage/tutorials/A22-Variogram-Points-Cloud.doctree
diff --git a/...rees/usage/tutorials/A23-Experimental-Variogram-and-Variogram-Point-Cloud-classes.doctree b/...rees/usage/tutorials/A23-Experimental-Variogram-and-Variogram-Point-Cloud-classes.doctree
diff --git a/docs/build/doctrees/usage/tutorials/B11-Ordinary-and-Simple-Kriging.doctree b/docs/build/doctrees/usage/tutorials/B11-Ordinary-and-Simple-Kriging.doctree
diff --git a/docs/build/doctrees/usage/tutorials/B12-Kriging-Benchmarking.doctree b/docs/build/doctrees/usage/tutorials/B12-Kriging-Benchmarking.doctree
diff --git a/docs/build/doctrees/usage/tutorials/B13-Outliers-and-Kriging.doctree b/docs/build/doctrees/usage/tutorials/B13-Outliers-and-Kriging.doctree
diff --git a/docs/build/doctrees/usage/tutorials/B21-Directional-Ordinary-Kriging.doctree b/docs/build/doctrees/usage/tutorials/B21-Directional-Ordinary-Kriging.doctree
diff --git a/docs/build/doctrees/usage/tutorials/C11-Blocks-to-Points-with-Ordinary-Kriging.doctree b/docs/build/doctrees/usage/tutorials/C11-Blocks-to-Points-with-Ordinary-Kriging.doctree
diff --git a/docs/build/doctrees/usage/tutorials/C12-Semivariogram-Regularization.doctree b/docs/build/doctrees/usage/tutorials/C12-Semivariogram-Regularization.doctree
diff --git a/docs/build/doctrees/usage/tutorials/C13-Poisson-Kriging-Centroid-based.doctree b/docs/build/doctrees/usage/tutorials/C13-Poisson-Kriging-Centroid-based.doctree
diff --git a/docs/build/doctrees/usage/tutorials/C14-Poisson-Kriging-Area-to-Area.doctree b/docs/build/doctrees/usage/tutorials/C14-Poisson-Kriging-Area-to-Area.doctree
diff --git a/docs/build/doctrees/usage/tutorials/C15-Poisson-Kriging-Area-to-Point.doctree b/docs/build/doctrees/usage/tutorials/C15-Poisson-Kriging-Area-to-Point.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f4fcac24d7e2622fd34b98aa8fa53241
+config: 547607724c14a157e2d2e282259579a3
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -1,4 +1,5 @@
 
+
 <!DOCTYPE html>
 
 
@@ -7,7 +8,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; Pyinterpolate 0.5.0 documentation</title>
+    <title>Overview: module code &#8212; Pyinterpolate 0.5.1 documentation</title>
 
 
 
@@ -27,18 +28,21 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
-    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script src="../_static/documentation_options.js?v=70f82a29"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
-    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
-    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
-    <script src="../_static/copybutton.js?v=f281be69"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <script src="../_static/sphinx_highlight.js"></script>
+    <script src="../_static/clipboard.min.js"></script>
+    <script src="../_static/copybutton.js"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -104,7 +108,7 @@
 
 
 
-    <p class="title logo__title">Pyinterpolate 0.5.0 documentation</p>
+    <p class="title logo__title">Pyinterpolate 0.5.1 documentation</p>
 
 </a></div>
 
@@ -413,6 +417,7 @@
   <h1>All modules for which code is available</h1>
 <ul><li><a href="pyinterpolate/distance/distance.html">pyinterpolate.distance.distance</a></li>
 <li><a href="pyinterpolate/distance/gridding.html">pyinterpolate.distance.gridding</a></li>
+<li><a href="pyinterpolate/distance/point.html">pyinterpolate.distance.point</a></li>
 <li><a href="pyinterpolate/idw/idw.html">pyinterpolate.idw.idw</a></li>
 <li><a href="pyinterpolate/io/read_data.html">pyinterpolate.io.read_data</a></li>
 <li><a href="pyinterpolate/kriging/models/block/area_to_area_poisson_kriging.html">pyinterpolate.kriging.models.block.area_to_area_poisson_kriging</a></li>
@@ -477,15 +482,15 @@ <h1>All modules for which code is available</h1>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2023, Szymon Moliński.
+      © Copyright 2024, Szymon Moliński.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.4.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     <br/>
   </p>
 </div>

diff --git a/docs/build/html/_modules/pyinterpolate/distance/distance.html b/docs/build/html/_modules/pyinterpolate/distance/distance.html
@@ -8,7 +8,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pyinterpolate.distance.distance &#8212; Pyinterpolate 0.4.1 documentation</title>
+    <title>pyinterpolate.distance.distance &#8212; Pyinterpolate 0.5.1 documentation</title>
 
 
 
@@ -108,7 +108,7 @@
 
 
 
-    <p class="title logo__title">Pyinterpolate 0.4.1 documentation</p>
+    <p class="title logo__title">Pyinterpolate 0.5.1 documentation</p>
 
 </a></div>
 
@@ -424,6 +424,8 @@ <h1>Source code for pyinterpolate.distance.distance</h1><div class="highlight"><
 <span class="sd">Authors</span>
 <span class="sd">-------</span>
 <span class="sd">1. Szymon Moliński | @SimonMolinsky</span>
+
+<span class="sd">TODO: the file will be removed in version 1.0</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">Iterable</span>
@@ -438,6 +440,8 @@ <h1>Source code for pyinterpolate.distance.distance</h1><div class="highlight"><
 <span class="kn">from</span> <span class="nn">pyinterpolate.processing.preprocessing.blocks</span> <span class="kn">import</span> <span class="n">PointSupport</span>
 <span class="kn">from</span> <span class="nn">pyinterpolate.processing.transform.transform</span> <span class="kn">import</span> <span class="n">point_support_to_dict</span><span class="p">,</span> <span class="n">block_dataframe_to_dict</span>
 
+<span class="kn">from</span> <span class="nn">deprecation</span> <span class="kn">import</span> <span class="n">deprecated</span>
+
 
 <span class="k">def</span> <span class="nf">_calc_b2b_dist_from_array</span><span class="p">(</span><span class="n">blocks</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function calculates distances between blocks.</span>
@@ -725,7 +729,13 @@ <h1>Source code for pyinterpolate.distance.distance</h1><div class="highlight"><
     <span class="k">return</span> <span class="n">angles</span>
 
 
-<div class="viewcode-block" id="calc_point_to_point_distance"><a class="viewcode-back" href="../../../api/distance/distance.html#pyinterpolate.calc_point_to_point_distance">[docs]</a><span class="k">def</span> <span class="nf">calc_point_to_point_distance</span><span class="p">(</span><span class="n">points_a</span><span class="p">,</span> <span class="n">points_b</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<div class="viewcode-block" id="calc_point_to_point_distance"><a class="viewcode-back" href="../../../api/distance/distance.html#pyinterpolate.calc_point_to_point_distance">[docs]</a><span class="nd">@deprecated</span><span class="p">(</span>
+    <span class="n">deprecated_in</span><span class="o">=</span><span class="s1">&#39;0.5.1&#39;</span><span class="p">,</span>
+    <span class="n">removed_in</span><span class="o">=</span><span class="s1">&#39;1.0&#39;</span><span class="p">,</span>
+    <span class="n">current_version</span><span class="o">=</span><span class="s1">&#39;0.5.1&#39;</span><span class="p">,</span>
+    <span class="n">details</span><span class="o">=</span><span class="s2">&quot;Use `point_distance()` instead&quot;</span>
+<span class="p">)</span>
+<span class="k">def</span> <span class="nf">calc_point_to_point_distance</span><span class="p">(</span><span class="n">points_a</span><span class="p">,</span> <span class="n">points_b</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function calculates distances between two group of points of a single group to itself.</span>
 
 <span class="sd">    Parameters</span>
@@ -825,7 +835,7 @@ <h1>Source code for pyinterpolate.distance.distance</h1><div class="highlight"><
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2023, Szymon Moliński.
+      © Copyright 2024, Szymon Moliński.
       <br/>
 
   </p>
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ @@
     # Pyinterpolate
-    **version 0.5** - *Mykolaiv*
+    **version 0.5.1** - *Mykolaiv*
     ---
@@ Expand Down @@