merge conflict

Author: pbrubeck

.github/workflows/core.yml

@@ -15,6 +15,10 @@ on:
         description: Whether to run the test suite
         type: boolean
         default: true
+      build_docs:
+        description: Whether to build the documentation
+        type: boolean
+        default: true
       test_macos:
         description: Whether to test using macOS
         type: boolean
@@ -42,6 +46,10 @@ on:
         description: Whether to run the test suite
         type: boolean
         default: true
+      build_docs:
+        description: Whether to build the documentation
+        type: boolean
+        default: true
       test_macos:
         description: Whether to test using macOS
         type: boolean
@@ -82,7 +90,6 @@ jobs:
       OMP_NUM_THREADS: 1
       OPENBLAS_NUM_THREADS: 1
       FIREDRAKE_CI: 1
-      PYOP2_CI_TESTS: 1
       PYOP2_SPMD_STRICT: 1
       # NOTE: One should occasionally update test_durations.json by running
       # 'make test_durations' inside a 'firedrake:latest' Docker image.
@@ -134,17 +141,6 @@ jobs:
             exit 1
           fi
 
-      # Raise an error if any 'TODO RELEASE' comments remain
-      - name: Check no 'TODO RELEASE' comments (release only)
-        if: inputs.target_branch == 'release'
-        working-directory: firedrake-repo
-        run: |
-          if [ -z "$( grep -r --exclude-dir='.*' 'TODO RELEASE' )" ]; then
-            exit 0
-          else
-            exit 1
-          fi
-
       - name: Install system dependencies (2)
         run: |
           apt-get -y install \
@@ -207,7 +203,7 @@ jobs:
 
           : # Install from an sdist so we can make sure that it is not ill-formed
           pip install build
-          python -m build ./firedrake-repo --sdist "$EXTRA_BUILD_ARGS"
+          python -m build ./firedrake-repo --sdist $EXTRA_BUILD_ARGS
 
           pip install --verbose $EXTRA_PIP_FLAGS \
             --no-binary h5py \
@@ -488,6 +484,7 @@ jobs:
         run: make lint GITHUB_ACTIONS_FORMATTING=1
 
   build_docs:
+    if: inputs.build_docs
     name: Build documentation
     runs-on: [self-hosted, Linux]
     container:

.github/workflows/docker.yml

@@ -41,18 +41,11 @@ jobs:
       matrix:
         os: [Linux, macOS]
         arch: [default, complex]
-        platform: [linux/amd64, linux/arm64]
-        # Cannot use inputs in exclude clauses, so add a dummy matrix dim
-        build_dev:
-          - ${{ inputs.build_dev }}
-        # exclude incompatible os+platform, and only build linux dev containers
-        exclude:
-          - os: Linux
-            platform: linux/arm64
-          - os: macOS
-            platform: linux/amd64
-          - os: macOS
-            build_dev: true
+        include:
+        - os: Linux
+          platform: linux/amd64
+        - os: macOS
+          platform: linux/arm64
     uses: ./.github/workflows/docker_build.yml
     with:
       os: ${{ matrix.os }}

.github/workflows/release.yml

@@ -1,24 +1,74 @@
 name: Publish release
 
 on:
-  release:
-    types: [released]
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: The branch to release from
+        type: string
+        required: true
+      version:
+        description: The version number to release
+        type: string
+        required: true
 
 jobs:
-  deploy:
+  check:
+    name: Pre-release checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          path: firedrake-repo
+          ref: ${{ inputs.branch }}
+
+      - name: Check no 'TODO RELEASE' comments remain
+        working-directory: firedrake-repo
+        run: |
+          if [ -z "$( grep -r --exclude-dir='.*' 'TODO RELEASE' )" ]; then
+            exit 0
+          else
+            exit 1
+          fi
+
+      - name: Check version number matches
+        working-directory: firedrake-repo
+        run: |
+          if [ -z "$( grep 'version = \"${{ inputs.version }}\"' pyproject.toml )" ]; then
+            exit 1
+          else
+            exit 0
+          fi
+
+  pypi:
     uses: ./.github/workflows/core.yml
+    needs: check
     with:
-      source_ref: release
+      source_ref: ${{ inputs.branch }}
       target_branch: release
       run_tests: false
+      build_docs: false
       upload_pypi: true
     secrets: inherit
 
+  github_release:
+    name: Create GitHub release
+    needs: pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create --title ${{ inputs.version }} --target ${{ inputs.branch }} --generate-notes ${{ inputs.version }}
+
   docker:
     name: Build Docker containers
     uses: ./.github/workflows/docker.yml
+    needs: pypi
     with:
-      tag: ${{ github.ref_name }}
-      branch: ${{ github.ref_name }}
-      build_dev: false
+      tag: ${{ inputs.version }}
+      branch: ${{ inputs.branch }}
     secrets: inherit

demos/full_waveform_inversion/full_waveform_inversion.py.rst

@@ -83,7 +83,7 @@ for 3 wave sources. Therefore, we will have 3 emsemble members, each with 2 rank
 processes launched by mpiexec must therefore be equal to the product of number of ensemble members
 (3, in this case) with the number of processes to be used for each ensemble member (``M=2``, in this case).
 Additional details about the ensemble parallelism can be found in the
-`Firedrake documentation <https://www.firedrakeproject.org/parallelism.html#ensemble-parallelism>`_.
+`Firedrake documentation <https://www.firedrakeproject.org/ensemble_parallelism.html>`_.
 
 The subcommunicators in each ensemble member are: ``Ensemble.comm`` and ``Ensemble.ensemble_comm``.
 ``Ensemble.comm`` is the spatial communicator. ``Ensemble.ensemble_comm`` allows communication between

docker/Dockerfile.vanilla

@@ -168,5 +168,5 @@ ENV PYOP2_CFLAGS=$CFLAGS
 
 # Run the smoke tests.
 RUN cd /opt/firedrake/ \
-    && firedrake-check \
+    && firedrake-check --mpiexec 'mpiexec --oversubscribe -n' \
     && firedrake-clean

docs/source/install.rst

@@ -60,9 +60,19 @@ firedrake-configure
 -------------------
 
 To simplify the installation process, Firedrake provides a utility script called
-``firedrake-configure``. This script can be downloaded by executing::
+``firedrake-configure``. This script can be downloaded by executing:
 
-  $ curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/main/scripts/firedrake-configure
+.. only:: release
+
+   .. code-block:: text
+
+      $ curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/release/scripts/firedrake-configure
+
+.. only:: main
+
+   .. code-block:: text
+
+      $ curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/main/scripts/firedrake-configure
 
 Note that ``firedrake-configure`` **does not install Firedrake for you**. It
 is simply a helper script that emits the configuration options that Firedrake

firedrake/adjoint/ensemble_reduced_functional.py

@@ -85,7 +85,7 @@ class EnsembleReducedFunctional(AbstractReducedFunctional):
     The functionals :math:`J_i` and the control must be defined over a common
     `ensemble.comm` communicator. To understand more about how ensemble parallelism
     works, please refer to the `Firedrake manual
-    <https://www.firedrakeproject.org/parallelism.html#ensemble-parallelism>`_.
+    <https://www.firedrakeproject.org/ensemble_parallelism.html>`_.
     """
     def __init__(self, functional, control, ensemble, scatter_control=True,
                  gather_functional=None,

firedrake/formmanipulation.py

@@ -183,37 +183,41 @@ def matrix(self, o):
         bcs = ()
         return AssembledMatrix(tuple(args), bcs, submat)
 
+    def zero_base_form(self, o):
+        return ZeroBaseForm(tuple(map(self, o.arguments())))
+
     def interpolate(self, o, operand):
         if isinstance(operand, Zero):
-            return ZeroBaseForm(o.arguments())
+            return self(ZeroBaseForm(o.arguments()))
 
         dual_arg, _ = o.argument_slots()
-        V = dual_arg.function_space()
-        if len(V) == 1 or len(dual_arg.arguments()) == 1:
+        if len(dual_arg.arguments()) == 1 or len(dual_arg.arguments()[-1].function_space()) == 1:
+            # The dual argument has been contracted or does not need to be split
             return o._ufl_expr_reconstruct_(operand, dual_arg)
 
+        if not isinstance(dual_arg, Coargument):
+            raise NotImplementedError(f"I do not know how to split an Interpolate with a {type(dual_arg).__name__}.")
+
+        indices = self.blocks[dual_arg.number()]
+        V = dual_arg.function_space()
+
         # Split the target (dual) argument
-        if isinstance(dual_arg, Coargument):
-            dual_arg = self(dual_arg)
-            indices = self.blocks[dual_arg.number()]
-        else:
-            raise NotImplementedError()
+        sub_dual_arg = self(dual_arg)
+        W = sub_dual_arg.function_space()
 
-        # Unflatten the expression into the target shapes
+        # Unflatten the expression into the target shape
         cur = 0
-        cindices = []
+        components = []
         for i, Vi in enumerate(V):
             if i in indices:
-                cindices.extend(range(cur, cur+Vi.value_size))
+                components.extend(operand[i] for i in range(cur, cur+Vi.value_size))
             cur += Vi.value_size
 
-        W = dual_arg.function_space()
-        components = [operand[i] for i in cindices]
         operand = as_tensor(numpy.reshape(components, W.value_shape))
         if isinstance(operand, Zero):
-            return ZeroBaseForm(o.arguments())
+            return self(ZeroBaseForm(o.arguments()))
 
-        return o._ufl_expr_reconstruct_(operand, dual_arg)
+        return o._ufl_expr_reconstruct_(operand, sub_dual_arg)
 
 
 SplitForm = collections.namedtuple("SplitForm", ["indices", "form"])