Skip to content

remove eigen - #663

Closed
Yurlungur wants to merge 3 commits into
mainfrom
jmm/no-eigen-submodule
Closed

Yurlungur wants to merge 3 commits into
mainfrom
jmm/no-eigen-submodule

Conversation

@Yurlungur

@Yurlungur Yurlungur commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

PR Summary

As of this month, gitlab now rate limits their users based on their subscription. Eigen is a FOSS user hosted on gitlab, and this unfortunately makes cloning Eigen from gitlab too slow to use for CI. This is causing CI failures downstream.

In singularity-eos, we use Eigen as a fallback for Kokkos-Kernels for linear algebra when Kokkos is disabled. I do believe there is some value in singularity-eos being capable of being built without Kokkos and, as recently as last year, I used Eigen to experiment with some solvers kokkos-kernels didn't provide.

However, I don't really see an acceptable path forward right now where we include Eigen in our builds. We would have to fork the code and own the fork. Even if we switched from git submodules to, e.g., spack or cmake, that would still cause us to hit the rate limits in CI unless we cached the downloaded Eigen files.

As such I'm submitting this MR where we remove Eigen from the dependencies. This should simplify the build matrix somewhat, which is good. But it does mean linear algebra (and thus solvers) only works when Kokkos is enabled.

I think if we need a CPU-only linear algebra package or we need Eigen in specific going forward, it should be relatively easy to re-enable as a one-off.

Note that upon the next release, the spackage will need to be updated. Also this is a breaking change to the API so it probably deserves a major version number bump.

@jdolence @pdmullen FYI.

@rbberger @buechlerm @adamdempsey90 please confirm you're ok with this path.

PR Checklist

  • Adds a test for any bugs fixed. Adds tests for new features.
  • Format your changes by using the make format command after configuring with cmake.
  • Document any new features, update documentation for changes made.
  • Make sure the copyright notice on any files you modified is up to date.
  • After creating a pull request, note it in the CHANGELOG.md file.
  • LANL employees: make sure tests pass both on the github CI and on the Darwin CI
  • If ML was used, make sure to add a disclaimer at the top of a file indicating ML was used to assist in generating the file.
  • If Agentic AI was used, have the AI generate a "proposed changes" markdown file and store it in the plan_histories folder, with a filename the same as the MR number.

If preparing for a new release, in addition please check the following:

  • Update the version in cmake.
  • Move the changes in the CHANGELOG.md file under a new header for the new release, and reset the categories.
  • Maintainers: ensure spackages are up to date:
    • LANL-internal team, update XCAP spackages
    • Current maintainer of upstream spackages, submit MR to spack

@Yurlungur Yurlungur self-assigned this Oct 27, 2026
@Yurlungur Yurlungur added the build Something to do with the build system label Oct 27, 2026
@Yurlungur Yurlungur linked an issue Oct 27, 2026 that may be closed by this pull request
Comment thread CHANGELOG.md
## Current develop

### Added (new features/APIs/variables/...)
- [[PR658]](https://github.com/lanl/singularity-eos/pull/XXX) Add `MinimumInternalEnergy`/`MaximumInternalEnergy` to the EOS introspection API, so energy bounds are reachable through modifiers and the `singularity::EOS` variant

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I noticed a bunch of URLs in the changelog that were dead. Maybe copy-pasted? Had codex fix them.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

That looks like something I messed up. Thanks for the cleanup.

Is using lapack too unpalatable as a fallback?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Nope lapack isn't too unpalatable.

@rbberger

Copy link
Copy Markdown
Collaborator

Removing Eigen because of rate limiting seems a bit extreme. For GitHub CI, can't you just install the distro eigen package?

@Yurlungur Yurlungur mentioned this pull request Oct 27, 2026
8 of 13 tasks
@Yurlungur

Copy link
Copy Markdown
Collaborator Author

Removing Eigen because of rate limiting seems a bit extreme. For GitHub CI, can't you just install the distro eigen package?

Yes---we could do that and I think that's a better solution. Superseded by #664

@Yurlungur Yurlungur closed this Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Something to do with the build system

Projects

None yet

Development

Successfully merging this pull request may close these issues.

remove eigen?

4 participants