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

Implement sodium-ion DFN #4451

Merged
merged 25 commits into from
Oct 7, 2024
Merged

Implement sodium-ion DFN #4451

merged 25 commits into from
Oct 7, 2024

Conversation

brosaplanella
Copy link
Sponsor Member

@brosaplanella brosaplanella commented Sep 18, 2024

Description

Implemented DFN for sodium-ion (same as lithium-ion but in a separate file to avoid conflicts). Implemented parameter value from Chayambuka et al (2022) (actual values and data taken from this COMSOL example).

When adding the CITATION I also modified many citation keys to be consistent with the format (FirstAuthorYear). Hence the many files changed.

Fixes #4397 (not an issue but a discussion)

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)

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

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.42%. Comparing base (2ca16ac) to head (00c4412).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop    #4451    +/-   ##
=========================================
  Coverage    99.41%   99.42%            
=========================================
  Files          293      297     +4     
  Lines        22554    22685   +131     
=========================================
+ Hits         22423    22554   +131     
  Misses         131      131            

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

Copy link
Contributor

@rtimms rtimms left a comment

Choose a reason for hiding this comment

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

thanks @brosaplanella looks good, can you add a test in the basic model tests? sorry, realise this is draft and not finished

@brosaplanella
Copy link
Sponsor Member Author

Doctests are failing but I don't know why. @agriyakhetarpal can you help with this?

DrSOKane
DrSOKane previously approved these changes Oct 2, 2024
Copy link
Contributor

@DrSOKane DrSOKane left a comment

Choose a reason for hiding this comment

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

Amazing work! The next step will be to implement the full DFN (with submodels) for sodium-ion, but this is a welcome and necessary first step.

@DrSOKane
Copy link
Contributor

DrSOKane commented Oct 2, 2024

Amazing work! The next step will be to implement the full DFN (with submodels) for sodium-ion, but this is a welcome and necessary first step.

All you need to do is edit CHANGELOG and this should be ready to merge.

Copy link
Contributor

@kratman kratman left a comment

Choose a reason for hiding this comment

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

I can't vouch for the physics, but the code seems fine to me

@kratman
Copy link
Contributor

kratman commented Oct 7, 2024

Docs all failed, so I will check on that too

@kratman
Copy link
Contributor

kratman commented Oct 7, 2024

Docs failures are unreleated. I am looking into it, but will fix it in a different PR

@kratman kratman merged commit a7d476e into develop Oct 7, 2024
26 checks passed
@kratman kratman deleted the na-ion branch October 7, 2024 19:24
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.

5 participants