Add nbqa support support for example notebooks

[arjxn-py]

Description

Adding nbqa as pre-commit hook for jupyter notebooks.

Fixes #2813

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 (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 run-tests.py --all
• The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --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

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (039c786) 99.71% compared to head (d7b7caf) 99.71%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3110   +/-   ##
========================================
  Coverage    99.71%   99.71%           
========================================
  Files          248      248           
  Lines        18761    18761           
========================================
  Hits         18707    18707           
  Misses          54       54           

Impacted Files	Coverage Δ
...bamm/expression_tree/operations/evaluate_python.py	99.29% <ø> (ø)
pybamm/parameters/lithium_ion_parameters.py	100.00% <ø> (ø)
pybamm/solvers/jax_bdf_solver.py	98.89% <ø> (ø)
pybamm/solvers/jax_solver.py	96.77% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[arjxn-py]

@brosaplanella in 6-a-simple-SEI-model.ipynb is giving NameError: name 'x_in_metres' is not defined error, can I do something to fix it?

[Saransh-cpp]

The changes should be structured like this -

• first commit - adding the new pre-commit, ignoring lines, fixing x_in_metres error
• second commit - the changes introduced by the new pre-commit
• third commit - update the .git-blame-ignore-revs with the commit hash of the second commit (and a comment explaining why we are ignoring the commit)

[Saransh-cpp]

Thanks @arjxn-py! Looks great! Feel free to add more commits to this PR, won't mess with git blame!

[Saransh-cpp]

This is an actual error and should not be ignored. It looks like x_in_metres is not defined in the notebook anywhere and ruff caught that. @brosaplanella might be able to help with this better 🙂

[brosaplanella]

That is really weird! Locally the notebook doesn't run (both @arjxn-py and I checked) and obviously it shouldn't, as we are calling an undefined variable. @tinosulzer @rtimms do you have any ideas? I have opened #3165 for further discussion.

[brosaplanella]

The failing notebook should now be fixed, so if you merge develop it should work now.

[Saransh-cpp]

Awesome, thanks @arjxn-py!