DOC: add "building from source" docs #25350
Merged
Conversation
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
[skip actions] [skip azp] [skip cirrus]
20 tasks
rossbar
approved these changes
Dec 8, 2023
Contributor
rossbar
left a comment
rossbar
left a comment
There was a problem hiding this comment.
Thanks @rgommers , this is a very nice writeup. I've been wanting to get a quick crash-course on the latest with the NumPy build system and this fits the bill perfectly.
I left a couple minor comments which can be safely ignored, otherwise this LGTM!
ngoldbaum
reviewed
Dec 9, 2023
mhvk
reviewed
Dec 9, 2023
Contributor
mhvk
left a comment
mhvk
left a comment
There was a problem hiding this comment.
Thanks, this is very useful! A few small in-line comments.
doc/source/building/index.rst
Outdated
| * BLAS and LAPACK libraries. `OpenBLAS <https://github.com/OpenMathLib/OpenBLAS/>`__ | ||
| is the NumPy default; other variants include Apple Accelerate, | ||
| `MKL <https://software.intel.com/en-us/intel-mkl>`__, | ||
| `ATLAS <http://math-atlas.sourceforge.net/>`__ and Netlib (reference) |
Contributor
There was a problem hiding this comment.
Was it intended to have a link for Netlib?
Member
Author
There was a problem hiding this comment.
It wasn't, but added now for clarity. I meant it as "Netlib BLAS (i.e., Reference BLAS)"
[skip actions] [skip cirrus] [skip azp]
Member
|
Thanks Ralf. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This is a complete build docs overhaul, bringing everything up to date after the switch to Meson. A lot of content is taken from http://scipy.github.io/devdocs/building/index.html and adapted for NumPy (spin, Fortran compiler requirement, etc.). The main added content is for BLAS/LAPACK.
I on purpose did not touch the contributing guide, that will be done in a follow-up. These from-scratch docs should cover everything, and build-related info that is duplicate in the contributing guide will disappear in a next PR.
EDIT: after this is merged, the backlink from https://numpy.org/install/ needs updating too.