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

Download IDAKLU from pybammsolvers #4487

Merged
merged 57 commits into from
Jan 7, 2025

Conversation

kratman
Copy link
Contributor

@kratman kratman commented Oct 3, 2024

Description

This will separate the IDAKLU C++ code from pybamm.

Fixes #3564
Fixes #4611

This ticket is something that can be handled in the other repo
Closes #3603

Type of change

This should speed up CI by skipping the build of the C++ code.

  • Optimization (back-end change that speeds up the code)

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

@kratman kratman self-assigned this Oct 3, 2024
@kratman
Copy link
Contributor Author

kratman commented Oct 3, 2024

A new link error cropped up, but it looks like we could get a lot of savings on time with this update.

Edit: Most of the run time appears to be in the integration tests, so unfortunately the time savings are not as good as I would have hoped.

@agriyakhetarpal
Copy link
Member

The linkage error is the same one as #3783, coming from CasADi's plugin system. I am not sure if it's worth fixing it, since it was fixed by @martinjrobins for the linear interpolant case by dropping down to Python but IIRC there wasn't a way in CasADi for doing it for the cubic

@kratman
Copy link
Contributor Author

kratman commented Oct 3, 2024

@agriyakhetarpal Yeah I was looking at that issue as well. As far as I can tell CasADI sets a path for plugins. I am trying to see if there is a decent workaround since this was part of #4464

My guess is that the wheels for the next release will be broken as well, but I have not confirmed it yet

@agriyakhetarpal
Copy link
Member

agriyakhetarpal commented Oct 3, 2024

There is a workaround for Linux and macOS, but not for Windows (different toolchain); sadly, it's not decent enough to include. I think I'll raise a PR upstream in CasADi to get one part of the linkage going and see if we can migrate to a non-MSVC toolchain (which can potentially help provide that workaround for this on Windows later on). It's been on my list of things to do for a while, but I've yet to do it.

@kratman
Copy link
Contributor Author

kratman commented Oct 3, 2024

This is fixed locally with this: export CASADIPATH=.venv/lib/python3.12/site-packages/casadi

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.66%. Comparing base (a7253b8) to head (c9a75e2).
Report is 25 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4487      +/-   ##
===========================================
- Coverage    99.22%   98.66%   -0.56%     
===========================================
  Files          303      303              
  Lines        23070    23224     +154     
===========================================
+ Hits         22891    22914      +23     
- Misses         179      310     +131     

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

@agriyakhetarpal
Copy link
Member

This is fixed locally with this: export CASADIPATH=.venv/lib/python3.12/site-packages/casadi

Yes, won't work with Windows

@kratman
Copy link
Contributor Author

kratman commented Dec 27, 2024

@MarcBerliner, @martinjrobins Ok I think this is finally working. I am working on tests and docs for the other repo now

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

This is fantastic. Took a quick view and it looks good overall!

@kratman kratman requested review from prady0t and Saransh-cpp January 2, 2025 17:31
.github/workflows/benchmark_on_push.yml Outdated Show resolved Hide resolved
.github/workflows/periodic_benchmarks.yml Outdated Show resolved Hide resolved
.github/workflows/publish_pypi.yml Outdated Show resolved Hide resolved
.github/workflows/publish_pypi.yml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
scripts/Dockerfile Outdated Show resolved Hide resolved
src/pybamm/solvers/idaklu_solver.py Outdated Show resolved Hide resolved
src/pybamm/solvers/idaklu_jax.py Outdated Show resolved Hide resolved
kratman and others added 6 commits January 3, 2025 09:31
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
@kratman kratman mentioned this pull request Jan 6, 2025
6 tasks
@kratman kratman requested a review from a team as a code owner January 7, 2025 16:55
@kratman
Copy link
Contributor Author

kratman commented Jan 7, 2025

@agriyakhetarpal I know we have not solved the ARM64 or conda-forge issues yet, but how do you feel about getting this merged ASAP to see if we start getting issues reported?

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.

Yes, let's do that, @kratman. Linux arm64 is quite common but lacks readily available CI providers for OSS; Windows arm64 CI is not present either outside of Windows Arm dev boxes. FWIW, we can mark both platforms/architectures as unsupported for now and ask users to compile it themselves (the same as we did when macOS arm64 was not common).

Based on https://stackoverflow.com/a/64921347, we will have to wait a bit for PyBaMM 25.1 to be supported on conda-forge until conda-forge/staged-recipes#28748 is resolved, but at the time if someone needs a new version of PyBaMM in a conda environment, they should be able to pip-install without any issues as long as their environment files specify that.

@kratman
Copy link
Contributor Author

kratman commented Jan 7, 2025

Note: The changes from #4736 are not in pybammsolvers yet. The tests pass without the C++ side for now though. I am working on the pybammsolvers v0.0.5 release, but I have to do a bit of testing before it is ready. Hopefully I will finish that off today

@kratman kratman merged commit 2de780d into pybamm-team:develop Jan 7, 2025
25 of 26 checks passed
@kratman kratman deleted the feat/removeIDAKLU branch January 7, 2025 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release blocker Issues that need to be addressed before the creation of a release
Projects
None yet
6 participants