Add requirements-reference.txt by PranjalManhgaye · Pull Request #871 · precice/tutorials

PranjalManhgaye · 2026-07-09T05:27:59Z

Summary

This PR implements #610 using the approach discussed after #749 and it is the rework of that:

Tutorial requirements.txt files keep loose version ranges (for example numpy >1, <2, pyprecice~=3.0). This PR fills gaps where develop still had unpinned packages (~~39 files; ~ ~13 already had ranges).
A new root file requirements-reference.txt records the exact PyPI versions that satisfy those ranges at generation time (Gemfile.lock style).
tools/report_tutorial_requirements.py generates and checks that file from PyPI.
CI workflow check-requirements-reference.yml runs --check when requirements or the script change.
Tutorial run.sh scripts are unchanged and still install from local requirements.txt. The reference file is for reproducibility and releases, not for day-to-day installs.

This is not tied to reference_versions.yaml and does not change tools/tests/requirements.txt (CI git refs are already handled by #857/#858).

Test Plan

python3 tools/report_tutorial_requirements.py
python3 tools/report_tutorial_requirements.py --check
pre-commit run actionlint --files .github/workflows/check-requirements-reference.yml
pip install --dry-run -r elastic-tube-1d/fluid-python/requirements.txt

Closes #610

Add loose version constraints to remaining tutorial requirements.txt files, generate requirements-reference.txt from PyPI, and check it in CI.

Remove extra trailing blank line in the Python dependencies section.

MakisH

Thank you for the contribution; this will be useful, and it comes at the right time.

My main suggestion, which will change a bit the code, is to split the requirements-reference.txt into one file per requirements.txt.

Other than that, most comments are regarding the version ranges. We do not need to document these in detail, but the comments here might be helpful in the future.

MakisH · 2026-07-09T18:40:27Z

Interesting approach, but this will not be very visible, will not be directly usable, and will quickly become outdated.

Why not just make a requirements-reference.txt next to each requirements.txt file? This would let one just do pip install -r requirements-reference.txt.

Done, each requirements.txt now has a sibling requirements-reference.txt, so you can pip install -r requirements-reference.txt in that folder. The root file is removed.

MakisH · 2026-07-09T18:43:51Z

+## Python dependencies
+
+Each Python participant lists dependencies in its local `requirements.txt` using loose version ranges (for example `numpy >1, <2`, `pyprecice~=3.0`). Tutorial `run.sh` scripts install from these files as before.
+
+The repository root file `requirements-reference.txt` records the latest PyPI versions that satisfy those constraints at generation time. Regenerate it after changing tutorial requirements:
+
+```bash
+python3 tools/report_tutorial_requirements.py
+python3 tools/report_tutorial_requirements.py --check   # CI-style check
+```
+
+This reference manifest is for documentation and reproducibility; it is not used by tutorial run scripts.
+
+Legacy FEniCS packages (for example `fenics-dolfin`) are installed from the system or PPA in several tutorials and are listed in the reference file as non-PyPI dependencies.
+
+When preparing a release pull request to `master`, regenerate and commit `requirements-reference.txt` so the pinned snapshot matches the current tutorial constraints.


This feels a bit disconnected here, but I cannot think of a better place for it right now. In the Python script, I suggested making a tools/releasing/ directory. It could be moved there.

Docs moved to tools/releasing/README.md, with a short pointer from the root README.

MakisH · 2026-07-09T18:44:40Z

@@ -1,5 +1,5 @@
-setuptools # required by nutils
+setuptools>=69.0.0  # required by nutils


Why specifically this version? No need to document, just for me to understand.

Kept as a lower bound that works with current nutils; happy to loosen further if you prefer.

MakisH · 2026-07-09T18:45:06Z

 numpy >1, <2
 pyprecice~=3.0
-setuptools
+setuptools>=69.0.0


Duplicate, can be removed (here and in more files)

Yeah, I removed the duplicate lines.

MakisH · 2026-07-09T18:45:31Z

@@ -1,3 +1,3 @@
-matplotlib
+matplotlib>=3.5,<4


Why this version range?

Aimed to stay on matplotlib 3.x. Unified to matplotlib>=3, <4 everywhere for consistency.

MakisH · 2026-07-09T18:53:18Z

-matplotlib
-treelog
+matplotlib>=3.5,<4
+treelog>=1,<2


Why this version range?

Keep the treelog on 1.x; the exact pin is in the sibling reference file.

MakisH · 2026-07-09T19:04:35Z

+    # Not a pip requirements file (lists stdlib os, unpinned vtk); see develop naming quirk.
+    "flow-over-heated-plate/plot-final-interface-temperature-requirements.txt",


This should actually be a requirements.txt file. I wanted to tidy these plotting python scripts a bit.

Useful to have an exclusion list, I guess (mainly for unmaintained tutorials), but why does this need to be excluded?

Done, moved to plot-final-interface-temperature/requirements.txt (dropped invalid OS), and removed the special exclusion.

MakisH · 2026-07-09T19:06:34Z

Let's move this into a new directory tools/releasing/. The documentation (from the root README.md) can also go there then.

Done, script and docs are under tools/releasing/.

…ependency-versions-clean

Move the generator to tools/releasing/, emit sibling reference files instead of a root manifest, and clean up requirements from review feedback.

PranjalManhgaye added 3 commits July 9, 2026 09:05

Add tutorial Python dependency reference manifest for precice#610

6e583b7

Add loose version constraints to remaining tutorial requirements.txt files, generate requirements-reference.txt from PyPI, and check it in CI.

Update 610.md

626dd48

Fix markdownlint MD012 in README.md

f08a2cb

Remove extra trailing blank line in the Python dependencies section.

PranjalManhgaye requested a review from MakisH July 9, 2026 05:36

PranjalManhgaye added this to GSoC 2026: System tests improvements Jul 9, 2026

github-project-automation Bot moved this to Planned next in GSoC 2026: System tests improvements Jul 9, 2026

PranjalManhgaye moved this from Planned next to Needs review in GSoC 2026: System tests improvements Jul 9, 2026

PranjalManhgaye changed the title ~~Add tutorial Python dependency reference manifest for #610~~ Add tutorial Python dependency reference manifest (rework of #749, closes #610) Jul 9, 2026

PranjalManhgaye changed the title ~~Add tutorial Python dependency reference manifest (rework of #749, closes #610)~~ Add tutorial Python dependency reference manifest (rework of #749) Jul 9, 2026

MakisH reviewed Jul 9, 2026

View reviewed changes

MakisH changed the title ~~Add tutorial Python dependency reference manifest (rework of #749)~~ Add requirements-reference.txt Jul 9, 2026

PranjalManhgaye added 2 commits July 10, 2026 16:49

Merge remote-tracking branch 'upstream/develop' into fix-610-python-d…

bd584b7

…ependency-versions-clean

Address precice#871 review: per-participant requirements-reference files

6b5e773

Move the generator to tools/releasing/, emit sibling reference files instead of a root manifest, and clean up requirements from review feedback.

PranjalManhgaye requested a review from MakisH July 10, 2026 17:06

		@@ -1,5 +1,5 @@
		setuptools # required by nutils
		setuptools>=69.0.0 # required by nutils

		# Not a pip requirements file (lists stdlib os, unpinned vtk); see develop naming quirk.
		"flow-over-heated-plate/plot-final-interface-temperature-requirements.txt",

Uh oh!

Uh oh!

Conversation

PranjalManhgaye commented Jul 9, 2026

Summary

Test Plan

Uh oh!

MakisH left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants