-
-
Notifications
You must be signed in to change notification settings - Fork 555
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
Add a battery model reference page to the documentation #3327
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @kratman , nice idea!
This was closed by accident, I restored the branch |
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## develop #3327 +/- ##
===========================================
- Coverage 99.60% 99.55% -0.06%
===========================================
Files 253 253
Lines 19546 19553 +7
===========================================
- Hits 19469 19466 -3
- Misses 77 87 +10 ☔ View full report in Codecov by Sentry. |
Sorry, missed that the https://doi.org URLs were ignored by Lychee, but not https://www.doi.org I think this will pass CI the next round if it is triggered again |
The lychee error seems unrelated to this PR so merging it. |
@all-contributors please add @kratman for code (this is for an old PR I forgot to add this) |
I've put up a pull request to add @kratman! 🎉 |
Description
This change adds a new page with links to battery modeling papers in the fundamentals section of the user guide. When I first went through the tutorials, I noticed that the references were at the end of the notebooks. However, I felt it would have been nice to have easy access to some of the articles before going through the tutorials. This way users, like myself, that are new to battery modeling can download the papers side by side with the tutorials on how to run the models.
Right now the page is only a single paragraph and 6 links, but it can be expanded if other users find it useful. I included two review articles, two lithium-ion battery articles, and two lead-acid battery models.
Type of change
Documentation updates only.
Key checklist:
$ 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)$ python run-tests.py --all
(or$ nox -s tests
)$ 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: