pip install firedrake

.github/workflows/build-mac.yml

@@ -23,41 +23,73 @@ jobs:
     # Only run this action if we are pushing to master or the PR is labelled "macOS"
     if: ${{ (github.ref == 'refs/heads/master') || contains(github.event.pull_request.labels.*.name, 'macOS') }}
     env:
+      # TODO: Are these needed any more?
       FIREDRAKE_CI_TESTS: 1  # needed to symlink the checked out branch into the venv
       OMP_NUM_THREADS: 1
       OPENBLAS_NUM_THREADS: 1
     steps:
       - name: Add homebrew to PATH
         # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path
         run: echo "/opt/homebrew/bin" >> "$GITHUB_PATH"
-      - uses: actions/checkout@v4
+
       - name: Pre-run cleanup
-        if: ${{ always() }}
+        # Make sure the current directory is empty
+        run: find . -delete
+
+      # Uninstall existing packages so there are no conflicts (e.g. OpenMPI vs MPICH)
+      - name: Remove all existing homebrew packages
+        # If there are no homebrew packages installed then this command will fail even
+        # though nothing is wrong.
+        continue-on-error: true
+        run: brew remove --formula --force $(brew list --formula)
+
+      - uses: actions/checkout@v4
+        with:
+          path: repo
+
+      - name: Install system dependencies
         run: |
-          cd ..
-          rm -rf firedrake_venv
-      - name: Install Python
-        run: brew install python python-setuptools
-      - name: Build Firedrake
+          : # We need Python before we can run firedrake-configure
+          brew install python
+          brew install $(python3 ./repo/scripts/firedrake-configure --arch default --show-system-dependencies)
+
+      - name: Install PETSc
         run: |
-          cd ..
-          "$(brew --prefix)/bin/python3" \
-            firedrake/scripts/firedrake-install \
-            --venv-name firedrake_venv \
-            --disable-ssh \
-            || (cat firedrake-install.log && /bin/false)
-      - name: Install test dependencies
+          git clone https://github.com/firedrakeproject/petsc.git
+          cd petsc
+          ./configure \
+            $(python3 ../repo/scripts/firedrake-configure --arch default --show-petsc-configure-options) \
+            --with-make-np=4
+          make
+          # TODO: Does this pass?
+          # make check
+
+      - name: Install Firedrake
+        id: install
         run: |
-          . ../firedrake_venv/bin/activate
-          python -m pip install pytest-timeout
+          export PETSC_DIR=$PWD/petsc PETSC_ARCH=arch-firedrake-default
+          export HDF5_MPI=ON
+          export CC=mpicc CXX=mpicxx
+          export MPICC=$CC
+          python3 -m venv venv
+          . venv/bin/activate
+          : # Force a rebuild of petsc4py as the cached one will not link to the fresh
+          : # install of PETSc. A similar trick may be needed for compiled dependencies
+          : # like h5py or mpi4py if changing HDF5/MPI libraries.
+          pip cache remove petsc4py
+          pip install --verbose --no-binary h5py ./repo[test]
+          firedrake-clean
+          : # Extra test dependencies
+          pip install pytest-timeout
+          pip list
 
       - name: Run smoke tests
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           make check CHECK_PYTEST_ARGS="--timeout 60"
         timeout-minutes: 10
+
       - name: Post-run cleanup
-        if: ${{ always() }}
+        if: always()
         run: |
-          cd ..
-          rm -rf firedrake_venv
+          find . -delete

.github/workflows/build.yml

@@ -1,7 +1,6 @@
-name: Install and Test Firedrake
+name: CI
 
 on:
-  # Push to master or PR
   push:
     branches:
       - master
@@ -11,7 +10,7 @@ on:
     - cron: '0 0 1 * *'  # Monthly release
 
 concurrency:
-  # Cancels jobs running if new commits are pushed
+  # Cancel running jobs if new commits are pushed
   group: >
     ${{ github.workflow }}-
     ${{ github.event.pull_request.number || github.ref }}
@@ -22,152 +21,123 @@ env:
 
 jobs:
   test:
-    name: "Run Firedrake tests (Linux)"
-    runs-on: [self-hosted, Linux]
-    container:
-      image: firedrakeproject/firedrake-env:latest
+    name: Install and test Firedrake (Linux)
     strategy:
       # We want to know all of the tests which fail, so don't kill real if
       # complex fails and vice-versa
       fail-fast: false
       matrix:
-        include:
-          - scalar-type: real
-            complex: ""
-            petsc_arch: default
-          - scalar-type: complex
-            complex: --complex
-            petsc_arch: complex
+        arch: [default, complex]
+    runs-on: [self-hosted, Linux]
+    container:
+      image: firedrakeproject/firedrake-env:pip
     env:
-      # PETSC_DIR and MPICH_DIR are set inside the docker image
+      # NOTE: Do not set a lot of vars here, single source of truth
       FIREDRAKE_CI_TESTS: 1
       PYOP2_CI_TESTS: 1
-      PETSC_ARCH: ${{ matrix.petsc_arch }}
-      OMP_NUM_THREADS: 1
-      OPENBLAS_NUM_THREADS: 1
-      COMPLEX: ${{ matrix.complex }}
-      RDMAV_FORK_SAFE: 1
-      EXTRA_PYTEST_ARGS: --splitting-algorithm least_duration --timeout=1800 --timeout-method=thread -o faulthandler_timeout=1860 tests/firedrake
       PYOP2_SPMD_STRICT: 1
+      EXTRA_PYTEST_ARGS: --splitting-algorithm least_duration --timeout=1800 --timeout-method=thread -o faulthandler_timeout=1860 repo/tests/firedrake
     steps:
-      - uses: actions/checkout@v4
-
-      - name: Cleanup
-        if: ${{ always() }}
+      - name: Pre-run cleanup
         run: |
-          cd ..
-          rm -rf firedrake_venv
+          : # Make sure the current directory is empty
+          find . -delete
 
-      - name: Build Firedrake
-        run: |
-          cd ..
-          # Linting should ignore unquoted shell variable $COMPLEX
-          # shellcheck disable=SC2086
-          ./firedrake/scripts/firedrake-install \
-            $COMPLEX \
-            --honour-petsc-dir \
-            --mpicc="$MPICH_DIR"/mpicc \
-            --mpicxx="$MPICH_DIR"/mpicxx \
-            --mpif90="$MPICH_DIR"/mpif90 \
-            --mpiexec="$MPICH_DIR"/mpiexec \
-            --mpihome="$MPICH_DIR"/.. \
-            --venv-name firedrake_venv \
-            --no-package-manager \
-            --disable-ssh \
-            --documentation-dependencies \
-            --torch \
-            --jax \
-            --netgen \
-            --slepc \
-            --install thetis \
-            --install gusto \
-            --install icepack \
-            --install irksome \
-            --install femlium \
-            --install fascd \
-            --install defcon \
-            --install gadopt \
-            --install asQ \
-            || (cat firedrake-install.log && /bin/false)
-
-      - name: Install test dependencies
-        id: build
-        run: |
-          sudo apt update
-          sudo apt -y install parallel
-          . ../firedrake_venv/bin/activate
+      - uses: actions/checkout@v4
+        with:
+          path: repo
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install \
+            $(python3 ./repo/scripts/firedrake-configure --arch ${{ matrix.arch }} --show-system-dependencies)
+          : # Extra test dependencies
+          sudo apt-get -y install parallel
+
+      - name: Install PETSc
+        run: |
+          git clone https://github.com/firedrakeproject/petsc.git
+          cd petsc
+          ./configure \
+            $(python3 ../repo/scripts/firedrake-configure --arch ${{ matrix.arch }} --show-petsc-configure-options) \
+            --with-make-np=12
+          make
+          # TODO: This fails for some reason
+          # make check
+
+      - name: Install Firedrake
+        id: install
+        run: |
+          export PETSC_DIR=$PWD/petsc PETSC_ARCH=arch-firedrake-${{ matrix.arch }}
+          export HDF5_MPI=ON
+          export CC=mpicc CXX=mpicxx
+          export MPICC=$CC
+          python3 -m venv venv
+          . venv/bin/activate
+          : # Force a rebuild of petsc4py as the cached one will not link to the fresh
+          : # install of PETSc. A similar trick may be needed for compiled dependencies
+          : # like h5py or mpi4py if changing HDF5/MPI libraries.
+          pip cache remove petsc4py
+          pip install --verbose --no-binary h5py ./repo[test]
           firedrake-clean
-          python -m pip install pytest-timeout ipympl pytest-split pytest-xdist
-          python -m pip list
+          : # Extra test dependencies
+          pip install ipympl pytest-split pytest-timeout pytest-xdist
+          pip list
 
       - name: Run tests (nprocs = 1)
         run: |
+          . venv/bin/activate
           : # Use pytest-xdist here so we can have a single collated output (not possible
           : # for parallel tests)
-          . ../firedrake_venv/bin/activate
           firedrake-run-split-tests 1 1 "-n 12 $EXTRA_PYTEST_ARGS --junit-xml=firedrake1_{#}.xml"
 
       - name: Run tests (nprocs = 2)
         # Run even if earlier tests failed
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 2 6 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake2_{#}.xml"
 
       - name: Run tests (nprocs = 3)
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 3 4 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake3_{#}.xml"
 
       - name: Run tests (nprocs = 4)
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 4 3 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake4_{#}.xml"
 
       - name: Run tests (nprocs = 5)
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 5 2 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake5_{#}.xml"
 
       - name: Run tests (nprocs = 6)
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 6 2 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake6_{#}.xml"
 
       - name: Run tests (nprocs = 7)
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 7 1 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake7_{#}.xml"
 
       - name: Run tests (nprocs = 8)
-        if: ${{ success() || steps.build.conclusion == 'success' }}
+        if: ${{ success() || steps.install.conclusion == 'success' }}
         run: |
-          . ../firedrake_venv/bin/activate
+          . venv/bin/activate
           firedrake-run-split-tests 8 1 "$EXTRA_PYTEST_ARGS --junit-xml=firedrake8_{#}.xml"
 
-      - name: Test pyadjoint
-        if: (success() || steps.build.conclusion == 'success') && matrix.scalar-type == 'real'
-        run: |
-          . ../firedrake_venv/bin/activate
-          cd ../firedrake_venv/src/pyadjoint
-          python -m pytest \
-            --strict-markers \
-            --durations=200 \
-            --timeout=600 \
-            --timeout-method=thread \
-            -o faulthandler_timeout=660 \
-            -n 12 --dist worksteal \
-            -sv tests/firedrake_adjoint
-        timeout-minutes: 5
-
       - name: Run Gusto smoke tests
         # Only test Gusto in real mode
-        if: (success() || steps.build.conclusion == 'success') && matrix.scalar-type == 'real'
+        if: (success() || steps.install.conclusion == 'success') && matrix.arch == 'default'
         run: |
           . ../firedrake_venv/bin/activate
           cd ../firedrake_venv/src/gusto
@@ -177,31 +147,31 @@ jobs:
             integration-tests/transport/test_embedded_dg_advection.py
         timeout-minutes: 5
 
-      - name: Publish Test Report
+      - name: Publish test report
         uses: mikepenz/[email protected]
         # To avoid permissions issues do not run with forked repos
         # (see https://github.com/mikepenz/action-junit-report/issues/23)
-        if: ${{ always() && (github.ref != 'refs/heads/master') && (github.event.pull_request.head.repo.full_name == github.repository) }}
+        if: |
+          (success() || steps.install.conclusion == 'success')
+          && (github.ref != 'refs/heads/master')
+          && (github.event.pull_request.head.repo.full_name == github.repository)
         with:
           report_paths: 'firedrake*.xml'
           comment: true
-          check_name: "Firedrake ${{ matrix.scalar-type }}"
+          check_name: "Firedrake ${{ matrix.arch }}"
           updateComment: true
           flaky_summary: true
 
       - name: Upload log files
         uses: actions/upload-artifact@v4
-        if: always()
+        if: success() || steps.install.conclusion == 'success'
         with:
-          name: firedrake-logs-${{ matrix.scalar-type }}
+          name: firedrake-logs-${{ matrix.arch }}
           path: pytest_*.log
 
-      - name: Cleanup
-        # Belt and braces: clean up before and after the run.
-        if: ${{ always() }}
-        run: |
-          cd ..
-          rm -rf firedrake_venv
+      - name: Post-run cleanup
+        if: always()
+        run: find . -delete
 
   docker_tag:
     name: "Set the Docker release tag"
@@ -224,10 +194,10 @@ jobs:
     name: "Build Docker containers"
     # Only run on master, but always generate firedrake-env image,
     # even if build fails (see docker.yml)
-    if: ${{ (github.ref == 'refs/heads/master') && always() }}
-    needs: [test, docker_tag]
+    # if: always() && (github.ref == 'refs/heads/master')
+    # needs: [test, docker_tag]
     uses: ./.github/workflows/docker.yml
     with:
-      tag: ${{ needs.docker_tag.outputs.tag }}
-      status: ${{ needs.test.result }}
+      tag: pip
+      status: success
     secrets: inherit