|
1 |
| -# OpenBLAS |
2 |
| - |
3 |
| -We build OpenBLAS on Travis-CI (for linux aarch64, ppc64, s390x) and github actions |
4 |
| -for linux, windows, macOS x86_64 and macOS arm64. |
| 1 | +# Wheels containing OpenBLAS |
| 2 | + |
| 3 | +1. The primary purposes of the scipy-openblas32 and scipy-openblas64 wheels are: |
| 4 | + - (a) to use them as build and runtime dependencies in CI and local development for NumPy and SciPy |
| 5 | + - (b) to be vendored into NumPy and SciPy wheels |
| 6 | + - (c) possibly, in the future, being used as runtime dependencies for NumPy |
| 7 | + and/or SciPy. |
| 8 | +2. Other Python projects are also welcome to use these wheels for 1(a) and 1(b). |
| 9 | + - Please note that there is no strong guarantee of backwards compatibility |
| 10 | + for the symbol names nor the small Python API shipped in the wheels to |
| 11 | + enable linking against the shared library. If you want to use them, you |
| 12 | + should probably use `==` pins in the relevant CI/lock files, like NumPy |
| 13 | + and SciPy also do. |
| 14 | + |
| 15 | +[!WARNING] Please do not add a runtime dependency on these wheels if you're not |
| 16 | +NumPy or SciPy. This is not supported and likely to lead to breakage or symbol |
| 17 | +conflicts due to either changes in this repository or due to NumPy or SciPy |
| 18 | +starting to depend on a particular version of this package. |
| 19 | + |
| 20 | +# OpenBLAS library build process |
5 | 21 |
|
6 | 22 | First, tarballs are built using `do_build_lib` in `tools/build_steps.sh` (on
|
7 | 23 | posix in a docker and drectly on macos) or `build_openblas.sh` on windows.
|
@@ -34,4 +50,4 @@ project like SciPy or NumPy:
|
34 | 50 | ## Runtime
|
35 | 51 |
|
36 | 52 | - importing will load openblas into the executable and provide the openblas
|
37 |
| - symbols. |
| 53 | + symbols to the exectuable. |
0 commit comments