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

docs: add sensitivities notebook #4559

Merged
merged 6 commits into from
Nov 5, 2024
Merged

docs: add sensitivities notebook #4559

merged 6 commits into from
Nov 5, 2024

Conversation

martinjrobins
Copy link
Contributor

Description

Fixes #4558

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)

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 Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.29%. Comparing base (b0382e6) to head (11569be).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4559   +/-   ##
========================================
  Coverage    99.29%   99.29%           
========================================
  Files          300      300           
  Lines        22776    22776           
========================================
  Hits         22615    22615           
  Misses         161      161           

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

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 am sort of indifferent to the google collab support since it adds a confusing install for local runs, but if we want to keep supporting that functionality then I think the notebook needs the pybamm install at the top

@kratman
Copy link
Contributor

kratman commented Nov 4, 2024

I am sort of indifferent to the google collab support since it adds a confusing install for local runs, but if we want to keep supporting that functionality then I think the notebook needs the pybamm install at the top

I forgot to mention, that I did not see any other issues with the notebook

@martinjrobins
Copy link
Contributor Author

I forgot to mention, that I did not see any other issues with the notebook

Thanks @kratman, are you happy to approve this now, or does anyone else want to do a review? (I'm happy to merge if not)

@kratman kratman merged commit 4a50562 into develop Nov 5, 2024
25 checks passed
@kratman kratman deleted the i4558-sens-notebook branch November 5, 2024 11:46
pkalbhor pushed a commit to pkalbhor/PyBaMM that referenced this pull request Nov 15, 2024
* docs: add sensitivities notebook

* docs: add sens notebook to toctree

* add install line

---------

Co-authored-by: Eric G. Kratz <[email protected]>
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.

docs: add sensitivities example notebook
2 participants