Merge pull request #135 from pybop-team/118-add-jupyter-notebooks

Adding notebook examples

.github/workflows/test_on_push.yaml

@@ -45,9 +45,10 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip nox
-      - name: Unit tests with nox
+      - name: Unit and notebook tests with nox
         run: |
           nox -s unit
+          nox -s notebooks
 
   # Runs only on Ubuntu with Python 3.11
   check_coverage:

.pre-commit-config.yaml

@@ -10,11 +10,13 @@ repos:
         args: [--fix, --show-fixes]
         types_or: [python, pyi, jupyter]
       - id: ruff-format
+        types_or: [python, pyi, jupyter]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
         - id: check-added-large-files
+          args: ['--maxkb=1000']
         - id: check-case-conflict
         - id: check-merge-conflict
         - id: check-yaml

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Features
 
+- [#118](https://github.com/pybop-team/PyBOP/issues/118) - Adds example jupyter notebooks.
 - [#151](https://github.com/pybop-team/PyBOP/issues/151) - Adds a standalone version of the Problem class.
 
 ## Bug Fixes

README.md

@@ -117,7 +117,7 @@ The [spm_descent.py](https://github.com/pybop-team/PyBOP/blob/develop/examples/s
 python examples/scripts/spm_descent.py
 ```
 
-In addition, [spm_nlopt.ipynb](https://github.com/pybop-team/PyBOP/blob/develop/examples/notebooks/spm_nlopt.ipynb) provides a second example in notebook form. This example estimates the SPM parameters based on an RMSE cost function and a BOBYQA optimiser.
+In addition, [spm_CMAES.ipynb](https://github.com/pybop-team/PyBOP/blob/develop/examples/notebooks/spm_CMAES.ipynb) provides a second example in notebook form. This example estimates the SPM parameters based on an RMSE cost function and a BOBYQA optimiser.
 
 <!-- Code of Conduct -->
 ## Code of Conduct