Skip to content

Update docs, examples and tests to use IDAKLUSolver#4996

Merged
kratman merged 56 commits into
developfrom
update-docs-to-idaklu
May 13, 2025
Merged

Update docs, examples and tests to use IDAKLUSolver#4996
kratman merged 56 commits into
developfrom
update-docs-to-idaklu

Conversation

@MarcBerliner

@MarcBerliner MarcBerliner commented Apr 25, 2025

Copy link
Copy Markdown
Member

Description

Following the default solver change to IDAKLUSolver, this PR changes the examples, docs, and main tests to use the IDAKLUSolver. The one exception is the lead acid models, which do not work with the IDAKLUSolver.

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #)

Important checks:

Please confirm the following before marking the PR as ready for review:

  • No style issues: nox -s pre-commit
  • All tests pass: nox -s tests
  • The documentation builds: nox -s doctests
  • Code is commented for hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov

codecov Bot commented Apr 25, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.57%. Comparing base (ac32564) to head (0934c05).
⚠️ Report is 125 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4996   +/-   ##
========================================
  Coverage    98.57%   98.57%           
========================================
  Files          304      304           
  Lines        23656    23656           
========================================
  Hits         23320    23320           
  Misses         336      336           

☔ 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.

@MarcBerliner MarcBerliner marked this pull request as ready for review April 25, 2025 19:30
@MarcBerliner MarcBerliner requested a review from a team as a code owner April 25, 2025 19:30

@kratman kratman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partial review. I will finish the reset later

Comment thread docs/source/examples/notebooks/getting_started/tutorial-8-solver-options.ipynb Outdated
Comment thread docs/source/examples/notebooks/initialize-model-with-solution.ipynb Outdated

@kratman kratman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor stuff, most of the rest looks good

Comment thread tests/unit/test_simulation.py
Comment thread tests/unit/test_experiments/test_simulation_with_experiment.py Outdated
Comment thread examples/scripts/DFN_ambient_temperature.py Outdated
Comment thread docs/source/user_guide/getting_started.md Outdated
Comment thread docs/source/examples/notebooks/initialize-model-with-solution.ipynb Outdated
Comment thread docs/source/examples/notebooks/initialize-model-with-solution.ipynb Outdated
Comment thread docs/source/examples/notebooks/initialize-model-with-solution.ipynb Outdated
Comment thread docs/source/examples/notebooks/solvers/dae-solver.ipynb

@kratman kratman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last change, then I will approve

@MarcBerliner MarcBerliner requested a review from kratman May 13, 2025 16:32
@kratman kratman enabled auto-merge (squash) May 13, 2025 16:34
@kratman kratman merged commit a7497a6 into develop May 13, 2025
24 checks passed
@kratman kratman deleted the update-docs-to-idaklu branch May 13, 2025 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants