Release 3.1.0

[fsimonis]

How to work with this template

• assign a release manager, who takes care of the process
• assign each point below to a responsible person, before you continue. Use @member.

Only the release manager should update this post (even tickboxes, due to race conditions in editing). Everybody else should comment on the PR with the progress.

Pre-PR steps

• Look over PRs and Issues without an assigned version. (all)
• Look over entries in docs/changelog) (all)
  • Add missing entries, if necessary
  • Fix wording and tense
• Make sure you have the latest develop and main branches locally.
• Merge main to develop ( This should result in no commits )
• Check code base w.r.t code formatting (run precice/tools/formatting/check-format) and reformat if required (run precice/tools/formatting/format-all)
• Update the list of operating systems for the package generation in .github/workflows/release.yml
• Create branch release-vX.Y.Z from develop. If needed, git rebase develop.
• Run tools/releasing/bumpversion.sh MAJOR.MINOR.PATCH to bump the version
• Look over the updated CHANGELOG.md of the release branch (all)
  • Check for merged lines
  • Add things, if necessary
  • Fix wording and tense
  • Sort the entries lexicographically
  • Extract summary
• Verify the version changes in:
  • CHANGELOG
  • CMakeLists.txt
  • tools/releasing/packaging/debian/changelog
• Commit the version bump
• Push the release branch to the precice repository
• Prepare independent releases
  • Python bindings
  • (if necessary!) MATLAB bindings
  • (if necessary!) JULIA bindings

Step by step guide

• Open PR from release-vX.Y.Z to main (use this template)
• Do regression tests using the release branch (specific revision) list below ⬇️ (all)
• Fix potential problems in develop (all)
• Rebase the release branch on develop (all)
• Commit the version bump
• Update documentation (all)
  • Update XML configuration reference
  • Update version in precice/precice.github.io:
    • _config.yml
    • _data/sidebars/docs_sidebar.yml
• Approve the PR with at least two reviews (all)
• Merge PR to main ( use git merge --no-ff release-vX.Y.Z )
• Tag release on main vX.Y.Z and verify by running git describe --tags
• Merge back to develop and verify by running git describe --tags
• Triple check that you haven't messed anything up. (You can always discard local changes)
• Push main and push the vX.Y.Z tag
• Push develop
• Wait for the release pipeline
  • To create a new draft release on GitHub
  • To automatically generate packages for the latest Debian and the two latest Ubuntu LTS versions.
• Write release text
• Publish the GitHub release

Regression Tests

Use the following branches:

• precice release-v3.1.0
• pyprecice python-bindings-v3.1.0.0
• matlab-bindings matlab-bindings-v3.1.0.0
• rest main(master)

Run all these tests manually on your system. If you succeed, please write a comment with the revisions of the components that you used below. Example: #507 (comment) and update the table.

State	Success	Failure	Skipped
Write	:o:	:x:	:fast_forward:
Read	⭕	❌	⏩

State	Tester	Test
⭕	@MakisH	quickstart fluid-openfoam - solid-cpp
⭕	@MakisH	flow-over-heated-plate all
⭕	@MakisH	perpendicular-flap fluid-openfoam - solid-dune
⭕	@MakisH	perpendicular-flap fluid-nutils - solid-calculix
⭕	@MakisH	perpendicular-flap fluid-openfoam - solid-dealii
⭕	@MakisH	perpendicular-flap fluid-su2 - solid-fenics
⭕	@fsimonis	heat-exchanger-simplified fluid-(bottom+top)-openfoam - solid-calculix
⭕	@IshaanDesai	two-scale-heat-conduction macro-nutils - micro-nutils
⭕	#1984	elastic-tube-1d fluid-cpp - solid-python
⭕	@MakisH precice/tutorials#509	elastic-tube-3d fluid-openfoam - solid-calculix
⭕	@uekerman	breaking-dam-2d fluid-openfoam - solid-calculix
⭕	@fsimonis	flow-around-controlled-moving-cylinder controller-fmi - fluid-openfoam

Post-release

• Update version specific documentation
• Flag Arch Linux AUR package and dependants as out-of-date.
• Update Spack recipe
• Update pyprecice Spack
• Update Website:
  • Bump version in _config.yml
  • Update the XML reference using binprecice md
  • Look over the Roadmap and update entries.

Release new version for bindings (to ensure compatibility with newest preCICE version)

• Fortran module
• MATLAB bindings
• python bindings
• Julia bindings

Marketing

This will be included into the marketing of the distribution.

Misc

• Update the PR template

To open a new PR with this template, use this PR template query

[fsimonis]

We already did a pretty extensive testing of the elastic-tube-1d in #1984. The elastic-tube-1d for example took overall less iterations compared to v3.0.0.

The improved numerical accuracy may impact other tutorials too.

[MakisH]

In the perpendicular-flap, the watchpoint plots look macroscopically the same for OpenFOAM-CalculiX and SU2-deal.II:

They still differ in the last digits, though. For example, for OpenFOAM-CalculiX:

  Time  Coordinate0  Coordinate1  Displacement0  Displacement1  Force0  Force1
- 1.00000000e-02   0.00000000e+00   1.00000000e+00   1.40208926e-03   2.53734422e-06   2.03655843e+01  -1.52019984e+01
- 5.00000000e+00   0.00000000e+00   1.00000000e+00   4.74162578e-02   7.18069885e-05   7.15678920e+00   1.30275199e+01
+ 1.00000000e-02   0.00000000e+00   1.00000000e+00   1.40209082e-03   2.53740150e-06   2.03655856e+01  -1.52020001e+01
+ 5.00000000e+00   0.00000000e+00   1.00000000e+00   4.74080199e-02   7.18246368e-05   7.15671092e+00   1.30274986e+01

openfoam-calculix-v3.0.0.log
openfoam-calculix-v3.1.0.log
su2-dealii-v3.0.0.log
su2-dealii-v3.1.0.log

[MakisH]

More perpendicular-flap tests in precice/tutorials#507

[MakisH]

Some results for elastic-tube-3d: precice/tutorials#509

I don't have results with v3.0.0 or v2.5.0, besides the watchpoint plot in the tutorial.

[MakisH]

I have also tested the Quickstart and the flow-over-heated-plate with all combinations: precice/tutorials#510

as well as the multiple-perpendicular-flaps: precice/tutorials#511

I have not at any point checked/compared iteration numbers.

[uekerman]

breaking-dam-2d runs and looks meaningful.

• openfoam adapter v1.3.0
• calculix adapter 2b5802e
• tutorials: 3485e524

[fsimonis]

flow-around-controlled-moving-cylinder works

[fsimonis]

The heat-exchanger-simplified works precice/tutorials#513