Skip to content

Commit

Permalink
Add table for binary wheels in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
etphipp authored Feb 19, 2025
1 parent b82aeba commit 4ef37fb
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@ There are two general approaches for building pygenten:

## Installing with pip

pygenten has experimental support for installation using pip from the source distribution on [pypi](https://pypi.org/project/pygenten/). Furthermore, binary wheels are provided in limited circumstances (currently just linux and mac with OpenMP support only, but more may be provided in the future), enabling immediate installation. The pip installation leverages [scikit-build-core](https://github.com/scikit-build/scikit-build-core) to provide a CMake build backend for pip, which allows the user to provide CMake defines that control the pygenten build process and determine which architectures/parallel programming models are enabled. We thus recommend becoming familiar with the CMake build process for GenTen in general as described [here](https://github.com/sandialabs/GenTen#installing-genten) before continuing. In particular, the user must have BLAS and LAPACK libraries available in their build environment that can either be automatically discovered by CMake or manually specified through `LAPACK_LIBS`.
pygenten has experimental support for installation using pip from the source distribution on [pypi](https://pypi.org/project/pygenten/). Furthermore, binary wheels are provided in the following limited circumstances, enabling immediate installation:
| OS | Arch | Kokkos Backend | BLAS/LAPACK |
| ------------------ | ------ | -------------- | ----------- |
| Linux | x86_64 | OpenMP | OpenBLAS |
| Macos-14 (Sonoma) | arm64 | OpenMP | Accelerate |
| Macos-15 (Sequoia) | arm64 | OpenMP | Accelerate |

(in the future, Windows binaries as well as GPU backends are expected to be provided). The pip installation leverages [scikit-build-core](https://github.com/scikit-build/scikit-build-core) to provide a CMake build backend for pip, which allows the user to provide CMake defines that control the pygenten build process and determine which architectures/parallel programming models are enabled. We thus recommend becoming familiar with the CMake build process for GenTen in general as described [here](https://github.com/sandialabs/GenTen#installing-genten) before continuing. In particular, the user must have BLAS and LAPACK libraries available in their build environment that can either be automatically discovered by CMake or manually specified through `LAPACK_LIBS`.

### Basic installation

Expand Down

0 comments on commit 4ef37fb

Please sign in to comment.