Skip to content

Commit

Permalink
New version preparations
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonMolinsky committed Aug 18, 2023
1 parent e275d21 commit f228a38
Show file tree
Hide file tree
Showing 141 changed files with 1,700 additions and 1,747 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
![status](https://joss.theoj.org/papers/3f87f562264c4e5174d9e6ed6d8812aa/status.svg) ![License](https://img.shields.io/github/license/szymon-datalions/pyinterpolate) ![Documentation Status](https://readthedocs.org/projects/pyinterpolate/badge/?version=latest) [![CodeFactor](https://www.codefactor.io/repository/github/dataverselabs/pyinterpolate/badge)](https://www.codefactor.io/repository/github/dataverselabs/pyinterpolate)

![Pyinterpolate](https://github.com/DataverseLabs/pyinterpolate/blob/main/logov04.jpg?raw=true "Pyinterpolate logo")
![Pyinterpolate](https://github.com/DataverseLabs/pyinterpolate/blob/main/pyinterpolate-banner.png "Pyinterpolate logo")

# Pyinterpolate

**version 0.4.2** - *Kharkiv*
**version 0.5** - *Kharkiv*

---

Expand Down Expand Up @@ -130,7 +130,7 @@ conda activate [YOUR ENV NAME]

### pip installation

With **Python>=3.7** and system ```libspatialindex_c.so``` dependencies you may install package by simple command:
With **Python>=3.8** and system ```libspatialindex_c.so``` dependencies you may install package by simple command:

```
pip install pyinterpolate
Expand Down Expand Up @@ -175,7 +175,7 @@ Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point

Core requirements and dependencies are:

* Python >= 3.8 (Python 3.7 may be used with `pip` installation but it won't be supported in the future).
* Python >= 3.8
* descartes
* geopandas
* matplotlib
Expand All @@ -189,7 +189,8 @@ Core requirements and dependencies are:
* prettytable
* pandas
* dask
* dbscan
* hdbscan
* Pillow

You may check a specific version of requirements in the `setup.cfg` file.

Expand Down
1 change: 1 addition & 0 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ conda install -c conda-forge notebook pyinterpolate

Now you are able to run library from conda notebooks.

## Older issues (Python versions <3.8)

### The libspatialindex_c.so dependency error

Expand Down
4 changes: 3 additions & 1 deletion changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ Changes by date
2023-08-XX
----------

**version 0.4.3**
**version 0.5**

* (feature) `to_tiff()` function which writes kriging output from the `interpolate_raster()` function to `tiff` and `tfw` files,
* (debug) `safe` theoretical variogram models,
* (enhancement) `model_types` parameter can be string only (in the future the name of this parameter will be changed),
* (dependencies) fixed dependencies (`hdbscan` and `scikit-learn`),
* (enhancement) updated tutorials,
* (dependencies) End of support for Python 3.7.

2023-05-03
----------
Expand Down
Binary file modified docs/build/doctrees/api/api.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/datatypes/core.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/distance/distance.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/idw/idw.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/io/io.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/kriging/block/block_kriging.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/api/kriging/kriging.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/kriging/point/point_kriging.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/pipelines/data/download.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/api/pipelines/pipelines.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/validation/validation.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/variogram/block/block.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/api/variogram/indicator/indicator.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/api/variogram/variogram.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/api/viz/viz.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/community/community.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/community/doc_parts/contributors.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/community/doc_parts/forum.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/community/doc_parts/use_cases.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/developer/dev.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/developer/doc_parts/bugs.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/developer/doc_parts/development.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/developer/doc_parts/package.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/developer/doc_parts/reqs.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,7 @@
},
{
"cell_type": "markdown",
"id": "4bf42160",
"id": "4b01593e",
"metadata": {
"collapsed": false,
"pycharm": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@
},
{
"cell_type": "markdown",
"id": "2d08992f",
"id": "277ccabb",
"metadata": {
"collapsed": false,
"pycharm": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@
},
{
"cell_type": "markdown",
"id": "23e1b233",
"id": "5ef6502a",
"metadata": {
"collapsed": false,
"pycharm": {
Expand Down
Binary file modified docs/build/doctrees/science/biblio.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/science/cite.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/setup/setup.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/usage/good_practices.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/usage/learning_materials.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/usage/quickstart.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/usage/tutorials.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: ee87a8556c72b3581165e9001ddb9be5
config: 6cae5381bbd172d12d7d2899a779dbe2
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/build/html/_images/pyinterpolate-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,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.4.2 documentation</title>
<title>Overview: module code &#8212; Pyinterpolate 0.5 documentation</title>



Expand Down Expand Up @@ -108,7 +108,7 @@



<p class="title logo__title">Pyinterpolate 0.4.2 documentation</p>
<p class="title logo__title">Pyinterpolate 0.5 documentation</p>

</a></div>

Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/pyinterpolate/io/read_data.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyinterpolate.io.read_data &#8212; Pyinterpolate 0.4.1 documentation</title>
<title>pyinterpolate.io.read_data &#8212; Pyinterpolate 0.5 documentation</title>



Expand Down Expand Up @@ -108,7 +108,7 @@



<p class="title logo__title">Pyinterpolate 0.4.1 documentation</p>
<p class="title logo__title">Pyinterpolate 0.5 documentation</p>

</a></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyinterpolate.processing.preprocessing.blocks &#8212; Pyinterpolate 0.4.1 documentation</title>
<title>pyinterpolate.processing.preprocessing.blocks &#8212; Pyinterpolate 0.5 documentation</title>



Expand Down Expand Up @@ -108,7 +108,7 @@



<p class="title logo__title">Pyinterpolate 0.4.1 documentation</p>
<p class="title logo__title">Pyinterpolate 0.5 documentation</p>

</a></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyinterpolate.variogram.indicator.indicator_variogram &#8212; Pyinterpolate 0.4.1 documentation</title>
<title>pyinterpolate.variogram.indicator.indicator_variogram &#8212; Pyinterpolate 0.5 documentation</title>



Expand Down Expand Up @@ -108,7 +108,7 @@



<p class="title logo__title">Pyinterpolate 0.4.1 documentation</p>
<p class="title logo__title">Pyinterpolate 0.5 documentation</p>

</a></div>

Expand Down Expand Up @@ -683,7 +683,8 @@ <h1>Source code for pyinterpolate.variogram.indicator.indicator_variogram</h1><d
<span class="sd"> model_type : str, default = &quot;linear&quot;</span>
<span class="sd"> The name of a modeling function. Available models:</span>

<span class="sd"> - &#39;basic&#39; : linear and spherical models are tested,</span>
<span class="sd"> - &#39;all&#39;,</span>
<span class="sd"> - &#39;safe&#39; : linear, power and spherical models,</span>
<span class="sd"> - &#39;exponential&#39;,</span>
<span class="sd"> - &#39;gaussian&#39;,</span>
<span class="sd"> - &#39;linear&#39;,</span>
Expand Down Expand Up @@ -791,9 +792,6 @@ <h1>Source code for pyinterpolate.variogram.indicator.indicator_variogram</h1><d

<span class="n">experimental_models</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">experimental_indicator_variogram</span><span class="o">.</span><span class="n">experimental_models</span>

<span class="k">if</span> <span class="n">model_type</span> <span class="o">==</span> <span class="s1">&#39;basic&#39;</span><span class="p">:</span>
<span class="n">model_type</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;linear&#39;</span><span class="p">,</span> <span class="s1">&#39;spherical&#39;</span><span class="p">]</span>

<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">experimental</span> <span class="ow">in</span> <span class="n">experimental_models</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">theo</span> <span class="o">=</span> <span class="n">TheoreticalVariogram</span><span class="p">()</span>
<span class="n">theo</span><span class="o">.</span><span class="n">autofit</span><span class="p">(</span><span class="n">experimental_variogram</span><span class="o">=</span><span class="n">experimental</span><span class="p">,</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyinterpolate.variogram.regularization.deconvolution &#8212; Pyinterpolate 0.4.1 documentation</title>
<title>pyinterpolate.variogram.regularization.deconvolution &#8212; Pyinterpolate 0.5 documentation</title>



Expand Down Expand Up @@ -108,7 +108,7 @@



<p class="title logo__title">Pyinterpolate 0.4.1 documentation</p>
<p class="title logo__title">Pyinterpolate 0.5 documentation</p>

</a></div>

Expand Down Expand Up @@ -677,7 +677,7 @@ <h1>Source code for pyinterpolate.variogram.regularization.deconvolution</h1><di
<span class="n">agg_direction</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">agg_tolerance</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">variogram_weighting_method</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;closest&quot;</span><span class="p">,</span>
<span class="n">model_types</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;basic&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">model_types</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;safe&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Function fits given areal data variogram into point support variogram - it is the first step of regularization</span>
<span class="sd"> process.</span>
Expand Down Expand Up @@ -735,11 +735,11 @@ <h1>Source code for pyinterpolate.variogram.regularization.deconvolution</h1><di
<span class="sd"> - **distant**: lags that are further away have bigger weights,</span>
<span class="sd"> - **dense**: error is weighted by the number of point pairs within a lag - more pairs, lesser weight.</span>

<span class="sd"> model_types : str or List, default=&#39;basic&#39;</span>
<span class="sd"> model_types : str, default=&#39;safe&#39;</span>
<span class="sd"> List of modeling functions or a name of a single function. Available models:</span>

<span class="sd"> - &#39;all&#39; - the same as list with all models,</span>
<span class="sd"> - &#39;basic&#39; - [&#39;exponential&#39;, &#39;linear&#39;, &#39;power&#39;, &#39;spherical&#39;],</span>
<span class="sd"> - &#39;safe&#39; - [&#39;linear&#39;, &#39;power&#39;, &#39;spherical&#39;],</span>
<span class="sd"> - &#39;circular&#39;,</span>
<span class="sd"> - &#39;cubic&#39;,</span>
<span class="sd"> - &#39;exponential&#39;,</span>
Expand All @@ -765,7 +765,7 @@ <h1>Source code for pyinterpolate.variogram.regularization.deconvolution</h1><di
<span class="bp">self</span><span class="o">.</span><span class="n">direction</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">agg_direction</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">tolerance</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">agg_tolerance</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weighting_method</span> <span class="o">=</span> <span class="n">variogram_weighting_method</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model_types</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parse_model_types</span><span class="p">(</span><span class="n">model_types</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model_types</span> <span class="o">=</span> <span class="n">model_types</span>

<span class="c1"># Compute experimental variogram of areal data</span>
<span class="n">areal_centroids</span> <span class="o">=</span> <span class="n">get_areal_centroids_from_agg</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">agg</span><span class="p">)</span>
Expand Down Expand Up @@ -956,7 +956,7 @@ <h1>Source code for pyinterpolate.variogram.regularization.deconvolution</h1><di
<span class="n">agg_direction</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">agg_tolerance</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">variogram_weighting_method</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;closest&quot;</span><span class="p">,</span>
<span class="n">model_types</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;basic&#39;</span><span class="p">,</span>
<span class="n">model_types</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;safe&#39;</span><span class="p">,</span>
<span class="n">max_iters</span><span class="o">=</span><span class="mi">25</span><span class="p">,</span>
<span class="n">limit_deviation_ratio</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span>
<span class="n">minimum_deviation_decrease</span><span class="o">=</span><span class="mf">0.01</span><span class="p">,</span>
Expand Down Expand Up @@ -1017,11 +1017,11 @@ <h1>Source code for pyinterpolate.variogram.regularization.deconvolution</h1><di
<span class="sd"> - **distant**: lags that are further away have bigger weights,</span>
<span class="sd"> - **dense**: error is weighted by the number of point pairs within a lag - more pairs, lesser weight.</span>

<span class="sd"> model_types : str or List, default=&#39;basic&#39;</span>
<span class="sd"> model_types : str, default=&#39;safe&#39;</span>
<span class="sd"> List of modeling functions or a name of a single function. Available models:</span>

<span class="sd"> - &#39;all&#39; - the same as list with all models,</span>
<span class="sd"> - &#39;basic&#39; - [&#39;exponential&#39;, &#39;linear&#39;, &#39;power&#39;, &#39;spherical&#39;],</span>
<span class="sd"> - &#39;safe&#39; - [&#39;linear&#39;, &#39;power&#39;, &#39;spherical&#39;],</span>
<span class="sd"> - &#39;circular&#39;,</span>
<span class="sd"> - &#39;cubic&#39;,</span>
<span class="sd"> - &#39;exponential&#39;,</span>
Expand Down Expand Up @@ -1187,50 +1187,6 @@ <h1>Source code for pyinterpolate.variogram.regularization.deconvolution</h1><di
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span>

<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_parse_model_types</span><span class="p">(</span><span class="n">model_types</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The first level check and parser for model types.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> model_types : List or str</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> mtypes : List</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">all_models</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;circular&#39;</span><span class="p">,</span>
<span class="s1">&#39;cubic&#39;</span><span class="p">,</span>
<span class="s1">&#39;exponential&#39;</span><span class="p">,</span>
<span class="s1">&#39;gaussian&#39;</span><span class="p">,</span>
<span class="s1">&#39;linear&#39;</span><span class="p">,</span>
<span class="s1">&#39;power&#39;</span><span class="p">,</span>
<span class="s1">&#39;spherical&#39;</span>
<span class="p">]</span>

<span class="n">basic_models</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;exponential&#39;</span><span class="p">,</span>
<span class="s1">&#39;linear&#39;</span><span class="p">,</span>
<span class="s1">&#39;power&#39;</span><span class="p">,</span>
<span class="s1">&#39;spherical&#39;</span>
<span class="p">]</span>

<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model_types</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">if</span> <span class="n">model_types</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">all_models</span>
<span class="k">elif</span> <span class="n">model_types</span> <span class="o">==</span> <span class="s1">&#39;basic&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">basic_models</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">model_types</span><span class="p">]</span>

<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model_types</span><span class="p">,</span> <span class="n">Collection</span><span class="p">):</span>
<span class="k">return</span> <span class="n">model_types</span>

<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Unknown Type of the input, model_types parameter takes str or List as an input.&#39;</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">_rescale_optimal_theoretical_model</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand Down
Loading

0 comments on commit f228a38

Please sign in to comment.