Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: add "building from source" docs #25350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 12, 2023
Merged

DOC: add "building from source" docs #25350

merged 2 commits into from
Dec 12, 2023

Conversation

rgommers
Copy link
Member

@rgommers rgommers commented Dec 8, 2023

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.

[skip actions] [skip azp] [skip cirrus]
Copy link
Contributor

@rossbar rossbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is very useful! A few small in-line comments.

* 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was it intended to have a link for Netlib?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It wasn't, but added now for clarity. I meant it as "Netlib BLAS (i.e., Reference BLAS)"

[skip actions] [skip cirrus] [skip azp]
@charris charris merged commit 79e04cf into numpy:main Dec 12, 2023
@charris
Copy link
Member

charris commented Dec 12, 2023

Thanks Ralf.

@rgommers rgommers deleted the build-docs branch December 12, 2023 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants