从源代码构建#

注意

如果您只是想安装 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 编译器(通常是 gccg++gfortran)。

  • Python 头文件(通常是一个名为 python3-devpython3-devel 的包)

  • BLAS 和 LAPACK 库。OpenBLAS 是 SciPy 的默认值;其他变体包括 ATLASMKL

  • 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

为了允许构建工具找到 OpenBLAS,您必须运行

brew info openblas | grep PKG_CONFIG_PATH

这将为您提供一个以 export PKG_CONFIG_PATH= 开头的命令,您必须运行该命令。

注意

从 SciPy 1.14.0 开始,我们添加了对用于 BLAS 和 LAPACK 的 Accelerate 库的支持。它需要 macOS 13.3 或更高版本。要使用 Accelerate 而不是 OpenBLAS 进行构建,请参阅选择 BLAS 和 LAPACK 库

需要一组兼容的 C、C++ 和 Fortran 编译器来构建 SciPy。这在 Windows 上比在其他平台上更棘手,因为 MSVC 不支持 Fortran,并且 gfortran 和 MSVC 不能一起使用。您将需要以下其中一组编译器

  1. Mingw-w64 编译器(gccg++gfortran) - 推荐,因为它最容易安装,并且是我们用于 SciPy 自己的 CI 和二进制文件的

  2. MSVC + Intel Fortran (ifort)

  3. Intel 编译器 (iccifort)

与 macOS 和 Linux 相比,由于需要设置这些编译器,因此在 Windows 上构建 SciPy 稍微困难一些。就像在其他平台上一样,无法在命令提示符上只调用一行程序。

首先,安装 Microsoft Visual Studio - 2019 Community Edition 或任何更新的版本都可以(请参阅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 位 Intel CPU,请使用 vcvars64.bat)。

有关详细指南,请参阅从命令行使用 Microsoft C++ 工具集

与 MSVC 类似,Intel 编译器旨在与您在使用的 shell 中运行的激活脚本 (Intel\oneAPI\setvars.bat) 一起使用。这将使编译器在路径上可用。有关详细指南,请参阅适用于 Windows 的 Intel® oneAPI HPC 工具包入门

注意

编译器应位于系统路径上(即,PATH 环境变量应包含可以找到编译器可执行文件的目录),以便被找到,但 MSVC 除外,只有当 PATH 上没有其他编译器时,才会自动找到 MSVC。您可以使用任何 shell(例如,Powershell、cmd 或 Git Bash)来调用构建。要检查是否是这种情况,请尝试在您使用的 shell 中调用 Fortran 编译器(例如,gfortran --versionifort --version)。

警告

当使用 conda 环境时,由于 Fortran 编译器过时,可能会导致环境创建失败。如果发生这种情况,请从 environment.yml 中删除 compilers 条目,然后重试。Fortran 编译器应按本节中的描述进行安装。

从源代码构建 SciPy#

如果您只想从源代码安装一次 SciPy,而不进行任何开发工作,那么建议的构建和安装方式是使用 pip。否则,建议使用 conda。

注意

如果您还没有 conda 安装,我们建议使用Miniforge;任何 conda 版本都可以。

从源代码构建以使用 SciPy#

如果您正在使用 conda 环境,pip 仍然是您用来调用 SciPy 从源代码构建的工具。务必始终在 pip install 命令中使用 --no-build-isolation 标志,以避免针对 PyPI 中的 numpy wheel 构建。为了使其工作,您必须首先将剩余的构建依赖项安装到 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

然后您需要执行以下操作

  1. 创建专门的开发环境(虚拟环境或 conda 环境),

  2. 安装所有需要的依赖项(build,以及 testdocoptional 依赖项),

  3. 使用我们的 dev.py 开发人员界面构建 SciPy。

步骤 (3) 始终相同,步骤 (1) 和 (2) 在 conda 和虚拟环境之间有所不同

要创建一个安装了所有必需和可选依赖项的 scipy-dev 开发环境,请运行

mamba env create -f environment.yml
mamba activate scipy-dev

注意

有很多工具可以管理虚拟环境,例如 venvvirtualenv/virtualenvwrapperpyenv/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.ps1

然后使用以下命令从 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 --helppython 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 关于可编辑安装的文档。

自定义构建#

背景信息#