DOC: Add interactive notebooks to pages in the "Usage Examples" section #356
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Tests | |
| on: | |
| push: | |
| branches: | |
| - v1.** | |
| pull_request: | |
| branches: | |
| - main | |
| - v1.** | |
| concurrency: | |
| # avoid duplicate runs on both pushes and PRs | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| # Coloured output for GitHub Actions | |
| FORCE_COLOR: 3 | |
| # Some common environment variables for both GNU/Linux and macOS jobs | |
| MPLBACKEND: Agg | |
| CYTHON_TRACE: 1 | |
| CYTHONSPEC: cython | |
| NUMPY_MIN: numpy==1.23.0 | |
| CYTHON_MIN: cython==3.0.4 | |
| SCIPY_MIN: scipy==1.9.0 | |
| jobs: | |
| test_pywavelets_linux: | |
| name: linux-cp${{ matrix.python-version }}-${{ matrix.OPTIONS_NAME }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| # Ensure that a wheel builder finishes even if another fails | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12"] | |
| MINIMUM_REQUIREMENTS: [0] | |
| USE_SCIPY: [0] | |
| USE_SDIST: [0] | |
| REFGUIDE_CHECK: [1] | |
| PIP_FLAGS: [""] | |
| OPTIONS_NAME: ["default"] | |
| include: | |
| - platform_id: manylinux_x86_64 | |
| python-version: "3.10" | |
| MINIMUM_REQUIREMENTS: 1 | |
| OPTIONS_NAME: "minimum-req" | |
| - platform_id: manylinux_x86_64 | |
| python-version: "3.10" | |
| USE_SCIPY: 1 | |
| OPTIONS_NAME: "with-scipy" | |
| - platform_id: manylinux_x86_64 | |
| python-version: "3.10" | |
| USE_SDIST: 1 | |
| OPTIONS_NAME: "install-from-sdist" | |
| - platform_id: manylinux_x86_64 | |
| python-version: "3.12" | |
| PIP_FLAGS: "--pre" | |
| OPTIONS_NAME: "pre-releases" | |
| - platform_id: manylinux_x86_64 | |
| python-version: "3.12" | |
| OPTIONS_NAME: "editable-install" | |
| steps: | |
| - name: Checkout PyWavelets | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version}} | |
| allow-prereleases: true | |
| - name: Build package | |
| env: | |
| VERSION: ${{ matrix.python-version }} | |
| MINIMUM_REQUIREMENTS: ${{ matrix.MINIMUM_REQUIREMENTS }} | |
| PIP_FLAGS: ${{ matrix.PIP_FLAGS }} | |
| USE_SDIST: ${{ matrix.USE_SDIST }} | |
| USE_SCIPY: ${{ matrix.USE_SCIPY }} | |
| REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }} | |
| OPTIONS_NAME: ${{ matrix.OPTIONS_NAME }} | |
| run: | | |
| uname -a | |
| df -h | |
| ulimit -a | |
| # ccache -s | |
| which python | |
| python --version | |
| # sudo apt-get install libatlas-base-dev | |
| pip install --upgrade pip build | |
| # Set numpy version first, other packages link against it | |
| if [ "${MINIMUM_REQUIREMENTS}" == "1" ]; then | |
| pip install ${CYTHON_MIN} | |
| pip install ${NUMPY_MIN} | |
| if [ "${USE_SCIPY}" == "1" ]; then pip install ${SCIPY_MIN}; fi | |
| else | |
| pip install ${PIP_FLAGS} cython | |
| pip install ${PIP_FLAGS} numpy | |
| if [ "${USE_SCIPY}" == "1" ]; then pip install ${PIP_FLAGS} scipy; fi | |
| fi | |
| pip install ${PIP_FLAGS} matplotlib pytest | |
| set -o pipefail | |
| if [ "${USE_SDIST}" == "1" ]; then | |
| python -m build --sdist | |
| pip install dist/pyw*.tar.gz -v | |
| elif [ "${REFGUIDE_CHECK}" == "1" ]; then | |
| pip install sphinx numpydoc scipy-doctest | |
| pip install . -v | |
| else | |
| pip install . -v | |
| fi | |
| if [ "${OPTIONS_NAME}" == "editable-install" ]; then | |
| pip install meson-python>=0.16.0 matplotlib pytest ninja | |
| pip install -e . --no-build-isolation | |
| fi | |
| - name: Run tests | |
| env: | |
| USE_SDIST: ${{ matrix.USE_SDIST }} | |
| REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }} | |
| OPTIONS_NAME: ${{ matrix.OPTIONS_NAME }} | |
| run: | | |
| set -o pipefail | |
| # Move out of source directory to avoid finding local pywt | |
| pushd demo | |
| if [ "${USE_SDIST}" == "1" ]; then | |
| pytest --pyargs pywt | |
| python ../pywt/tests/test_doc.py | |
| elif [ "${REFGUIDE_CHECK}" == "1" ]; then | |
| # doctest docstrings | |
| pytest --doctest-modules --pyargs pywt -v --doctest-collect=api | |
| # Run Sphinx HTML docs builder, converting warnings to errors | |
| # Move back out of demo/ to root directory | |
| cd .. | |
| pip install -r util/readthedocs/requirements.txt | |
| sphinx-build -b html -W --keep-going -d _build/doctrees doc/source doc/build | |
| else | |
| pytest --pyargs pywt | |
| fi | |
| popd | |
| test_pywavelets_linux_free_threaded: | |
| name: linux-cp313t-with-scipy | |
| runs-on: ubuntu-latest | |
| strategy: | |
| # Ensure that a wheel builder finishes even if another fails | |
| fail-fast: false | |
| steps: | |
| - name: Checkout PyWavelets | |
| uses: actions/checkout@v4 | |
| # TODO: replace with setup-python when there is support | |
| - uses: deadsnakes/action@e640ac8743173a67cca4d7d77cd837e514bf98e8 # v3.2.0 | |
| with: | |
| python-version: "3.13-dev" | |
| nogil: true | |
| - name: Build package | |
| run: | | |
| which python | |
| python --version | |
| pip install --upgrade pip build | |
| # We need nightly wheels for free-threaded support and latest fixes | |
| pip install --pre -i https://pypi.anaconda.org/scientific-python-nightly-wheels/simple cython numpy scipy | |
| pip install pytest meson-python ninja | |
| pip install . -v --no-build-isolation | |
| - name: Run tests | |
| env: | |
| PYTHON_GIL: 0 | |
| run: | | |
| # Move out of source directory to avoid finding local pywt | |
| cd demo | |
| pytest --pyargs pywt | |
| test_pywavelets_macos: | |
| name: macos-cp${{ matrix.python-version }}-${{ matrix.OPTIONS_NAME }} | |
| runs-on: macos-latest | |
| strategy: | |
| # Ensure that a wheel builder finishes even if another fails | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.12"] | |
| MINIMUM_REQUIREMENTS: [0] | |
| USE_SCIPY: [0] | |
| USE_SDIST: [0] | |
| REFGUIDE_CHECK: [0] | |
| PIP_FLAGS: [""] | |
| OPTIONS_NAME: ["default"] | |
| include: | |
| - python-version: "3.10" | |
| MINIMUM_REQUIREMENTS: 1 | |
| OPTIONS_NAME: "osx-minimum-req" | |
| - python-version: "3.12" | |
| PIP_FLAGS: "--pre" | |
| OPTIONS_NAME: "pre-releases" | |
| steps: | |
| - name: Checkout PyWavelets | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version}} | |
| allow-prereleases: true | |
| - name: Build package | |
| env: | |
| VERSION: ${{ matrix.python-version }} | |
| MINIMUM_REQUIREMENTS: ${{ matrix.MINIMUM_REQUIREMENTS }} | |
| PIP_FLAGS: ${{ matrix.PIP_FLAGS }} | |
| USE_SDIST: ${{ matrix.USE_SDIST }} | |
| USE_SCIPY: ${{ matrix.USE_SCIPY }} | |
| REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }} | |
| CC: /usr/bin/clang | |
| CXX: /usr/bin/clang++ | |
| run: | | |
| uname -a | |
| df -h | |
| ulimit -a | |
| which python | |
| python --version | |
| pip install --upgrade pip build | |
| # Set numpy version first, other packages link against it | |
| if [ "${MINIMUM_REQUIREMENTS}" == "1" ]; then | |
| pip install ${CYTHON_MIN} ${NUMPY_MIN} | |
| if [ "${USE_SCIPY}" == "1" ]; then pip install ${SCIPY_MIN}; fi | |
| else | |
| pip install ${PIP_FLAGS} cython numpy | |
| if [ "${USE_SCIPY}" == "1" ]; then pip install ${PIP_FLAGS} scipy; fi | |
| fi | |
| pip install ${PIP_FLAGS} matplotlib pytest | |
| set -o pipefail | |
| if [ "${USE_SDIST}" == "1" ]; then | |
| python -m build --sdist | |
| pip install pywavelets* -v | |
| elif [ "${REFGUIDE_CHECK}" == "1" ]; then | |
| pip install sphinx numpydoc scipy-doctest | |
| pip install . -v | |
| else | |
| pip install . -v | |
| fi | |
| - name: Run tests | |
| env: | |
| PIP_FLAGS: ${{ matrix.PIP_FLAGS }} | |
| USE_SDIST: ${{ matrix.USE_SDIST }} | |
| REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }} | |
| run: | | |
| # Move out of source directory to avoid finding local pywt | |
| pushd demo | |
| if [ "${USE_SDIST}" == "1" ]; then | |
| pytest --pyargs pywt | |
| python ../pywt/tests/test_doc.py | |
| elif [ "${REFGUIDE_CHECK}" == "1" ]; then | |
| # doctests docstrings | |
| pytest --doctest-modules --pyargs pywt -v --doctest-collect=api | |
| pytest --doctest-modules --pyargs pywt.data -v | |
| else | |
| pytest --pyargs pywt | |
| fi | |
| popd |