Dockerize PyBaMM

[arjxn-py]

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #1926

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 (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
• The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --quick.

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[codecov]

Codecov Report

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

Comparison is base (e7bd82f) 99.71% compared to head (c0d7abf) 99.70%.
Report is 47 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3223      +/-   ##
===========================================
- Coverage    99.71%   99.70%   -0.01%     
===========================================
  Files          248      248              
  Lines        18871    18890      +19     
===========================================
+ Hits         18817    18835      +18     
- Misses          54       55       +1     

see 18 files with indirect coverage changes

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

[Saransh-cpp]

Looks awesome, thanks, @arjxn-py!! We would need some docs for this, maybe a new "Install using Docker" page with the contents discussed in the meeting.

[agriyakhetarpal]

gabrieldemarmiesse/python-on-whales looks like a nice project that we can end up using for a Python CLI script wrapper over this Dockerfile, titled docker_install.py. We could also add another interface to it through a pybamm_install_docker entry point in the console_scripts group in setup.py. I would be glad to help around with this

[brosaplanella]

A few comments

[brosaplanella]

Looks good to me, thanks!

[arjxn-py]

pre-commit.ci run

[Saransh-cpp]

Amazing work, thanks @arjxn-py 🥳

One final comment -

[Saransh-cpp]

Great work, @arjxn-py! :)

Some documentation suggestions -