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

Open
wants to merge 42 commits into
base: develop
Choose a base branch
from

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.64%. Comparing base (a7253b8) to head (68122a2).
Report is 13 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4487      +/-   ##
===========================================
- Coverage    99.22%   98.64%   -0.59%     
===========================================
  Files          303      303              
  Lines        23070    23091      +21     
===========================================
- Hits         22891    22777     -114     
- Misses         179      314     +135     

☔ 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 26, 2024

Testing out the skips and test refactor now with CI. I have some docs stuff to update then this should be mostly ready to go. I will do one more update to pybammsolvers to make sure that the versions of IDAKLU source files match

@kratman
Copy link
Contributor Author

kratman commented Dec 26, 2024

Tests pass, just need to do some documentation fixes

@kratman kratman marked this pull request as ready for review December 27, 2024 18:57
@kratman kratman changed the title [WIP] Download IDAKLU from pybammsolvers Download IDAKLU from pybammsolvers Dec 27, 2024
@kratman
Copy link
Contributor Author

kratman commented Dec 27, 2024

Additional documentation will be added to the pybammsolvers repo

@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

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
4 participants