@@ -25,13 +25,29 @@ In addition to TPB, this package also contains experimental support for SBD's **
2525
2626** Optional (GPU):** NVIDIA HPC SDK (nvc++), CUDA-capable GPU, CUDA-aware MPI.
2727
28- ### Get the SBD C++ source
28+ Either install path compiles the C++ extension on the target machine;
29+ no pre-built wheels are published. The resulting binary depends on
30+ the local MPI and BLAS, so an MPI toolchain (` mpicc ` on ` PATH ` , or
31+ ` MPI_HOME ` set) and BLAS must be installed first; see
32+ [ Environment Variables] ( #environment-variables ) .
2933
30- The SBD C++ headers and apps come from upstream
34+ ### Install from PyPI
35+
36+ ``` bash
37+ pip install sbd-eigensolver
38+ ```
39+
40+ The published source distribution (sdist) bundles the sbd header
41+ files, so this needs no git checkout and no submodule step.
42+
43+ ### Install from git checkout
44+
45+ Here the headers come from upstream
3146[ r-ccs-cms/sbd] ( https://github.com/r-ccs-cms/sbd ) via a git submodule at
32- ` vendor/sbd-upstream/ ` , ** pinned at a specific upstream commit** — currently
33- ` f119a33 ` (` v1.1.0-170 ` ), the same revision the companion SBD fork builds
34- against. Run ` git submodule status ` to see the pinned SHA.
47+ ` vendor/sbd-upstream/ ` , ** pinned at a specific upstream commit** . Run ` git submodule status ` to see the pinned SHA.
48+
49+ When installing from a git checkout, it is important to make sure the
50+ sbd submodule is cloned, too:
3551
3652``` bash
3753git clone --recurse-submodules https://github.com/Qiskit/sbd-eigensolver-python.git
0 commit comments