Release v24.5

[kratman]

Description

PyBaMM release 24.5

This will be merged into main.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[kratman]

Version is updated, but I did not resolve the conflicts yet. The only changes from RC2 should be the updated version and #4267

[kratman]

@agriyakhetarpal, @Saransh-cpp This should be ready for review if anyone wants to check my work. The only changes made during the conflict resolution were due to mistakes in the change log. Some updates that came after 24.1 had their entries entered into the 24.1 section. This corrects it on main for the release, and the sync PR with develop should fix it there.

I created #4291 for other minor stuff that was found, but not worth holding up the release or risking more conflicts. If we find anything else during the testing process we can put it there. So far it was just some mentions of python 3.8 in the installation docs.

[codecov]

Codecov Report

Attention: Patch coverage is 99.79101% with 2 lines in your changes missing coverage. Please review.

Project coverage is 99.54%. Comparing base (e29dcc0) to head (7661ed9).
Report is 697 commits behind head on main.

Files with missing lines	Patch %	Lines
pybamm/experiment/step/steps.py	98.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4289      +/-   ##
==========================================
- Coverage   99.59%   99.54%   -0.05%     
==========================================
  Files         258      288      +30     
  Lines       20813    21866    +1053     
==========================================
+ Hits        20728    21767    +1039     
- Misses         85       99      +14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[agriyakhetarpal]

This looks good to me. Note that the integration tests job is failing in the scheduled tests, while the unit tests pass because the brew install libomp command isn't present, I'm not sure if we should aim to fix it here because it's going to run the same tests as the PR tests, which are passing. It's difficult to review the changes from the "Changes" tab on this page because of the sheer size of the diff, but I'm assuming that looking at the comparison between develop and v24.5 at the following link: develop...v24.5 should be helpful (and to other reviewers here, too) as to which PRs have been cherry-picked into this branch.

[kratman]

@agriyakhetarpal if it helps, this is the diff between this branch and tag v24.5rc2

git diff origin/v24.5rc2 --stat
 CHANGELOG.md            |  6 +++---
 CITATION.cff            |  2 +-
 pybamm/util.py          | 22 +++++++++++++++-------
 pybamm/version.py       |  2 +-
 pyproject.toml          |  2 +-
 tests/unit/test_util.py | 15 +++++++++++++++
 vcpkg.json              |  2 +-
 7 files changed, 37 insertions(+), 14 deletions(-)

The diff for #4267 is

30 insertions(+), 7 deletions(-)

The remaining changes should mostly be the version and change log.

[agriyakhetarpal]

Thanks! Sorry, I thought I already approved the PR but I notice I didn't

[kratman]

This will also include #4293