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

Reduced the number of docker images by one pybamm:latest #3992

Merged
merged 12 commits into from
Apr 14, 2024

Conversation

santacodes
Copy link
Contributor

Description

The Dockerfile is reduced to include all the solvers by default, the documentation for install from source (docker) and docker.yml workflow file have been updated to push only one single docker image tagged pybamm:latest to dockerhub with all the solvers contained in them by default, i.e IDAKLU and JAX.

Fixes #3666

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

codecov bot commented Apr 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.58%. Comparing base (09ee982) to head (ef4740e).
Report is 1 commits behind head on develop.

❗ Current head ef4740e differs from pull request most recent head 3b2cbc9. Consider uploading reports for the commit 3b2cbc9 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3992   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          257      257           
  Lines        21245    21245           
========================================
  Hits         21157    21157           
  Misses          88       88           

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

.github/workflows/docker.yml Outdated Show resolved Hide resolved
.github/workflows/docker.yml Outdated Show resolved Hide resolved
.github/workflows/docker.yml Outdated Show resolved Hide resolved
.github/workflows/docker.yml Show resolved Hide resolved
@agriyakhetarpal
Copy link
Member

Also, we'll need a CHANGELOG entry about this breaking change, mentioning the removal of the other arguments and asking users to use the pybamm/pybamm:latest image instead.

@santacodes
Copy link
Contributor Author

santacodes commented Apr 12, 2024

Could you do a one final review?

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, @santacodes! This looks good to me. I'll leave it up to @arjxn-py to take another look, after which we can merge.

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@arjxn-py arjxn-py 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 @santacodes, just a couple of comments & suggestions below.

.github/workflows/docker.yml Show resolved Hide resolved
scripts/Dockerfile Show resolved Hide resolved
@arjxn-py
Copy link
Member

This one is good to merge too, I'll merge this as soon as tests pass

@santacodes
Copy link
Contributor Author

Sounds good to me

Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Thanks for taking this up @santacodes 🙂

@arjxn-py arjxn-py merged commit 2454c38 into pybamm-team:develop Apr 14, 2024
4 of 5 checks passed
js1tr3 pushed a commit to js1tr3/PyBaMM that referenced this pull request Aug 12, 2024
…am#3992)

* reduced the image to one

* removed build time args and multiple image builds

* removed optional solvers from docker docs

* Apply suggestions from code review

Co-authored-by: Agriya Khetarpal <[email protected]>

* code review suggestions

* added breaking change to changelog.md

* Update CHANGELOG.md

* Apply suggestions from code review

---------

Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Arjun Verma <[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.

Reduce the number of Docker Images to just one image
3 participants