Skip to content
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

Adds support for IDAKLU w/ output variables #450

Merged
merged 8 commits into from
Aug 13, 2024
Merged

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Aug 8, 2024

Description

Add support and testing for different pybamm solvers. Includes examples for users to benchmark the different solver for selection of the best on their hardware and situation.

Issue reference

Fixes #160

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of 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 unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

Copy link

codecov bot commented Aug 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.67%. Comparing base (a3260c6) to head (65c1c6c).
Report is 481 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #450      +/-   ##
===========================================
- Coverage    98.79%   98.67%   -0.13%     
===========================================
  Files           46       47       +1     
  Lines         2916     3025     +109     
===========================================
+ Hits          2881     2985     +104     
- Misses          35       40       +5     

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

Copy link
Member

@NicolaCourtier NicolaCourtier left a comment

Choose a reason for hiding this comment

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

I added a couple of small comments and a question, but otherwise this looks great! Thanks @BradyPlanden

examples/notebooks/solver_selection.ipynb Outdated Show resolved Hide resolved
examples/notebooks/solver_selection.ipynb Show resolved Hide resolved
pybop/models/base_model.py Show resolved Hide resolved
Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Thanks, @BradyPlanden!

examples/notebooks/solver_selection.ipynb Outdated Show resolved Hide resolved
examples/notebooks/solver_selection.ipynb Show resolved Hide resolved
@BradyPlanden BradyPlanden merged commit 68774e4 into develop Aug 13, 2024
30 checks passed
@BradyPlanden BradyPlanden deleted the 160-idaklu-solver branch August 13, 2024 07:32
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.

Update BaseModel.simulate() for IDAKLU output_variables
3 participants