从源代码构建#
注意
如果您只是尝试安装 SciPy,我们建议使用二进制文件 - 有关详细信息,请参阅 安装。
从源代码构建 SciPy 首先需要设置系统级依赖项(编译器、BLAS/LAPACK 库等),然后调用构建。可以进行构建以安装 SciPy 以供本地使用、开发 SciPy 本身或构建可再分发二进制包。并且可能需要自定义构建方式的各个方面。本指南将涵盖所有这些方面。此外,它还提供了有关 SciPy 构建工作原理的背景信息,并链接到与通用 Python 构建和打包文档相关的最新指南。
系统级依赖项#
SciPy 使用编译代码来提高速度,这意味着您需要编译器和一些其他系统级(即非 Python/非 PyPI)依赖项才能在您的系统上构建它。
注意
如果您使用的是 Conda,则可以跳过本节中的步骤 - 除了为 Windows 安装编译器或为 macOS 安装 Apple Developer Tools。所有其他依赖项都将由 mamba env create -f environment.yml
命令自动安装。
如果您想使用系统 Python 和 pip
,您将需要
C、C++ 和 Fortran 编译器(通常为
gcc
、g++
和gfortran
)。Python 头文件(通常是名为
python3-dev
或python3-devel
的包)pkg-config
用于依赖项检测。
要安装 SciPy 构建要求,您可以执行
sudo apt install -y gcc g++ gfortran libopenblas-dev liblapack-dev pkg-config python3-pip python3-dev
或者,您可以执行
sudo apt build-dep scipy
此命令安装构建 SciPy 所需的一切,其优点是新依赖项或所需版本更新由包管理器处理。
要安装 SciPy 构建要求,您可以执行
sudo dnf install gcc-gfortran python3-devel openblas-devel lapack-devel pkgconfig
或者,您可以执行
sudo dnf builddep scipy
此命令安装构建 SciPy 所需的一切,其优点是新依赖项或所需版本更新由包管理器处理。
要安装 SciPy 构建要求,您可以执行
sudo yum install gcc-gfortran python3-devel openblas-devel lapack-devel pkgconfig
或者,您可以执行
sudo yum-builddep scipy
此命令安装构建 SciPy 所需的一切,其优点是新依赖项或所需版本更新由包管理器处理。
要安装 SciPy 构建要求,您可以执行
sudo pacman -S gcc-fortran openblas pkgconf
安装 Apple Developer Tools。一种简单的方法是 打开一个终端窗口,输入命令
xcode-select --install
并按照提示操作。Apple Developer Tools 包括 Git、Clang C/C++ 编译器以及可能需要的其他开发实用程序。
不要使用 macOS 系统 Python。相反,使用 python.org 安装程序 或使用 Homebrew、MacPorts 或 Fink 等包管理器安装 Python。
您需要的其他系统依赖项是 Fortran 编译器、BLAS 和 LAPACK 库以及 pkg-config。使用 Homebrew 最容易安装它们
brew install gfortran openblas pkg-config
注意
export PKG_CONFIG_PATH="/opt/homebrew/opt/openblas/lib/pkgconfig"
可能需要用于构建系统检测 OpenBlas。
注意
从 SciPy >=1.2.0 开始,我们不支持针对系统 Accelerate 库编译 BLAS 和 LAPACK。它不支持足够新的 LAPACK 接口。计划在 2023 年更改此项,因为 macOS 13.3 对 Accelerate 进行了重大升级,解决了所有已知问题。
构建 SciPy 需要一组兼容的 C、C++ 和 Fortran 编译器。这在 Windows 上比在其他平台上更棘手,因为 MSVC 不支持 Fortran,而 gfortran 和 MSVC 无法一起使用。您需要以下编译器组之一
Mingw-w64 编译器 (
gcc
、g++
、gfortran
) - 推荐,因为它最容易安装,并且是我们用于 SciPy 自身 CI 和二进制文件的编译器MSVC + Intel Fortran (
ifort
)Intel 编译器 (
icc
、ifort
)
与 macOS 和 Linux 相比,由于需要设置这些编译器,因此在 Windows 上构建 SciPy 稍微困难一些。无法像在其他平台上那样在命令提示符中调用一行代码。
首先,安装 Microsoft Visual Studio - 2019 社区版或任何较新版本都可以(请参阅 Visual Studio 下载网站)。即使您使用 MinGW-w64 或 Intel 编译器,也需要此项,以确保您拥有 Windows 通用 C 运行时(使用 Mingw-w64 时不需要 Visual Studio 的其他组件,如果需要,可以取消选择这些组件以节省磁盘空间)。
有几个 MinGW-w64 二进制文件来源。我们推荐 RTools 版本,可以使用 Chocolatey 安装(请参阅 此处 的 Chocolatey 安装说明)
choco install rtools -y --no-progress --force --version=4.0.0.20220206
如果出现问题,我们建议使用与 SciPy GitHub Actions Windows CI 作业 中使用的完全相同的版本。
MSVC 安装程序不会将编译器放在系统路径上,并且安装位置可能会更改。要查询安装位置,MSVC 附带了一个 vswhere.exe
命令行实用程序。要使 C/C++ 编译器在您使用的 shell 中可用,您需要运行一个 .bat
文件以获得正确的位数和架构(例如,对于 64 位英特尔 CPU,请使用 vcvars64.bat
)。
有关详细指南,请参阅 从命令行使用 Microsoft C++ 工具集。
与 MSVC 类似,英特尔编译器被设计为与激活脚本 (Intel\oneAPI\setvars.bat
) 一起使用,您可以在您使用的 shell 中运行此脚本。这使得编译器可以在路径上使用。有关详细指南,请参阅 适用于 Windows 的英特尔® oneAPI HPC 工具包入门指南。
注意
编译器应位于系统路径上(即,PATH
环境变量应包含可找到编译器可执行文件的目录),以便找到编译器,但 MSVC 除外,如果且仅当 PATH
上没有其他编译器时,MSVC 将自动找到。您可以使用任何 shell(例如 Powershell、cmd
或 Git Bash)来调用构建。要检查是否如此,请尝试在您使用的 shell 中调用 Fortran 编译器(例如,gfortran --version
或 ifort --version
)。
警告
在使用 conda 环境时,由于 Fortran 编译器过时,环境创建可能无法正常工作。如果发生这种情况,请从 environment.yml
中删除 compilers
条目,然后重试。应按照本节所述安装 Fortran 编译器。
从源代码构建 SciPy#
如果您只想从源代码安装 SciPy 一次,而不进行任何开发工作,那么构建和安装的推荐方法是使用 pip
。否则,建议使用 conda。
注意
如果您还没有 conda 安装,我们建议使用 Mambaforge;任何 conda 版本都可以使用。
从源代码构建以使用 SciPy#
如果您使用的是 conda 环境,pip
仍然是用于调用 SciPy 源代码构建的工具。重要的是始终对 pip install
命令使用 --no-build-isolation
标志,以避免针对 PyPI 中的 numpy
轮子进行构建。为了使之有效,您必须首先将剩余的构建依赖项安装到 conda 环境中
# Either install all SciPy dev dependencies into a fresh conda environment
mamba env create -f environment.yml
# Or, install only the required build dependencies
mamba install python numpy cython pythran pybind11 compilers openblas meson-python pkg-config
# To build the latest stable release:
pip install scipy --no-build-isolation --no-binary scipy
# To build a development version, you need a local clone of the SciPy git repository:
git clone https://github.com/scipy/scipy.git
cd scipy
git submodule update --init
pip install . --no-build-isolation
# To build the latest stable release:
pip install scipy --no-binary scipy
# To build a development version, you need a local clone of the SciPy git repository:
git clone https://github.com/scipy/scipy.git
cd scipy
git submodule update --init
pip install .
从源代码构建以进行 SciPy 开发#
如果您想从源代码构建以处理 SciPy 本身,请首先克隆 SciPy 存储库
git clone https://github.com/scipy/scipy.git
cd scipy
git submodule update --init
然后,您需要执行以下操作
创建专用的开发环境(虚拟环境或 conda 环境),
安装所有必需的依赖项(构建,以及测试、文档和可选依赖项),
使用我们的
dev.py
开发人员界面构建 SciPy。
步骤 (3) 始终相同,步骤 (1) 和 (2) 在 conda 和虚拟环境之间有所不同
要创建一个已安装所有必需和可选依赖项的 scipy-dev
开发环境,请运行
mamba env create -f environment.yml
mamba activate scipy-dev
注意
有许多工具可以管理虚拟环境,例如 venv
、virtualenv
/virtualenvwrapper
、pyenv
/pyenv-virtualenv
、Poetry、PDM、Hatch 等。此处我们使用 Python stdlib 中包含的基本 venv
工具。您可以使用任何其他工具;我们只需要一个已激活的 Python 环境。
在名为 venv
的新目录中创建并激活一个虚拟环境(请注意,确切的激活命令可能因您的操作系统和 shell 而异 - 请参阅 venv
文档中的 “venv 工作原理”)。
python -m venv venv
source venv/bin/activate
python -m venv venv
source venv/bin/activate
python -m venv venv
.\venv\Scripts\activate
然后使用以下命令从 PyPI 安装 Python 级依赖项(请参阅 pyproject.toml
):
# All dependencies
python -m pip install -r requirements/all.txt
# Alternatively, you can install just the dependencies for certain
# development tasks:
# Build and dev dependencies (for `python dev.py {build, lint, mypy}`)
python -m pip install -r requirements/build.txt -r requirements/dev.txt
# Doc dependencies (for `python dev.py {doc, refguide-check}`)
python -m pip install -r requirements/doc.txt
# Test dependencies (for `python dev.py {test, bench, refguide-check}`)
python -m pip install -r requirements/test.txt
要在已激活的开发环境中构建 SciPy,请运行
python dev.py build
这将在存储库中安装 SciPy(默认情况下在 build-install
目录中)。然后,您可以运行测试(python dev.py test
),进入 IPython(python dev.py ipython
),或执行其他开发步骤,如构建 html 文档或运行基准测试。dev.py
接口是自文档化的,因此请参阅 python dev.py --help
和 python dev.py <subcommand> --help
以获取详细指南。
IDE 支持和可编辑安装
虽然 dev.py
接口是我们推荐的处理 SciPy 的方式,但它有一个限制:由于自定义安装位置,使用 dev.py
安装的 SciPy 将不会在 IDE 中自动识别(例如,通过“运行”按钮运行脚本或以可视方式设置断点)。这将与就地构建(或“可编辑安装”)配合得更好。
支持可编辑安装。了解这一点很重要:在给定的存储库克隆中,你可以使用可编辑安装或 dev.py,但不能同时使用两者。如果你使用可编辑安装,则必须直接使用 pytest
和其他开发工具,而不是使用 dev.py
。
要使用可编辑安装,请确保从一个干净的存储库开始(如果你之前使用 dev.py
构建,请运行 git clean -xdf
),并已正确设置本页上文所述的所有依赖项。然后执行
# Note: the --no-build-isolation is important! meson-python will
# auto-rebuild each time SciPy is imported by the Python interpreter.
pip install -e . --no-build-isolation
# To run the tests for, e.g., the `scipy.linalg` module:
pytest scipy/linalg
对 SciPy 代码(包括已编译代码)进行更改时,无需手动重新构建或重新安装。当你运行 git clean -xdf
(它会移除已构建的扩展模块)时,请记住还要使用 pip uninstall scipy
卸载 SciPy。
参阅 meson-python 中有关可编辑安装的文档,以了解底层工作原理的更多详细信息。