Merge branch 'master'

Conflicts:
	openpiv/validation.py
	setup.py

Author: alexlib

.github/workflows/build.yml

@@ -78,6 +78,6 @@ jobs:
 
       - uses: pypa/gh-action-pypi-publish@master
         with:
-          user: __token__
+          user: pypi-openpiv
           password: ${{ secrets.pypi_password }}
           # To test: repository_url: https://test.pypi.org/legacy/

.gitignore

@@ -15,3 +15,7 @@ OpenPIV.egg-info
 .vscode/settings.json
 *.so
 
+tmp.png
+openpiv/examples/notebooks/*.html
+openpiv/examples/notebooks/test_3d/
+Open_PIV_results_*

README.md

@@ -1,7 +1,8 @@
 # OpenPIV
 [![Build Status](https://travis-ci.org/OpenPIV/openpiv-python.svg?branch=master)](https://travis-ci.org/OpenPIV/openpiv-python)
 ![Build and upload to PyPI](https://github.com/OpenPIV/openpiv-python/workflows/Build%20and%20upload%20to%20PyPI/badge.svg)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4320056.svg)](https://doi.org/10.5281/zenodo.4320056)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4409178.svg)](https://doi.org/10.5281/zenodo.4409178)
+
 
 
 ![PyPI](https://img.shields.io/pypi/v/openpiv)
@@ -15,7 +16,7 @@
 
 
 OpenPIV consists in a Python and Cython modules for scripting and executing the analysis of 
-a set of PIV image pairs. In addition, a Qt graphical user interface is in 
+a set of PIV image pairs. In addition, a Qt and Tk graphical user interfaces are in 
 development, to ease the use for those users who don't have python skills.
 
 ## Warning
@@ -95,7 +96,8 @@ The OpenPIV documentation is available on the project web page at <http://openpi
 Copyright statement: `smoothn.py` is a Python version of `smoothn.m` originally created by D. Garcia [https://de.mathworks.com/matlabcentral/fileexchange/25634-smoothn], written by Prof. Lewis and available on Github [https://github.com/profLewis/geogg122/blob/master/Chapter5_Interpolation/python/smoothn.py]. We include a version of it in the `openpiv` folder for convenience and preservation. We are thankful to the original authors for releasing their work as an open source. OpenPIV license does not relate to this code. Please communicate with the authors regarding their license. 
 
 ## How to cite this work
-OpenPIV/openpiv-python:  [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4320056.svg)](https://doi.org/10.5281/zenodo.4320056)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4409178.svg)](https://doi.org/10.5281/zenodo.4409178)
+
 
 
 

openpiv/docs/src/developers.rst

@@ -44,19 +44,20 @@ Things OpenPIV currently needs, (in order of importance)
 * A good graphical user interface (in progress)
 
 
-How to test all the notebooks
+How to test all the notebooks::
 -----------------------------
 
+    conda create -n openpiv
+    conda activate openpiv
+    conda install -c conda-forge openpiv
     conda install ipykernel  
-    
     python -m ipykernel install --user --name openpiv --display-name="openpiv"  
-    
     jupyter nbconvert --to html --ExecutePreprocessor.kernel_name=openpiv --execute *.ipynb  
     
 
 Then open the `openpiv/examples/notebooks` and check the HTML files. If one of those will fail, the error message will be in the command shell
 
-If you need to install cv2
+If you need to install cv2::
 --------------------------
 
     conda install -c conda-forge opencv

openpiv/examples/notebooks/PIV_3D_example.ipynb

@@ -130,7 +130,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "100%|██████████| 14/14 [00:00<00:00, 180.99it/s]\n"
+      "100%|██████████| 14/14 [00:00<00:00, 145.38it/s]\n"
      ]
     }
    ],
@@ -446,7 +446,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "100%|██████████| 14/14 [01:12<00:00,  5.16s/it]\n"
+      "100%|██████████| 14/14 [01:09<00:00,  4.99s/it]\n"
      ]
     }
    ],
@@ -625,7 +625,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.8.5"
   }
  },
  "nbformat": 4,

openpiv/examples/notebooks/all_test_cases_sample.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# compare the OpenPIV Python with PIVLab\n"
+    "# use image mask"
    ]
   },
   {