Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v24.5 #4289

Merged
merged 603 commits into from
Jul 26, 2024
Merged

Release v24.5 #4289

merged 603 commits into from
Jul 26, 2024

Conversation

kratman
Copy link
Contributor

@kratman kratman commented Jul 23, 2024

Description

PyBaMM release 24.5

This will be merged into main.

rtimms and others added 30 commits April 11, 2024 14:34
…uElysia

docs: add AndyLiuElysia as a contributor for doc
* #3526 initialise branch

* #3256 add UpwindDivergence and DownwindDivergence

* work in progress for fixing upwind scheme

* #3526 add missing argument docstring

* #3526 fix upwind/downwind methods

* style: pre-commit fixes

* #3526 get finite volume notebook from develop

* 3526 add temporary test

* ruff

* style: pre-commit fixes

* #3526 remove unused variable

* #3526 clarify wording

* #3526 fix tests

* #3526 add to CHANGELOG

* #3526 update coverage

* #3526 add integration test

* style: pre-commit fixes

* #3526 remove example for debugging

* Remove print for debug

Co-authored-by: Eric G. Kratz <[email protected]>

* #3526 add second test

* #3526 generalised example but did not add test as was hard to know what to measure

* style: pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Valentin Sulzer <[email protected]>
Add normal pdf and cdf functions
…le() (#4005)

* add return type for util.have_jax() and is_jax_compatible()

* add description

* Update pybamm/util.py

Co-authored-by: Agriya Khetarpal <[email protected]>

---------

Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Agriya Khetarpal <[email protected]>
* convert global start context to individual pool context

* Update context creation, add tests for coverage

---------

Co-authored-by: Valentin Sulzer <[email protected]>
Co-authored-by: Eric G. Kratz <[email protected]>
…dependency (#3968)

* Edit pybamm import test

* Guard pybtex imports

* Update pybamm/citations.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update pybamm/citations.py (1)

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update pybamm/citations.py (2)

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update pybamm/citations.py (3)

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update contributing guidelines

* Exclude excepts from test coverage

* style: pre-commit fixes

---------

Co-authored-by: Lorenzo Favaro <[email protected]>
Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Arjun Verma <[email protected]>
* reduced the image to one

* removed build time args and multiple image builds

* removed optional solvers from docker docs

* Apply suggestions from code review

Co-authored-by: Agriya Khetarpal <[email protected]>

* code review suggestions

* added breaking change to changelog.md

* Update CHANGELOG.md

* Apply suggestions from code review

---------

Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Arjun Verma <[email protected]>
* docs: update all_contributors.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Arjun Verma <[email protected]>
Co-authored-by: Agriya Khetarpal <[email protected]>
…4011)

Bumps the actions group with 1 update: [codecov/codecov-action](https://github.com/codecov/codecov-action).


Updates `codecov/codecov-action` from 4.2.0 to 4.3.0
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
- [Commits](codecov/codecov-action@v4.2.0...v4.3.0)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.3.5 → v0.3.7](astral-sh/ruff-pre-commit@v0.3.5...v0.3.7)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
brosaplanella and others added 15 commits June 21, 2024 12:55
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.4.9 → v0.4.10](astral-sh/ruff-pre-commit@v0.4.9...v0.4.10)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* docs: update all_contributors.md [skip ci]

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
* #4120 improved error message

* style: pre-commit fixes

* updated test

* Update tests/unit/test_parameters/test_parameter_values.py

Co-authored-by: Eric G. Kratz <[email protected]>

* Update pybamm/parameters/parameter_values.py

Co-authored-by: Robert Timms <[email protected]>

* Update pybamm/parameters/parameter_values.py

Co-authored-by: Eric G. Kratz <[email protected]>

---------

Co-authored-by: Ubham16 <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Arjun Verma <[email protected]>
Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Robert Timms <[email protected]>
* Update test pypi

* Style fix
* Make function for handling time or reuse an existing one
Fixes #4113

* style: pre-commit fixes

* fixing raises RegEx Error Experiment Test

* fix pre-commit error

* Update pybamm/callbacks.py

Co-authored-by: Eric G. Kratz <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Valentin Sulzer <[email protected]>
Co-authored-by: Eric G. Kratz <[email protected]>
* make longer default duration and calculate it for C-rate

* add tests

* typo

* #4224 add warning for time termination and add abs

* fix tests

* #4224 keep non-C-rate default at 24h for performance reasons

* trying to fix experiment

* fix example

* #4224 eric comments

* fix bug
* fix: error catch for electrode diffusivity

* refactor: update diffusivity error catch and test

* tests: up coverage for diffusivity name catches

* Update pybamm/util.py

Co-authored-by: Agriya Khetarpal <[email protected]>

---------

Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Ferran Brosa Planella <[email protected]>
Co-authored-by: Agriya Khetarpal <[email protected]>
@kratman kratman self-assigned this Jul 23, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@kratman kratman marked this pull request as ready for review July 23, 2024 21:33
@kratman
Copy link
Contributor Author

kratman commented Jul 23, 2024

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

@kratman
Copy link
Contributor Author

kratman commented Jul 24, 2024

@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.

Copy link

codecov bot commented Jul 24, 2024

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 1 commits behind head on main.

Files 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
Copy link
Member

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
Copy link
Contributor Author

kratman commented Jul 24, 2024

@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.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@kratman
Copy link
Contributor Author

kratman commented Jul 25, 2024

This will also include #4293

@kratman kratman merged commit d026075 into main Jul 26, 2024
55 of 65 checks passed
@kratman kratman deleted the v24.5 branch July 26, 2024 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.