update README.md + pypi release

README.md

@@ -15,7 +15,7 @@ Jean-Michel Morel and Gabriele Facciolo. An online demo using this code can be
 found <a href="https://ipolcore.ipol.im/demo/clientApp/demo.html?id=405">here</a>.
 
 
-### Test
+### Installation
 ----------
 
 First install the requirements with
@@ -27,6 +27,13 @@ Second, install the main module with
 The Pytorch implementation of this code runs **ONLY** with torch 1.10+ 
 versions (because of torch.fft for the computation of the gradients with the pytorch implementation).
 
+Alternatively, you can install the package from pypi.org:
+> pip install polyblur
+
+### Test
+----------
+
+
 Once done, you can test the blind deblurring technique with
 > python main.py --impath ./pictures/peacock_defocus.png --N 3 --alpha 6 --beta 1
 

long_description.txt

@@ -0,0 +1,12 @@
+# Polyblur Python package
+
+Pytorch-based implementation of "Polyblur: Removing mild blur by polynomial reblurring" [Delbracio2021] and detailed in "Breaking down Polyblur: Fast blind correction of small anisotropic blurs" [Eboli2022]. Any question at [email protected].
+
+Import the package as
+> import polyblur
+
+In your Python script, run the functional interface
+> polyblur.polyblur_deblurring
+
+or the torch.nn.Module interface
+> polyblur.PolyblurDeblurring

setup.py

@@ -1,20 +1,35 @@
 from setuptools import setup, find_packages, Extension
 from torch.utils import cpp_extension
+import re
 
 # # Install the intermediate separable kernel
 # setup(name='separable_gaussian2d',
 #         ext_modules=[cpp_extension.CppExtension('separable_gaussian2d', ['./polyblur/separable_convolution/separable_gaussian2d.cpp'])],
 #         cmdclass={'build_ext': cpp_extension.BuildExtension})
 
 
+with open("long_description.txt", "r") as fh:
+    long_description = fh.read()
+
+
 # Install the main polyblur module
 setup(
     name='polyblur',
-    version="1.0.0",
+    version="1.0.1",
     author="Thomas Eboli",
     author_email="[email protected]",
     description="Breaking down Polyblur: Fast blind Correction of Small Anisotropic Blurs [IPOL2022]",
     url="https://github.com/teboli/polyblur",
+    long_description=long_description,
     packages = find_packages(),
     include_package_data=True,
+    install_requires=["torch-tools"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Environment :: GPU :: NVIDIA CUDA",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: POSIX",
+        "Topic :: Scientific/Engineering :: Image Processing",
+    ],
 )