diff --git a/MANIFEST.in b/MANIFEST.in index f47a178..ac327c7 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,8 +1,7 @@ include LICENSE include README.md -recursive-include deepdespeckling/merlin/training/saved_model * -recursive-include deepdespeckling/merlin/saved_model * +recursive-include deepdespeckling/merlin/saved_models * recursive-include deepdespeckling/sar2sar/saved_model * recursive-exclude * __pycache__ diff --git a/README.md b/README.md index 0fae5cb..fca5c2f 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ Speckle noise seriously limits the interpretability of synthetic aperture radar (SAR) images. This package provides deep learning based despeckling methods to denoise SAR images. -deepdespeckling gives access to two differents methods: +deepdespeckling gives access to two different despeckling methods: -* [MERLIN](https://arxiv.org/pdf/2110.13148.pdf) (inference and training) -* [SAR2SAR](https://arxiv.org/pdf/2006.15037.pdf) (inference only) +* [MERLIN](https://arxiv.org/pdf/2110.13148.pdf) +* [SAR2SAR](https://arxiv.org/pdf/2006.15037.pdf) [![PyPI version](https://badge.fury.io/py/deepdespeckling.svg)](https://badge.fury.io/py/deepdespeckling) @@ -178,11 +178,7 @@ despeckle(image_path, destination_directory, model_name="sar2sar") ## Documentation -To read a clean documentation of the package, you can generate it using sphinx files in the `docs` folder - -1. `cd docs` -2. `make html ` -3. open `build/index.html` +The documentation of the package is [available here](https://hi-paris.github.io/deepdespeckling/) ## Authors diff --git a/setup.py b/setup.py index 43f9456..d24b941 100644 --- a/setup.py +++ b/setup.py @@ -40,6 +40,6 @@ name='deepdespeckling', packages=find_packages(include=['deepdespeckling', 'deepdespeckling.*']), url='https://github.com/hi-paris/deepdespeckling', - version='0.4', + version='0.5', zip_safe=False, )