Fixes for upcoming PyBaMM v24.5

[BradyPlanden]

Description

Fixes to pybop.experiment and pybop.base_model for pybamm@develop ahead of pybamm v24.5. This currently targets my PyBaMM fork: https://github.com/BradyPlanden/PyBaMM/tree/fix-electrode-diffusion-rename as I've updated the electrode diffusivity -> particle diffusivity variable rename in PyBaMM to be non-breaking, but haven't opened a PR yet.

Issue reference

Fixes #312

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

• Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
• Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

• New Feature: A non-breaking change that adds new functionality.
• Optimization: A code change that improves performance.
• Examples: A change to existing or additional examples.
• Bug Fix: A non-breaking change that addresses an issue.
• Documentation: Updates to documentation or new documentation for new features.
• Refactoring: Non-functional changes that improve the codebase.
• Style: Non-functional changes related to code style (formatting, naming, etc).
• Testing: Additional tests to improve coverage or confirm functionality.
• Other: (Insert description of change)

Key checklist:

• No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• All unit tests pass: $ nox -s tests
• The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

• Code is well-commented, especially in complex or unclear areas.
• Added tests that prove my fix is effective or that my feature works.
• Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.07%. Comparing base (4f7eb59) to head (d7c53c4).
Report is 2 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #313      +/-   ##
===========================================
- Coverage    98.10%   98.07%   -0.03%     
===========================================
  Files           43       44       +1     
  Lines         2632     2697      +65     
===========================================
+ Hits          2582     2645      +63     
- Misses          50       52       +2     

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

[agriyakhetarpal]

Note: PyBaMM v24.5rc1 is out (and was yanked some time later), and v24.5rc2 is out with no extra changes compared to v24.5rc1. PyBaMM v24.5 should hit one week from now – just offering a heads-up.

P.S. I would like to suggest modifying the workflow for nightly PyBaMM to try running against pre-releases if they are available (pip install --pre pybamm) and only then fall back to using the pip install git+<...> command. It should save some CI time (not that it matters because the workflow runs nightly) and also allow testing the IDAKLU solver on Windows without having to compile it because wheels will be available. This is just until we merge pybamm-team/PyBaMM#3945 and nightly releases are out.

[BradyPlanden]

That sounds like a great plan @agriyakhetarpal, please open a issue & PR when you get a chance!

[NicolaCourtier]

Looks good, thanks @BradyPlanden !