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

Add a battery model reference page to the documentation #3327

Merged
merged 11 commits into from
Sep 21, 2023

Conversation

kratman
Copy link
Contributor

@kratman kratman commented Sep 12, 2023

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.

image

Type of change

Documentation updates only.

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
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 @kratman , nice idea!

@kratman kratman closed this Sep 15, 2023
@kratman kratman deleted the docs/addTheory branch September 15, 2023 14:32
@kratman kratman restored the docs/addTheory branch September 15, 2023 14:34
@kratman kratman reopened this Sep 15, 2023
@kratman
Copy link
Contributor Author

kratman commented Sep 15, 2023

This was closed by accident, I restored the branch

@codecov
Copy link

codecov bot commented Sep 15, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.06% ⚠️

Comparison is base (e4cb2a4) 99.60% compared to head (c32f8ea) 99.55%.
Report is 2 commits behind head on develop.

❗ Current head c32f8ea differs from pull request most recent head 03158b3. Consider uploading reports for the commit 03158b3 to get more accurate results

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     

see 3 files with indirect coverage changes

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

@kratman
Copy link
Contributor Author

kratman commented Sep 19, 2023

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

@brosaplanella
Copy link
Member

The lychee error seems unrelated to this PR so merging it.

@brosaplanella
Copy link
Member

@all-contributors please add @kratman for code (this is for an old PR I forgot to add this)

@allcontributors
Copy link
Contributor

@brosaplanella

I've put up a pull request to add @kratman! 🎉

@brosaplanella brosaplanella merged commit 270c5b0 into pybamm-team:develop Sep 21, 2023
28 of 30 checks passed
@kratman kratman deleted the docs/addTheory branch September 21, 2023 11:23
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.

3 participants