Skip to content

Commit 5a0b814

Browse files
committed
build/doc: change doc settings to run with python 3.11 and numpy v2 (and disable dtcwt
1 parent 50423ab commit 5a0b814

4 files changed

Lines changed: 18 additions & 22 deletions

File tree

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ version: 2
99
build:
1010
os: ubuntu-20.04
1111
tools:
12-
python: "3.9"
12+
python: "3.11"
1313

1414
# Build documentation in the docs/ directory with Sphinx
1515
sphinx:

docs/source/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,16 @@
6060
numpydoc_class_members_toctree = False
6161

6262
sphinx_gallery_conf = {
63-
# path to your examples scripts
63+
# Path to examples scripts
6464
"examples_dirs": [
6565
"../../examples",
6666
"../../tutorials",
6767
],
68-
# path where to save gallery generated examples
68+
# Path where to save gallery generated examples
6969
"gallery_dirs": ["gallery", "tutorials"],
7070
"filename_pattern": r"\.py",
71+
# Examples to skip when building the gallery
72+
"ignore_pattern": r"plot_dtcwt\.py$",
7173
# Remove the "Download all examples" button from the top level gallery
7274
"download_all_examples": False,
7375
# Sort gallery example by file name instead of number of lines (default)

docs/source/installation.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -322,10 +322,6 @@ In alphabetic order:
322322
dtcwt
323323
-----
324324

325-
.. warning::
326-
327-
``dtcwt`` is not yet supported with Numpy 2.
328-
329325
`dtcwt <https://dtcwt.readthedocs.io/en/0.12.0/>`_ is a library used to implement the DT-CWT operators.
330326

331327
Install it via ``pip`` with:
@@ -334,7 +330,9 @@ Install it via ``pip`` with:
334330
335331
>> pip install dtcwt
336332
337-
333+
.. warning::
334+
``dtcwt`` does not support NumPy 2 yet, so make sure you use NumPy 1.x
335+
to be able to use the ``DTCWT`` operator.
338336

339337
Devito
340338
------
@@ -439,6 +437,7 @@ It can also be checked dynamically with ``numba.config.NUMBA_DEFAULT_NUM_THREADS
439437

440438
PyMC and PyTensor
441439
-----------------
440+
442441
`PyTensor <https://pytensor.readthedocs.io/en/latest/>`_ is used to allow seamless integration between PyLops and
443442
`PyMC <https://www.pymc.io/welcome.html>`_ operators.
444443
Install both of them via ``conda`` with:
@@ -453,10 +452,11 @@ or via ``pip`` with
453452
454453
>> pip install pytensor pymc
455454
456-
.. note::
457-
PyTensor does not support NumPy 2 yet, so make sure you use NumPy 1.x with PyTensor and PyMC.
458-
459-
.. note::
455+
.. warning::
456+
``PyTensor`` does not support NumPy 2 yet, so make sure you use NumPy 1.x with PyTensor and PyMC.
457+
to be able to use PyLops operators with ``PyMC``.
458+
459+
.. warning::
460460
OSX users may experience a ``CompileError`` error when using PyTensor. This can be solved by adding
461461
``pytensor.config.gcc__cxxflags = "-Wno-c++11-narrowing"`` after ``import pytensor``.
462462

requirements-doc.txt

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
# Currently we force rdt to use numpy<2.0.0 to build the documentation
2-
# since the dtcwt is not yet compatible with numpy=2.0.0. For the
3-
# same reason, we force devito==4.8.6 as later versions of devito
4-
# require numpy>=2.0.0
5-
numpy>=1.21.0,<2.0.0
6-
scipy>=1.11.0,<1.13
1+
numpy>=2.0.0
2+
scipy>=1.13.0
73
jax
8-
--extra-index-url https://download.pytorch.org/whl/cpu
9-
torch>=1.2.0
104
numba
115
pyfftw
126
PyWavelets
137
spgl1
148
scikit-fmm
159
sympy
16-
devito==4.8.6
17-
dtcwt
10+
devito
11+
# dtcwt (until numpy>=2.0.0 is supported)
1812
matplotlib
1913
ipython
2014
pytest

0 commit comments

Comments
 (0)