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 DFN, MPM, MSMR models #250

Merged
merged 9 commits into from
Apr 8, 2024
Merged

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Mar 20, 2024

Description

This PR completes the following:

  • Adds DFN, MPM, MSMR models.
  • Moves duplicate model class code into parent class.
  • Updates naming of base domain model to align across the codebase.

Issue reference

Fixes #219

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.
  • 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 docs

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.

@BradyPlanden BradyPlanden linked an issue Mar 20, 2024 that may be closed by this pull request
4 tasks
Copy link

codecov bot commented Mar 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.47%. Comparing base (d5a550c) to head (bb14bb8).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #250      +/-   ##
===========================================
+ Coverage    95.44%   95.47%   +0.02%     
===========================================
  Files           36       36              
  Lines         1998     2011      +13     
===========================================
+ Hits          1907     1920      +13     
  Misses          91       91              

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

… pouch-cell example, wrap model solve with exception catching for non-coverging conditions, limit default pybamm.solver.max_step_decrease_count
@BradyPlanden BradyPlanden changed the base branch from develop to 177-plotting-capabilities April 5, 2024 10:12
@BradyPlanden BradyPlanden changed the base branch from 177-plotting-capabilities to develop April 5, 2024 10:12
@BradyPlanden BradyPlanden changed the title [WIP]: Adds DFN, MPM, MSMR models Adds DFN, MPM, MSMR models Apr 5, 2024
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.

Nice additions! Thanks @BradyPlanden

@BradyPlanden BradyPlanden merged commit 8b3189c into develop Apr 8, 2024
31 checks passed
@BradyPlanden BradyPlanden deleted the 219-add-remaining-pybamm-models branch April 8, 2024 13:15
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.

Add remaining PyBaMM Models
2 participants