devito/.github/workflows/tutorials.yaml at 0a51941246db5fd66354d8fae599836ffcad3b59 · devitocodes/devito · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
name: Jupyter Notebooks

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  # Trigger the workflow on push or pull request, but only for the main branch
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  tutorials-basic:
    name: ${{ matrix.name }}
    runs-on: ${{ matrix.os }}

    env:
      DEVITO_ARCH: "${{ matrix.compiler }}"
      DEVITO_LANGUAGE: ${{ matrix.language }}

    strategy:
      # Prevent cancellation if a single workflow fails
      fail-fast: false
      matrix:
        name: [
          tutos-ubuntu-gcc-py310,
          tutos-osx-clang-py311
          ]

        include:
          - name: tutos-ubuntu-gcc-py310
            os: ubuntu-latest
            compiler: gcc
            language: "openmp"
            python-version: "3.10"

          - name: tutos-osx-clang-py311
            os: macos-latest
            compiler: clang
            language: "C"
            python-version: "3.11"

    steps:
    - name: Checkout devito
      uses: actions/checkout@v6

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}

    - uses: maxim-lobanov/setup-xcode@v1
      if: runner.os == 'macOS'
      with:
        xcode-version: latest-stable

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[tests,extras]"
        pip install blosc

    - name: Test all notebooks
      run: |
        pytest \
          -v \
          --nbval \
          -k 'not dask' \
          -k 'not synthetics' \
          examples/cfd \
          examples/compiler \
          examples/finance \
          examples/performance \
          examples/seismic/abc_methods \
          examples/seismic/acoustic/accuracy.ipynb \
          examples/seismic/self_adjoint \
          examples/seismic/tutorials \
          examples/timestepping \
          examples/userapi

    - name: Failing notebooks
      # TODO: Fix or skip this
      continue-on-error: true
      run: |
        pytest -v --nbval examples/seismic/tutorials/14_creating_synthetics.ipynb

    - name: Dask notebooks
      if: runner.os != 'macOS'
      run: |
        pytest -v --nbval examples/seismic/tutorials/*dask*.ipynb

  tutorials-docker:
    name: ${{ matrix.name }}
    runs-on: ${{ matrix.os }}

    env:
      DEVITO_ARCH: "${{ matrix.compiler }}"
      DEVITO_LANGUAGE: ${{ matrix.language }}

    strategy:
      # Prevent cancellation if a single workflow fails
      fail-fast: false
      matrix:
        name: [
          tutos-docker-gcc-py310
          ]

        include:
          - name: tutos-docker-gcc-py310
            os: ubuntu-latest
            compiler: gcc
            language: "openmp"
            python-version: "3.10"

    steps:
    - name: Checkout devito
      uses: actions/checkout@v6

    - id: build
      name: Build docker image
      uses: ./.github/actions/docker-build
      with:
        file: docker/Dockerfile.devito
        tag: ${{ matrix.name }}

    - name: Test seismic notebooks
      uses: ./.github/actions/docker-run
      with:
        uid: ${{ steps.build.outputs.unique }}
        tag: ${{ matrix.name }}
        env: |
          CI=true
          CODECOV_TOKEN=${{ secrets.CODECOV_TOKEN }}
          PYTHONFAULTHANDLER=1
        command: >
          pytest
            -v
            --nbval
            -k 'not dask'
            -k 'not synthetics'
            examples/cfd
            examples/compiler
            examples/finance
            examples/performance
            examples/seismic/abc_methods
            examples/seismic/acoustic/accuracy.ipynb
            examples/seismic/self_adjoint
            examples/seismic/tutorials
            examples/timestepping
            examples/userapi

    - name: Failing notebooks
      continue-on-error: true
      uses: ./.github/actions/docker-run
      with:
        uid: ${{ steps.build.outputs.unique }}
        tag: ${{ matrix.name }}
        env: |
          CI=true
          CODECOV_TOKEN=${{ secrets.CODECOV_TOKEN }}
          PYTHONFAULTHANDLER=1
        command: |
          pytest -v --nbval examples/seismic/tutorials/14_creating_synthetics.ipynb

    - name: Dask notebooks
      uses: ./.github/actions/docker-run
      with:
        uid: ${{ steps.build.outputs.unique }}
        tag: ${{ matrix.name }}
        env: |
          CI=true
          CODECOV_TOKEN=${{ secrets.CODECOV_TOKEN }}
          DEVITO_LOGGING=DEBUG
          PYTHONFAULTHANDLER=1
        command: |
          pytest -v --nbval examples/seismic/tutorials/*dask*.ipynb

    - name: Cleanup docker image
      if: always()
      uses: ./.github/actions/docker-clean
      with:
        uid: ${{ steps.build.outputs.unique }}
        tag: ${{ matrix.name }}