Wycisk OCP Restructure - Add Initial Hysteresis State Parameter

[mleot]

• restructure wycisk ocp to accept an initial hysteresis state as an initial condition

---

Description

This adds a parameter to lithium ion parameters, which is used to set the initial hysteresis state in the Wycisk OCP module.

Fixes #4714

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)
• Breaking 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 tests pass: $ python run-tests.py --all (or $ nox -s tests)
• The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

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

[kratman]

@mleot Are you still working on this PR?

[mleot]

@mleot Are you still working on this PR?

Hi @kratman Sorry for the long pause on this. I did get to a place where I was happy with the initial hysteresis state condition working, but some of the other changes suggested in the related issue seemed difficult to implement, namely the custom functional form of the hysteresis decay state. I think I will propose in the issue that the initial state parameter be a separate PR from the custom functional form of the hysteresis state.

Going to revisit this today and see if I can't bring it back up to date.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.22%. Comparing base (a7253b8) to head (b309454).
Report is 134 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4374      +/-   ##
===========================================
- Coverage    99.22%   99.22%   -0.01%     
===========================================
  Files          303      303              
  Lines        23070    23101      +31     
===========================================
+ Hits         22891    22921      +30     
- Misses         179      180       +1     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.