Add O3-openblas-system feature and correct BLAS setup docs (JOSS #98)#107
Merged
Conversation
…S jonaspleyer #98) - New O3-openblas-system feature links the system-installed OpenBLAS via pkg-config instead of compiling OpenBLAS from source; openblas-src is added as an optional dependency solely to forward its system feature. - README Pre-requisite section now states that O3-openblas builds OpenBLAS from source (C/Fortran toolchain, make, network access) and documents the rustls / native-tls requirement of openblas-src 0.10.16+ when used with default-features = false. - Drop the stale Peroxide_BLAS link from the README feature list; point to the Pre-requisite section instead. - CI: o3 job also builds and tests O3-openblas-system; cargo-hack excludes the bare openblas-src flag (no TLS backend on its own) and keeps the new composite flag out of the powerset.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes the remaining points of #98 (JOSS review).
What changed
O3-openblas-systemfeature: links the OpenBLAS already installed on the system via pkg-config instead of compiling OpenBLAS from source.openblas-srcis added as an optional dependency solely to forward itssystemfeature to the instance thatblas-src/lapack-srcalready pull in.O3-openblasneeds system OpenBLAS packages. It does not: without thesystemfeature,openblas-srcalways compiles OpenBLAS from source (needs a C/Fortran toolchain,make, and network access, notlibopenblas). The backend table now lists actual build-time requirements per flag.rustls/native-tlsrequirement: sinceopenblas-src0.10.16, the source tarball is downloaded over HTTPS and a TLS backend feature must be enabled.rustlsis in its default set, so onlydefault-features = falseusers hit this; it is now called out explicitly.Peroxide_BLASlink from the README feature list. That repo documents the pre-0.41 manual setup and misled the reviewer into the hardest path; the setup documentation now lives only in the README's Pre-requisite section.O3-openblas(from source) andO3-openblas-system(pkg-config). cargo-hack excludes the bareopenblas-srcflag (it has no TLS backend on its own) and keeps the new composite flag out of the powerset.Verification
cargo test --features O3-openblas-system: 483 passed on Arch Linux against system openblas 0.3.33 (same distro and version as the reviewer's environment)cargo treeconfirms feature unification resolvesopenblas-srctocblas + lapacke + rustls + systemcargo fmt --check,cargo doc --no-depsclean