Issue 2219 initial soc from experiment

[DrSOKane]

Description

Added new rpt-experiment notebook to demonstrate how to set up degradation experiments with reference performance tests (RPTs).

Fixes #2219

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

All modified lines are covered by tests ✅

Comparison is base (3c48029) 99.56% compared to head (2e8e8ec) 99.56%.
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2851   +/-   ##
========================================
  Coverage    99.56%   99.56%           
========================================
  Files          253      253           
  Lines        19559    19559           
========================================
  Hits         19474    19474           
  Misses          85       85           

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

[rtimms]

@DrSOKane @ganmad do you know what happened to the version of this notebook with the additional custom plots (can’t remember exactly what they were)? that would be a nice addition

[DrSOKane]

@DrSOKane @ganmad do you know what happened to the version of this notebook with the additional custom plots (can’t remember exactly what they were)? that would be a nice addition

Do you mean this one by Ganesh? https://github.com/ganmad/PyBaMM-Local/blob/issue-2219-initial-SoC-from-experiment/examples/notebooks/rpt-experiment.ipynb

[rtimms]

yes, thanks! would be good to add those with some explanation

[ganmad]

Hi Rob and Simon, Thanks for reminding. Will work on it and add some explanation on it. Happy to receive support on this. Best regards, Ganesh

…

On Tue, 2 May 2023, 11:03 Robert Timms, ***@***.***> wrote: yes, thanks! would be good to add those with some explanation — Reply to this email directly, view it on GitHub <#2851 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AL6TQP62IYUZOD3Y743HRHDXEDLWXANCNFSM6AAAAAAWRHMENQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[brosaplanella]

A few minor style comments:

• Use bullet points (* in markdown)
• Format the variables (e.g. cccv_experiment) as inline code, using ` before and after the variable.

Reply via ReviewNB

[brosaplanella]

Thanks Simon! Looks good to me, just a small style comment. It would be good to get @rtimms review before merging.

[rtimms]

Thanks, @DrSOKane looks good! I think the notebook text could be updated to give a better explanation of what is being done and why, but otherwise good to go!