Skip to content

Fix BatteryElectrochemEODEOL model #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 13 commits into
base: dev
Choose a base branch
from
Draft

Conversation

lymichelle21
Copy link

@lymichelle21 lymichelle21 commented Apr 11, 2025

Address #199 with [Option 3] by reworking the combined BatteryElectroChemEODEOL model so that the relevant parameters do not change inside the model and instead stay as states. This prevents the overriding behavior with qMobile, tDiffusion, and Ro in the original implementation. The parameters affected by side effects are now handled locally in their respective functions.

This way, we can still use LazySim so event_state can be calculated only as needed without intermediate printing. This option is less memory intensive than [Option 1] and less computationally expensive than [Option 2]. The main downside is some instances of duplicated code. There is some refactoring introduced to help mitigate this.

[TODO]: Add tests, update documentation, clean code and move test notebooks

Copy link

Thank you for opening this PR. Each PR into dev requires a code review. For the code review, look at the following:

  • Reviewer (someone other than author) should look for bugs, efficiency, readability, testing, and coverage in examples (if relevant).
  • Ensure that each PR adding a new feature should include a test verifying that feature.
  • All errors from static analysis must be resolved.
  • Review the test coverage reports (if there is a change) - will be added as comment on PR if there is a change
  • Review the software benchmarking results (if there is a change) - will be added as comment on PR
  • Any added dependencies are included in requirements.txt, setup.py, and dev_guide.rst (this document)
  • All warnings from static analysis must be reviewed and resolved - if deemed appropriate.

@lymichelle21 lymichelle21 changed the title Fix EODEOL model Fix BatteryElectrochemEODEOL model Apr 11, 2025
@lymichelle21 lymichelle21 added bug Something isn't working documentation Improvements or additions to documentation, examples, or tutorial components: models tests Updates to tests, benchmarking or CI/CD infrastructure labels Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working components: models documentation Improvements or additions to documentation, examples, or tutorial tests Updates to tests, benchmarking or CI/CD infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant