bpx is added as an optional dependency

[Dibyendu-IITKGP]

Description

BPX 0.4.0 requires Pydantic<2. This causes conflict when I am trying to use Battery-Data_Toolkit.

Issue reference

Fixes #498

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.

[BradyPlanden]

Thanks @Dibyendu-IITKGP, please also include a breaking changelog entry, cheers!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (8f222b7) to head (b587e58).
Report is 99 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #499   +/-   ##
========================================
  Coverage    99.04%   99.04%           
========================================
  Files           52       52           
  Lines         3578     3578           
========================================
  Hits          3544     3544           
  Misses          34       34           

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

[BradyPlanden]

Breaking changes would be my preference, as users now need to install with the optional bpx dependency to use that functionality.

[agriyakhetarpal]

Any imports of bpx must also be guarded along with this change, so that import pybop does not break with having installed PyBOP without optional dependencies (e.g., pybop[bpx] and others).

[BradyPlanden]

Thanks @agriyakhetarpal, how do you see this being guarded? This adds an expectation on the end user to add the optional dependency, is there an additional catch to add that provides a useful error message to users who haven't installed with the optional `bpx' dependency?

[agriyakhetarpal]

Yes, @BradyPlanden, we'll have to document that PyBOP uses optional dependencies to handle certain operations (perhaps similar to https://docs.pybamm.org/en/latest/source/user_guide/installation/#dependencies, though it's a little tricky to manage because one forgets to update this page at times).

Yes, a useful error message is also nice to have; we have some guidelines on this in place, too: https://docs.pybamm.org/en/latest/source/user_guide/contributing.html#managing-optional-dependencies-and-their-imports. It works by handling imports using a programmatic importlib.import_module("modulename") pattern, instead of a import modulename statement and linking to the docs if the dependency isn't installed. It could also be useful to check out how pandas does this nowadays, since our implementation was quite inspired by them back when @arjxn-py implemented it!

[BradyPlanden]

Thanks for updating this @Dibyendu-IITKGP. A few suggestions on the documentation, otherwise looks good.

[BradyPlanden]

LGTM - thanks @Dibyendu-IITKGP