pip installation

groussea · Apr 28, 2020 · 12a5d08 · 12a5d08
1 parent 19c22e4
commit 12a5d08
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 43 deletions.
diff --git a/ReadMe.md b/ReadMe.md
@@ -1,11 +1,9 @@
 
 # About
 
-OpyFlow : Python package for Optical Flow measurements.
+OpyFlow : Python package for Optical Flow measurements
 
-![PIV challenge](test/Test_case_PIV_Challenge_2014/gif/example_PIV_challenge.gif)
-
-Opyf is based on openCV and VTK libraries to detect good features to track, calculate the optical flow by the Lukas Kanade method and interpolate them on a mesh. The package contains also some rendering tools built with matplotlib. Velocities can be exported (csv,tecplot, vtk, hdf5).
+Opyflow is based on openCV and VTK libraries to detect good features to track, calculate their displacements by the Lukas Kanade method and interpolate them on a mesh. The package contains also some rendering tools built with matplotlib. Velocities can be exported (csv,tecplot, vtk, hdf5).
 For flow calculations, the process is mainly inspired on the openCV python sample [lktrack.py](https://github.com/opencv/opencv/blob/master/samples/python/lk_track.py).
 
 Author: Gauthier Rousseau
@@ -14,7 +12,13 @@ Corresponding e-mail : gauthier.rousseau@gmail.com
 
 ## Quick start
 
-Assuming that you already have an environment with python installed (<=3.7), run the following command from the package folder:
+Assuming that you already have an environment with python installed (<=3.7), run the following command on your terminal:
+
+```shell
+pip install opyf
+```
+
+or from the *opyflow* repository
 
 ```shell
 python setup.py install
@@ -45,7 +49,9 @@ opyf package contains two frames and one video for testing and practicing yourse
 
 - The two frames were extracted from the frame sequence of the Test case A of the *PIV Challenge 2014*
 
-When applied to the entire dataset, It can produce the [above](#about) result (see [Test PIV Challenge 2014 - Case A](test/Test_case_PIV_Challenge_2014/testPIVChallengeCaseA.md) for details on the procedure).
+![PIV challenge](test/Test_case_PIV_Challenge_2014/gif/example_PIV_challenge.gif)
+
+When applied to the entire dataset, It can produce the above result (see [Test PIV Challenge 2014 - Case A](test/Test_case_PIV_Challenge_2014/testPIVChallengeCaseA.md) for details on the procedure).
 
 - The video is a bird eye view video of a stream river taken by a drone and from which surface velocities can be extracted ([see the following python file for the different possible procedures](test/Test_Navizence/test_opyf_Navizence.py) ).
 
@@ -101,7 +107,7 @@ The test Folder:
     - [2018.07.04_Station_fixe_30m_sample.mp4](test/Test_Navizence/2018.07.04_Station_fixe_30m_sample.mp4)
     - [test_opyf_Navizence.py](test/Test_Navizence/test_opyf_Navizence.py)
 
-One test file performed on the PIV challenge 2014 caseA (images on<http://www.pivchallenge.org/pivchallenge4.html#case_a):>
+One test file performed on the [PIV challenge 2014 caseA](http://www.pivchallenge.org/pivchallenge4.html#case_a):
 The results are compared to the main findings of the challenge:
 ``-Kähler CJ, Astarita T, Vlachos PP, Sakakibara J, Hain R, Discetti S, Foy RL, Cierpka C, 2016, Main results of the 4th International PIV Challenge, Experiments in Fluids, 57: 97.''
 

diff --git a/setup.py b/setup.py
@@ -6,73 +6,57 @@
 @author: Gauthier Rousseau
 """
 
-# Always prefer setuptools over distutils
-from setuptools import setup, find_packages
 
-# To use a consistent encoding
+from setuptools import setup, find_packages
 from codecs import open
 from os import path
 
 here = path.abspath(path.dirname(__file__))
 
-# Get the long description from the README file
-with open(path.join(here, 'ReadMe.md'), encoding='utf-8') as f:
+with open(path.join(here, "ReadMe.md"),"r") as f:
     long_description = f.read()
 
 setup(
-    name='opyf',
+    name="opyf",
 
-    # Versions should comply with PEP440.
-    version='1.1',
+    version="1.1",
+    author="Gauthier Rousseau",
+    author_email="gauthier.rousseau@gmail.com",
 
-    description='OpyFlow : Python package for Optical FLow measurements.',
+    description="OpyFlow - Python package for Optical Flow measurements.",
+
     long_description=long_description,
-
-    # The project's main homepage.
+    long_description_content_type="text/markdown",
+    # The project"s main homepage.
     url="https://github.com/groussea/opyflow",
 
-    # Author details
-    author='gauthier Rousseau',
-    author_email='gauthier.rousseau@gmail.com',
 
     # Choose your license
-    license='GPL-3.0',
+    license="GPL-3.0",
 
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
         # How mature is this project? Common values are
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        'Development Status :: 4 - Beta',
-
-        # Indicate who your project is intended for
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-
-        # Pick your license as you wish (should match "license" above)
-        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
-
-        # Specify the Python versions you support here. In particular, ensure
-        # that you indicate whether you support Python 2, Python 3 or both.
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries :: Python Modules",
 
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Programming Language :: Python :: 3"
     ],
 
     # What does your project relate to?
-    keywords='optical flow',
+    keywords="optical flow",
 
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    packages=['opyf'],
+    packages=["opyf"],
 
     # List run-time dependencies here.  These will be installed by pip when
     # your project is installed.
-    install_requires=['ipython', 'vtk', 'opencv-python',
-                      'tqdm', 'h5py', 'matplotlib', 'scipy', 'pytube']
+    install_requires=["ipython", "vtk", "opencv-python",
+                      "tqdm", "h5py", "matplotlib", "scipy", "pytube"]
 )