Skip to content

Commit 63f9a44

Browse files
committed
docs(poetry): add poetry installation instructions
1 parent d5cc521 commit 63f9a44

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

INSTALL

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ Use PyPI and pip
3636

3737
Downloads the code from PyPI and runs the setup for you with installation and Cython (if preinstalled)
3838

39+
40+
Use Poetry
41+
================
42+
43+
poetry add openpiv
44+
45+
3946
Bleeding edge development version
4047
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4148

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,16 @@ Use PyPI: <https://pypi.python.org/pypi/OpenPIV>:
3737
## Or `conda`
3838

3939
conda install -c alexlib openpiv
40+
41+
## Or [Poetry](https://python-poetry.org/)
42+
43+
poetry add openpiv
4044

4145

4246
### To build from source
4347

48+
<!-- TODO: Change this build method to use poetry -->
49+
4450
Download the package from the Github: https://github.com/OpenPIV/openpiv-python/archive/master.zip
4551
or clone using git
4652

@@ -87,7 +93,8 @@ These and many additional examples are in another repository: [OpenPIV-Python-Ex
8793
11. [David Bohringer](https://github.com/davidbhr)
8894
12. [Erich Zimmer](https://github.com/ErichZimmer)
8995
13. [Peter Vennemann](https://github.com/eguvep)
90-
14. [Lento Manickathan](https://github.com/lento234)
96+
14. [Lento Manickathan](https://github.com/lento234)
97+
15. [Yuri Ishizawa](https://github.com/yuriishizawa)
9198

9299

93100
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.

0 commit comments

Comments
 (0)