Add requirements-reference.txt

.github/pull_request_template.md

@@ -3,6 +3,7 @@ TODO: Summarize and motivate the changes, link to issues, remove the checklist e
 ## Checklist
 
 - [ ] I added a summary of any user-facing changes (compared to the last release) in the `changelog-entries/<PRnumber>.md`.
+- [ ] If I changed `requirements.txt` files, I regenerated sibling `requirements-reference.txt` files with `python3 tools/releasing/update-requirements-reference.py` (pass a path to update only that directory, or `--all` to refresh everything).
 
 For new tutorials or tutorial cases:
 

.github/workflows/check-requirements-reference.yml

@@ -0,0 +1,29 @@
+name: Check requirements-reference
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+    paths:
+      - '**/requirements.txt'
+      - '**/requirements-reference.txt'
+      - tools/releasing/update-requirements-reference.py
+      - tools/releasing/requirements.txt
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v7
+      - name: Setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.10'
+      - name: Install packaging
+        run: pip install -r tools/releasing/requirements.txt
+      - name: Check requirements-reference.txt files exist
+        if: github.base_ref == 'develop'
+        run: python3 tools/releasing/update-requirements-reference.py --check
+      - name: Check requirements-reference.txt files are up to date
+        if: github.base_ref == 'master'
+        run: python3 tools/releasing/update-requirements-reference.py --check --fail-on-outdated

README.md

@@ -14,3 +14,5 @@ As a general rule, you can start each participant from inside their `<tutorial>/
 Contributions to this repository are very welcome. Please refer to the page [Contribute to preCICE](https://precice.org/community-contribute-to-precice.html) for a few guidelines and hints to help you in this direction.
 
 Note that we use [Git LFS](https://git-lfs.com/) to version reference results. These will appear as seemingly empty files containing URLs if you don't have Git LFS installed (optional, mainly useful for our system tests).
+
+For Python dependency ranges and the sibling `requirements-reference.txt` files used for reproducible installs, see [`tools/releasing/README.md`](tools/releasing/README.md).

changelog-entries/610.md

@@ -0,0 +1 @@
+- Add loose version constraints to tutorial `requirements.txt` files and sibling `requirements-reference.txt` pins generated from PyPI via `tools/releasing/update-requirements-reference.py`, with a CI check that requires reference files on `develop` and up-to-date pins on release PRs to `master` ([#871](https://github.com/precice/tutorials/pull/871)).

channel-transport-particles/fluid-nutils/requirements-reference.txt

@@ -0,0 +1,10 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: channel-transport-particles/fluid-nutils/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+setuptools==83.0.0
+nutils==7.3
+numpy==1.26.4
+pyprecice==3.4.0

channel-transport-particles/fluid-nutils/requirements.txt

@@ -1,5 +1,4 @@
-setuptools # required by nutils
+setuptools>=69.0.0  # required by nutils
 nutils~=7.3
 numpy >1, <2
 pyprecice~=3.0
-setuptools

channel-transport-reaction/chemical-fenics/requirements-reference.txt

@@ -0,0 +1,13 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: channel-transport-reaction/chemical-fenics/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+fenicsprecice==2.3.0
+fenics-dijitso==2019.1.0
+# fenics-dolfin~=2019.0  # non-PyPI (system/PPA or no matching PyPI version)
+fenics-ffc==2019.1.0.post0
+fenics-fiat==2019.1.0
+fenics-ufl-legacy==2022.3.0

channel-transport-reaction/fluid-fenics/requirements-reference.txt

@@ -0,0 +1,13 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: channel-transport-reaction/fluid-fenics/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+fenicsprecice==2.3.0
+fenics-dijitso==2019.1.0
+# fenics-dolfin~=2019.0  # non-PyPI (system/PPA or no matching PyPI version)
+fenics-ffc==2019.1.0.post0
+fenics-fiat==2019.1.0
+fenics-ufl-legacy==2022.3.0

channel-transport/fluid-nutils/requirements-reference.txt

@@ -0,0 +1,10 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: channel-transport/fluid-nutils/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+setuptools==83.0.0
+nutils==7.3
+numpy==1.26.4
+pyprecice==3.4.0

channel-transport/fluid-nutils/requirements.txt

@@ -1,5 +1,4 @@
-setuptools # required by nutils
+setuptools>=69.0.0  # required by nutils
 nutils~=7.3
 numpy >1, <2
 pyprecice~=3.0
-setuptools

channel-transport/transport-nutils/requirements-reference.txt

@@ -0,0 +1,10 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: channel-transport/transport-nutils/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+setuptools==83.0.0
+nutils==7.3
+numpy==1.26.4
+pyprecice==3.4.0

channel-transport/transport-nutils/requirements.txt

@@ -1,5 +1,4 @@
-setuptools # required by nutils
+setuptools>=69.0.0  # required by nutils
 nutils~=7.3
 numpy >1, <2
 pyprecice >=3.2 # Remeshing support is available since preCICE version 3.2
-setuptools

elastic-tube-1d/fluid-python/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: elastic-tube-1d/fluid-python/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+matplotlib==3.11.0
+numpy==1.26.4
+pyprecice==3.4.0

elastic-tube-1d/fluid-python/requirements.txt

@@ -1,3 +1,3 @@
-matplotlib
+matplotlib>=3,<4
 numpy >1, <2
 pyprecice~=3.0

elastic-tube-1d/solid-python/requirements-reference.txt

@@ -0,0 +1,8 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: elastic-tube-1d/solid-python/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+pyprecice==3.4.0

elastic-tube-3d/solid-fenics/requirements-reference.txt

@@ -0,0 +1,13 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: elastic-tube-3d/solid-fenics/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+fenicsprecice==2.3.0
+numpy==1.26.4
+fenics-dijitso==2019.1.0
+# fenics-dolfin~=2019.0  # non-PyPI (system/PPA or no matching PyPI version)
+fenics-ffc==2019.1.0.post0
+fenics-fiat==2019.1.0
+fenics-ufl-legacy==2022.3.0

flow-around-controlled-moving-cylinder/controller-fmi/requirements-reference.txt

@@ -0,0 +1,8 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-around-controlled-moving-cylinder/controller-fmi/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+pyprecice==3.4.0
+fmiprecice==0.2.1

flow-around-controlled-moving-cylinder/controller-fmi/requirements.txt

@@ -1,2 +1,2 @@
 pyprecice~=3.0
-fmiprecice
+fmiprecice~=0.2

flow-around-controlled-moving-cylinder/solid-python/requirements-reference.txt

@@ -0,0 +1,8 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-around-controlled-moving-cylinder/solid-python/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+pyprecice==3.4.0
+numpy==1.26.4

flow-over-heated-plate/README.md

@@ -97,7 +97,7 @@ First generate the output for each run by adding export to the participant `Soli
 </participant>
 ```
 
-After that running a case from this tutorial will export data into `solid-*/precice-exports`. To visualize and compare these results run `python3 plot-final-interface-temperature.py` (You can install the required python packages by running `pip3 install -r plot-final-interface-temperature-requirements.txt`). This will plot the dimensionless temperature `theta = (T-300)/(310-300)` (with `T` being the temperature) across the coupling interface, i.e. where the solid and the fluid meet and exchange heat. The x-axis shows the x coordinate and the y-axis the dimensionless temperature `theta` at the interface. If you want to exclude certain cases, simply comment out the corresponding lines in the script. For reference see below:
+After that running a case from this tutorial will export data into `solid-*/precice-exports`. To visualize and compare these results run `python3 plot-final-interface-temperature/plot-final-interface-temperature.py` (You can install the required python packages by running `pip3 install -r plot-final-interface-temperature/requirements.txt`). This will plot the dimensionless temperature `theta = (T-300)/(310-300)` (with `T` being the temperature) across the coupling interface, i.e. where the solid and the fluid meet and exchange heat. The x-axis shows the x coordinate and the y-axis the dimensionless temperature `theta` at the interface. If you want to exclude certain cases, simply comment out the corresponding lines in the script. For reference see below:
 
 ![Comparison of the results with different solvers](images/tutorials-flow-over-heated-plate-results-comparison.png)
 

flow-over-heated-plate/fluid-su2/requirements-reference.txt

@@ -0,0 +1,8 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-over-heated-plate/fluid-su2/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+pyprecice==3.4.0

flow-over-heated-plate/plot-final-interface-temperature.py → flow-over-heated-plate/plot-final-interface-temperature/plot-final-interface-temperature.py

@@ -3,18 +3,21 @@
 from matplotlib import pyplot as plt
 import numpy as np
 import os
+from pathlib import Path
+
+TUTORIAL_ROOT = Path(__file__).resolve().parent.parent
 
 
 def vtk_to_dict(case):
-    vtkFileName = "solid-{}/precice-exports/Fluid-Mesh-Solid.dt100.vtu".format(
+    vtkFileName = TUTORIAL_ROOT / "solid-{}/precice-exports/Fluid-Mesh-Solid.dt100.vtu".format(
         case)
     if not os.path.exists(vtkFileName):
-        print("No file found for " + vtkFileName)
+        print("No file found for " + str(vtkFileName))
         return {}  # return empty dict if file not found
 
     # read the vtk file as an unstructured grid
     reader = vtk.vtkXMLUnstructuredGridReader()
-    reader.SetFileName(vtkFileName)
+    reader.SetFileName(str(vtkFileName))
     reader.Update()
 
     # obtain the data

flow-over-heated-plate/plot-final-interface-temperature/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-over-heated-plate/plot-final-interface-temperature/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+matplotlib==3.11.0
+vtk==9.6.2

flow-over-heated-plate/plot-final-interface-temperature/requirements.txt

@@ -0,0 +1,3 @@
+numpy >1, <2
+matplotlib>=3,<4
+vtk>=9,<10

flow-over-heated-plate/solid-dunefem/requirements-reference.txt

@@ -0,0 +1,8 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-over-heated-plate/solid-dunefem/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+dune-fem==2.12.0.2
+pyprecice==3.4.0

flow-over-heated-plate/solid-dunefem/requirements.txt

@@ -1,2 +1,2 @@
-dune-fem>=2.11   # Known to work with 2.11.0.5, 2.12.0.2
+dune-fem>=2.11
 pyprecice~=3.0

flow-over-heated-plate/solid-fenics/requirements-reference.txt

@@ -0,0 +1,13 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-over-heated-plate/solid-fenics/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+fenicsprecice==2.3.0
+numpy==1.26.4
+fenics-dijitso==2019.1.0
+# fenics-dolfin~=2019.0  # non-PyPI (system/PPA or no matching PyPI version)
+fenics-ffc==2019.1.0.post0
+fenics-fiat==2019.1.0
+fenics-ufl-legacy==2022.3.0

flow-over-heated-plate/solid-fenicsx/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-over-heated-plate/solid-fenicsx/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+fenicsxprecice==1.0.1
+mpi4py==4.1.2

flow-over-heated-plate/solid-fenicsx/requirements.txt

@@ -1,3 +1,3 @@
-numpy
-fenicsxprecice
+numpy >1, <2
+fenicsxprecice~=1.0
 mpi4py>=3

flow-over-heated-plate/solid-nutils/requirements-reference.txt

@@ -0,0 +1,10 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: flow-over-heated-plate/solid-nutils/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+setuptools==83.0.0
+nutils==7.3
+numpy==1.26.4
+pyprecice==3.4.0

flow-over-heated-plate/solid-nutils/requirements.txt

@@ -1,4 +1,4 @@
-setuptools # required by nutils
+setuptools>=69.0.0  # required by nutils
 nutils~=7.3
 numpy >1, <2
 pyprecice~=3.0

oscillator-overlap/solver-python/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: oscillator-overlap/solver-python/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+pyprecice==3.4.0
+scipy==1.18.0

oscillator-overlap/solver-python/requirements.txt

@@ -1,3 +1,3 @@
 numpy >1, <2
 pyprecice~=3.0
-scipy
+scipy>=1.10,<2

oscillator/mass-left-fmi/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: oscillator/mass-left-fmi/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+pyprecice==3.4.0
+fmiprecice==0.2.1
+pandas==2.3.3

oscillator/mass-left-fmi/requirements.txt

@@ -1,3 +1,3 @@
 pyprecice~=3.0
-fmiprecice
-pandas
+fmiprecice~=0.2
+pandas>=2.0,<3

oscillator/mass-right-fmi/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: oscillator/mass-right-fmi/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+pyprecice==3.4.0
+fmiprecice==0.2.1
+pandas==2.3.3

oscillator/mass-right-fmi/requirements.txt

@@ -1,3 +1,3 @@
 pyprecice~=3.0
-fmiprecice
-pandas
+fmiprecice~=0.2
+pandas>=2.0,<3

oscillator/solver-fmi/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: oscillator/solver-fmi/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+pyprecice==3.4.0
+fmiprecice==0.2.1
+pandas==2.3.3

oscillator/solver-fmi/requirements.txt

@@ -1,3 +1,3 @@
 pyprecice~=3.0
-fmiprecice
-pandas
+fmiprecice~=0.2
+pandas>=2.0,<3

oscillator/solver-python/requirements-reference.txt

@@ -0,0 +1,9 @@
+# Pinned Python dependency versions for this tutorial participant.
+# Reference only: run scripts keep using loose requirements.txt constraints.
+# Generated by tools/releasing/update-requirements-reference.py — do not edit manually.
+# Source: oscillator/solver-python/requirements.txt
+# Generated: 2026-07-13T16:48:40Z
+
+numpy==1.26.4
+pyprecice==3.4.0
+scipy==1.18.0

oscillator/solver-python/requirements.txt

@@ -1,3 +1,3 @@
 numpy >1, <2
 pyprecice~=3.0
-scipy
+scipy>=1.10,<2