Merge pull request #241 from carnisj/skimage

Release constraint on skimage version
carnisj · Mar 18, 2022 · 5525707 · 5525707
2 parents 0837484 + 9d65aca
commit 5525707
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 7 deletions.
diff --git a/bcdi/utils/parameters.py b/bcdi/utils/parameters.py
@@ -7,9 +7,10 @@
 #         Jerome Carnis, carnis_jerome@yahoo.fr
 
 """
-Definition of the correct parameters for the config files.
+Validation of configuration parameters.
 
-Parameter validation is performed over the excepted parameters.
+The validation is performed only on the expected parameters. Other parameters are simply
+discarded.
 """
 from numbers import Number, Real
 import numpy as np

diff --git a/bcdi/utils/parser.py b/bcdi/utils/parser.py
@@ -164,7 +164,7 @@ class ConfigParser:
     file. Some validation is also realized in the class.
 
     :param file_path: path of the configuration file that contains
-    the arguments, str.
+     the arguments, str.
     :param command_line_args: an optional dictionary of command-line arguments
     """
 

diff --git a/doc/HISTORY.rst b/doc/HISTORY.rst
@@ -1,6 +1,8 @@
 Future:
 -------
 
+* Release the constraint on scikit-image version in the requirements.
+
 * Bug: use explicitely the figure handle to save figures in `bcdi_strain.py` and
   `bcdi_preprocessing_BCDI.py`
 

diff --git a/doc/modules/utils/index.rst b/doc/modules/utils/index.rst
@@ -30,6 +30,39 @@ API Reference
 .. automodule:: bcdi.utils.image_registration
    :members:
 
+io_helper
+^^^^^^^^^
+
+Class and decorators related to the safe opening of files.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.io_helper
+   :members:
+
+parameters
+^^^^^^^^^^
+
+Function related to the validation of configuration parameters.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.parameters
+   :members:
+
+parser
+^^^^^^
+
+Class and functions related to loading of the config file and command line parameters.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.parser
+   :members:
+
 validation
 ^^^^^^^^^^
 

diff --git a/environment.yml b/environment.yml
@@ -8,7 +8,7 @@ dependencies:
   - python=3.9
   - numpy
   - scipy
-  - scikit-image<=0.18.3
+  - scikit-image
   - matplotlib
   - h5py
   - traits

diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,6 @@
 numpy
 scipy
-scikit-image<=0.18.3
+scikit-image
 matplotlib
 hdf5plugin
 h5py

diff --git a/setup.py b/setup.py
@@ -127,11 +127,11 @@
          6. Creating figures for publication using templates.""",
     url="https://github.com/carnisj/bcdi",
     project_urls={"Documentation": "https://bcdi.readthedocs.io/en/latest/"},
-    python_requires=">=3.6*",
+    python_requires=">=3.6*, <3.10",
     install_requires=[
         "numpy",
         "scipy",
-        "scikit-image<=0.18.3",
+        "scikit-image",
         "matplotlib",
         "hdf5plugin",
         "h5py",