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: update conda installation + minor fixes #4667

Merged
merged 8 commits into from
Dec 12, 2024

Conversation

Saransh-cpp
Copy link
Member

Description

Update conda installation docs to reflect the new changes in the distribution (pybamm-base and pybamm).

Fixes #4653
Fixes #4630

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 -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ 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

kratman
kratman previously approved these changes Dec 12, 2024
Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

I have a few changes to request here – commenting so that this doesn't get merged just yet.

Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.21%. Comparing base (72c23ea) to head (a567556).
Report is 21 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4667   +/-   ##
========================================
  Coverage    99.21%   99.21%           
========================================
  Files          302      302           
  Lines        22858    22878   +20     
========================================
+ Hits         22679    22699   +20     
  Misses         179      179           

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

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Thanks, @Saransh-cpp! Could you also add a small note with the required conda commands to this page: https://pybamm.org/learn/#installation-instructions and also mark the missing IDAKLU solver there?

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
docs/source/user_guide/installation/gnu-linux-mac.rst Outdated Show resolved Hide resolved
docs/source/user_guide/installation/gnu-linux-mac.rst Outdated Show resolved Hide resolved
docs/source/user_guide/installation/gnu-linux-mac.rst Outdated Show resolved Hide resolved
docs/source/user_guide/installation/index.rst Outdated Show resolved Hide resolved
docs/source/user_guide/installation/windows.rst Outdated Show resolved Hide resolved
docs/source/user_guide/installation/index.rst Outdated Show resolved Hide resolved
Co-authored-by: Agriya Khetarpal <[email protected]>
@Saransh-cpp
Copy link
Member Author

Thanks for the suggestions, @agriyakhetarpal!

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Looks good now, thanks, @Saransh-cpp!

@agriyakhetarpal agriyakhetarpal merged commit 18578f8 into develop Dec 12, 2024
26 checks passed
@agriyakhetarpal agriyakhetarpal deleted the saransh/conda-docs branch December 12, 2024 15:22
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.

Update conda docs Add a note about the missing IDAKLU solver in conda distribution
3 participants