Merge pull request #4628 from firedrakeproject/connorjward/merge-release

Author: connorjward

.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
@@ -195,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 \
@@ -476,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/release.yml

@@ -47,6 +47,7 @@ jobs:
       source_ref: ${{ inputs.branch }}
       target_branch: release
       run_tests: false
+      build_docs: false
       upload_pypi: true
     secrets: inherit
 
@@ -57,10 +58,11 @@ jobs:
     permissions:
       contents: write
     steps:
+      - uses: actions/checkout@v5
       - name: Create release
         env:
           GH_TOKEN: ${{ github.token }}
-        run: gh release create ${{ inputs.version }} --title ${{ inputs.version }} --generate-notes
+        run: gh release create --title ${{ inputs.version }} --target ${{ inputs.branch }} --generate-notes ${{ inputs.version }}
 
   docker:
     name: Build Docker containers

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

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,

pyproject.toml

@@ -20,22 +20,23 @@ dependencies = [
   "decorator<=4.4.2",
   "mpi4py>3; python_version >= '3.13'",
   "mpi4py; python_version < '3.13'",
-  # TODO RELEASE: use releases
+  # TODO RELEASE
   "fenics-ufl @ git+https://github.com/FEniCS/ufl.git@main",
-  "firedrake-fiat @ git+https://github.com/firedrakeproject/fiat.git",
+  # TODO RELEASE
+  "firedrake-fiat @ git+https://github.com/firedrakeproject/fiat.git@main",
   "h5py>3.12.1",
+  "immutabledict",
   "libsupermesh",
   "loopy>2024.1",
   "numpy",
   "packaging",
   # TODO RELEASE
-  # "petsc4py==3.23.4",
-  # TODO RELEASE
-  # "petsctools",
+  # "petsc4py==3.24.0",
+  "petsctools",
   "pkgconfig",
   "progress",
-  # TODO RELEASE: use a release
-  "pyadjoint-ad @ git+https://github.com/dolfin-adjoint/pyadjoint",
+  # TODO RELEASE
+  "pyadjoint-ad @ git+https://github.com/dolfin-adjoint/pyadjoint@master",
   "pycparser",
   "pytools[siphash]",
   "requests",
@@ -92,11 +93,11 @@ jax = [
 ]
 netgen = [
   # TODO RELEASE
-  # "ngsPETSc",
+  # "ngsPETSc>=0.1.1",
 ]
 slepc = [
   # TODO RELEASE
-  # "slepc4py==3.23.2",
+  # "slepc4py==3.24.0",
 ]
 torch = [  # requires passing '--extra-index-url' to work
   "torch",
@@ -110,7 +111,8 @@ ci = [
   "mpi-pytest>=2025.7",
   "nbval",
   "networkx",
-  "ngsPETSc",
+  # TODO RELEASE
+  # "ngsPETSc>=0.1.1",
   "pdf2image",
   "pygraphviz",
   "pylit",
@@ -119,7 +121,7 @@ ci = [
   "pytest-timeout",
   "pytest-xdist",
   # TODO RELEASE
-  # "slepc4py==3.23.2",
+  # "slepc4py==3.24.0",
   "torch",  # requires passing '--extra-index-url' to work
 ]
 docker = [  # Used in firedrake-vanilla container
@@ -136,7 +138,7 @@ docker = [  # Used in firedrake-vanilla container
   "pytest-timeout",
   "pytest-xdist",
   # TODO RELEASE
-  # "slepc4py==3.23.2",
+  # "slepc4py==3.24.0",
 ]
 
 [build-system]
@@ -151,7 +153,7 @@ requires = [
   "pybind11",
   "setuptools>=77.0.3",
   # TODO RELEASE
-  # "petsc4py==3.23.4",
+  # "petsc4py==3.24.0",
   "rtree>=1.2",
 ]
 build-backend = "setuptools.build_meta"

requirements-build.txt

@@ -5,7 +5,7 @@ mpi4py>3; python_version >= '3.13'
 mpi4py; python_version < '3.13'
 numpy
 pkgconfig
-petsctools @ git+https://github.com/firedrakeproject/petsctools.git
+petsctools
 pybind11
 setuptools>=77.0.3
 rtree>=1.2