BPX example

[rtimms]

Description

Add a BPX example in the example notebooks to replace this repo which isn't tested or maintained. Includes changes from #4634 but made a separate PR since that one is a bug fix.

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

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 tests pass: $ python -m pytest (or $ nox -s tests)
• The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

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

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[rtimms]

should this be moved to pybamm-data? how do you actually add things there?

[kratman]

This is a pretty small file, so there is not a major issue with putting it in the repo. Having the data on pybamm-data will probably make it more compatible with the google-colab functionality in the documentation

[agriyakhetarpal]

should this be moved to pybamm-data?

This is a pretty small file, so there is not a major issue with putting it in the repo. Having the data on pybamm-data will probably make it more compatible with the google-colab functionality in the documentation

Yes, I think we should centralise everything under pybamm-data, so it would be nice to add this file there regardless of its small size (we do have a user-facing DataLoader class, after all, so it makes sense to showcase it more through more example notebooks). And usage with Google Colab is also improved indeed.

how do you actually add things there?

The procedure for adding things there is to first create a new v1.0.1 release and add all of the files from the previous release, add this file, and then bump the version in pybamm_data.py. We do this for reproducibility, such that the next PyBaMM release will retrieve the files from a different release URL (and this gives us the added benefit of better-segregated download analytics/usage stats from the GitHub API). If the changes to this file are final, I can do this later today if you'd like, @rtimms, or step back in case you may wish to do this yourself; please let me know!

[rtimms]

done, thanks!

[kratman]

@agriyakhetarpal Can you add documentation to the pybamm-data repo for how that is done?

[agriyakhetarpal]

Yes, @kratman, on it already but haven't pushed the changes yet. I'll ask you to review when done

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.21%. Comparing base (72c23ea) to head (5193078).
Report is 10 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4635   +/-   ##
========================================
  Coverage    99.21%   99.21%           
========================================
  Files          302      302           
  Lines        22858    22878   +20     
========================================
+ Hits         22679    22699   +20     
  Misses         179      179           

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

[kratman]

I made this a draft until #4634 is merged