Merge pull request #25 from ericyang125/main

Improve readability and performance of gpu-accelerated piv functions.

Author: alexlib

.gitignore

@@ -22,4 +22,8 @@ openpiv/examples/notebooks/*.html
 openpiv/examples/notebooks/test_3d/
 Open_PIV_results_*
 openpiv/docs/.vscode/
+openpiv/docs/_build/
 openpiv/examples/.vscode/settings.json
+openpiv/docs/_build/doctrees/environment.pickle
+openpiv/docs/src/test1.vec
+openpiv/test/OpenPIV_results_16_/field_A0000.png

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: openpiv/docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: openpiv/docs/requirements.txt

CHANGES.txt

@@ -16,4 +16,5 @@ v0.23.2 - added mask_coordinats to preprocess, allows to use dynamic_masking to
     with the first_pass. Both first_pass and multi_pass now apply filtering externally
 
 v0.23.6 - removed widim.pyx, no Cython modules anymore
+v0.23.7 - @ErichZimmer provided rectangular windows and we moved the test cases to another repo openpiv-python-examples
 

INSTALL renamed to INSTALL.txt

@@ -1,6 +1,6 @@
-========================
-Installation instruction
-========================
+=========================
+Installation instructions
+=========================
 
 Dependencies
 ============
@@ -9,50 +9,16 @@ OpenPIV would not have been possible if other great open source projects did not
 exist. We make extensive use of code and tools that other people have created, so
 you should install them before you can use OpenPIV.
 
-The dependencies are:
+The main dependencies are:
 
 * `python <http://python.org/>`_
 * `scipy <http://numpy.scipy.org/>`_
 * `numpy <http://www.scipy.org/>`_
-* `cython <http://cython.org/>`_
 * `scikit-image <http://scikit-image.org/>`_
 
 On all the platforms, the binary Anaconda installation is recommended. 
 Visit https://www.continuum.io/downloads
 
-How to install the dependencies on Linux (detailed)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-On a Linux platform installing these dependencies should be trick. Often, if not always,
-python is installed by default, while the other dependencies should appear in your package
-manager.
-
-/**
-Example of installation procedure on Ubuntu
-(tested for version 10.04 to 12.10)
-	*open a terminal & install modules
-sudo apt-get install python-pip
-sudo apt-get install python-setuptools python-dev build-essential
-sudo pip install numpy
-sudo pip install
-sudo apt-get install libatlas-base-dev gfortran
-sudo pip install scipy
-sudo pip install cython
-sudo apt-get install python-matplotlib
-pip install -U scikit-image
-	*you will need version 1.6.0 or later of the numpy module. 
-	*If pip cannot find the right version, easyinstall should work:
-         	sudo easyinstall numpy
-	*now download openpiv source code and move to the openpiv directory
-	*then install openpiv:
-sudo python setup.py install
-	*open a new terminal & test openpiv
-openpiv
-	*if you get an error such as "unknown module lib" try to logout or try to modify the PYTHONPATH variable by adding
-	      export PYTHONPATH=$PYTHONPATH:[path-to-openpiv-directory]  
-	to your ~/.bashrc file and then logout or:
-	 source ~/.bashrc
-**/
-
 
 Get OpenPIV source code!
 ========================