Merge pull request #684 from mrava87/build-nodtcwt

build: disable dtcwt example and test to be able to support numpy v2 in CI and doc

Author: mrava87

.gitignore

@@ -33,6 +33,7 @@ docs/build
 docs/source/api/generated
 docs/source/gallery
 docs/source/tutorials
+docs/source/sg_execution_times.rst
 
 # Pylint #
 pylint_plot.py

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.9"
+    python: "3.11"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

docs/source/conf.py

@@ -60,14 +60,16 @@
 numpydoc_class_members_toctree = False
 
 sphinx_gallery_conf = {
-    # path to your examples scripts
+    # Path to examples scripts
     "examples_dirs": [
         "../../examples",
         "../../tutorials",
     ],
-    # path where to save gallery generated examples
+    # Path where to save gallery generated examples
     "gallery_dirs": ["gallery", "tutorials"],
     "filename_pattern": r"\.py",
+    # Examples to skip when building the gallery
+    "ignore_pattern": r"plot_dtcwt\.py$",
     # Remove the "Download all examples" button from the top level gallery
     "download_all_examples": False,
     # Sort gallery example by file name instead of number of lines (default)

docs/source/installation.rst

@@ -322,10 +322,6 @@ In alphabetic order:
 dtcwt
 -----
 
-.. warning::
-
-   ``dtcwt`` is not yet supported with Numpy 2.
-
 `dtcwt <https://dtcwt.readthedocs.io/en/0.12.0/>`_ is a library used to implement the DT-CWT operators.
 
 Install it via ``pip`` with:
@@ -334,7 +330,9 @@ Install it via ``pip`` with:
 
    >> pip install dtcwt
 
-
+.. warning::
+   ``dtcwt`` does not support NumPy 2 yet, so make sure you use NumPy 1.x 
+   to be able to use the ``DTCWT`` operator.
 
 Devito
 ------
@@ -439,6 +437,7 @@ It can also be checked dynamically with ``numba.config.NUMBA_DEFAULT_NUM_THREADS
 
 PyMC and PyTensor
 -----------------
+
 `PyTensor <https://pytensor.readthedocs.io/en/latest/>`_ is used to allow seamless integration between PyLops and 
 `PyMC <https://www.pymc.io/welcome.html>`_ operators.
 Install both of them via ``conda`` with:
@@ -453,10 +452,7 @@ or via ``pip`` with
 
    >> pip install pytensor pymc
 
-.. note::
-   PyTensor does not support NumPy 2 yet, so make sure you use NumPy 1.x with PyTensor and PyMC.
-
-.. note::
+.. warning::
    OSX users may experience a ``CompileError`` error when using PyTensor. This can be solved by adding 
    ``pytensor.config.gcc__cxxflags = "-Wno-c++11-narrowing"`` after ``import pytensor``.
 

environment-dev-arm.yml

@@ -3,15 +3,11 @@ channels:
   - defaults
   - conda-forge
   - numba
-  - pytorch
 dependencies:
-  - python>=3.9.0
+  - python>=3.11.0
   - pip
-  - numpy>=1.21.0
-  - scipy>=1.11.0
-  - pytorch>=1.2.0
-  - cpuonly
-  - jax
+  - numpy>=2.0.0
+  - scipy>=1.13.0
   - pyfftw
   - pywavelets
   - sympy
@@ -28,10 +24,12 @@ dependencies:
   - isort
   - black
   - pip:
+    - torch
     - devito
-    - dtcwt
+    # - dtcwt (until numpy>=2.0.0 is supported)
     - scikit-fmm
     - spgl1
+    - jax
     - pytest-runner
     - setuptools_scm
     - pydata-sphinx-theme

environment-dev-gpu.yml

@@ -6,8 +6,8 @@ channels:
 dependencies:
   - python>=3.11.0
   - pip
-  - numpy>=1.21.0
-  - scipy>=1.11.0
+  - numpy>=2.0.0
+  - scipy>=1.13.0
   - cupy
   - sympy
   - matplotlib

environment-dev.yml

@@ -3,15 +3,11 @@ channels:
   - defaults
   - conda-forge
   - numba
-  - pytorch
 dependencies:
-  - python>=3.9.0
+  - python>=3.11.0
   - pip
-  - numpy>=1.21.0
-  - scipy>=1.11.0
-  - pytorch>=1.2.0
-  - cpuonly
-  - jax
+  - numpy>=2.0.0
+  - scipy>=1.13.0
   - pyfftw
   - pywavelets
   - sympy
@@ -29,10 +25,12 @@ dependencies:
   - isort
   - black
   - pip:
+    - torch
     - devito
-    - dtcwt
+    # - dtcwt (until numpy>=2.0.0 is supported)
     - scikit-fmm
     - spgl1
+    - jax
     - pytest-runner
     - setuptools_scm
     - pydata-sphinx-theme

pytests/test_dtcwt.py

@@ -22,11 +22,10 @@ def sequential_array(shape):
 @pytest.mark.skipif(
     int(os.environ.get("TEST_CUPY_PYLOPS", 0)) == 1, reason="Not CuPy enabled"
 )
+@pytest.mark.skipif(int(np_version[0]) >= 2, reason="dtcwt does not support numpy v2")
 @pytest.mark.parametrize("par", [(par1), (par2)])
 def test_dtcwt1D_input1D(par):
     """Test for DTCWT with 1D input"""
-    if int(np_version[0]) >= 2:
-        return
 
     t = sequential_array((par["ny"],))
 
@@ -41,11 +40,10 @@ def test_dtcwt1D_input1D(par):
 @pytest.mark.skipif(
     int(os.environ.get("TEST_CUPY_PYLOPS", 0)) == 1, reason="Not CuPy enabled"
 )
+@pytest.mark.skipif(int(np_version[0]) >= 2, reason="dtcwt does not support numpy v2")
 @pytest.mark.parametrize("par", [(par1), (par2)])
 def test_dtcwt1D_input2D(par):
     """Test for DTCWT with 2D input (forward-inverse pair)"""
-    if int(np_version[0]) >= 2:
-        return
 
     t = sequential_array(
         (
@@ -65,11 +63,10 @@ def test_dtcwt1D_input2D(par):
 @pytest.mark.skipif(
     int(os.environ.get("TEST_CUPY_PYLOPS", 0)) == 1, reason="Not CuPy enabled"
 )
+@pytest.mark.skipif(int(np_version[0]) >= 2, reason="dtcwt does not support numpy v2")
 @pytest.mark.parametrize("par", [(par1), (par2)])
 def test_dtcwt1D_input3D(par):
     """Test for DTCWT with 3D input (forward-inverse pair)"""
-    if int(np_version[0]) >= 2:
-        return
 
     t = sequential_array((par["ny"], par["ny"], par["ny"]))
 
@@ -84,11 +81,10 @@ def test_dtcwt1D_input3D(par):
 @pytest.mark.skipif(
     int(os.environ.get("TEST_CUPY_PYLOPS", 0)) == 1, reason="Not CuPy enabled"
 )
+@pytest.mark.skipif(int(np_version[0]) >= 2, reason="dtcwt does not support numpy v2")
 @pytest.mark.parametrize("par", [(par1), (par2)])
 def test_dtcwt1D_birot(par):
     """Test for DTCWT birot (forward-inverse pair)"""
-    if int(np_version[0]) >= 2:
-        return
 
     birots = ["antonini", "legall", "near_sym_a", "near_sym_b"]
 

requirements-dev-gpu.txt

@@ -1,5 +1,5 @@
-numpy>=1.21.0
-scipy>=1.11.0
+numpy>=2.0.0
+scipy>=1.13.0
 cupy-cuda12x
 torch
 numba

requirements-dev.txt

@@ -1,5 +1,5 @@
-numpy>=1.21.0
-scipy>=1.11.0
+numpy>=2.0.0
+scipy>=1.13.0
 jax
 numba
 pyfftw
@@ -8,7 +8,7 @@ spgl1
 scikit-fmm
 sympy
 devito
-dtcwt
+# dtcwt (until numpy>=2.0.0 is supported)
 matplotlib
 ipython
 pytest
@@ -29,4 +29,4 @@ isort
 black
 flake8
 mypy
-pytensor
+pytensor>=2.28.0