Ctrl+K

依赖项#

运行时依赖项#

必需的#

通过包管理器（如 pip 或 conda）安装时，强制依赖项会自动安装。此列表主要用于参考。

可选的#

以下包和工具不是必需的，但可以扩展 Matplotlib 的功能。

后端#

Matplotlib 图形可以渲染到各种用户界面。有关可选 Matplotlib 后端及其提供的功能的更多详细信息，请参阅 什么是后端？。

  • Tk (>= 8.5, != 8.6.0 或 8.6.1)：用于基于 Tk 的后端。Tk 是大多数标准 Python 安装的一部分，但它不是 Python 本身的一部分，因此在极少数情况下可能不存在。

  • PyQt6 (>= 6.1), PySide6, PyQt5 (>= 5.12), 或 PySide2：用于基于 Qt 的后端。

  • PyGObject 和 pycairo (>= 1.14.0)：用于基于 GTK 的后端。如果使用 pip（但不是 conda 或系统包管理器），则必须从源代码构建 PyGObject；请参阅 pygobject 文档。

  • pycairo (>= 1.14.0) 或 cairocffi (>= 0.8)：用于基于 cairo 的后端。

  • wxPython (>= 4)：用于基于 wx 的后端。如果在 Linux 上使用 pip（但不是 conda 或系统包管理器），则必须从 https://wxpython.org/pages/downloads/ 手动下载 wxPython 轮子。

  • Tornado (>= 5)：用于 WebAgg 后端。

  • ipykernel: 用于 nbagg 后端。

  • macOS (>= 10.12): 用于 macosx 后端。

动画#

字体处理和渲染#

C 库#

Matplotlib 自带以下库的副本

  • Agg: Anti-Grain Geometry C++ 渲染引擎

  • ttconv: TrueType 字体实用程序

此外，Matplotlib 还依赖于

  • FreeType (>= 2.3): 字体渲染库

  • QHull (>= 8.0.2): 用于计算三角剖分的库（请注意，此版本也称为 2020.2）

安装期间下载#

默认情况下，Matplotlib 会下载并构建自己的 Qhull 和 FreeType 副本。FreeType 的捆绑版本对于运行测试套件是必要的，因为不同版本的 FreeType 对字符的栅格化方式不同。

使用系统库#

要强制 Matplotlib 使用已安装在系统中的 FreeType 或 Qhull 副本，您必须 通过 meson-python 向 Meson 传递配置设置

python -m pip install \
  --config-settings=setup-args="-Dsystem-freetype=true" \
  --config-settings=setup-args="-Dsystem-qhull=true" \
  .

在这种情况下，您需要安装 FreeType 和 Qhull 库和头文件。这可以通过使用包管理器来实现，例如，对于 FreeType

# Pick ONE of the following:
sudo apt install libfreetype6-dev  # Debian/Ubuntu
sudo dnf install freetype-devel    # Fedora
brew install freetype              # macOS with Homebrew
conda install freetype             # conda, any OS

(根据 Qhull 调整)

在 Linux 和 macOS 上，建议安装 pkg-config，这是一个用于查找 FreeType 的辅助工具。

# Pick ONE of the following:
sudo apt install pkg-config  # Debian/Ubuntu
sudo dnf install pkgconf     # Fedora
brew install pkg-config      # macOS with Homebrew
conda install pkg-config     # conda
# Or point the PKG_CONFIG environment variable to the path to pkg-config:
export PKG_CONFIG=...

如果不使用 pkg-config（特别是在 Windows 上），则可能需要显式设置包含路径（到库头文件）和链接路径（到库），如果它们不在标准位置。这可以通过使用标准环境变量来完成 - 在 Linux 和 macOS 上

export CFLAGS='-I/directory/containing/ft2build.h'
export LDFLAGS='-L/directory/containing/libfreetype.so'

以及在 Windows 上

set CL=/IC:\directory\containing\ft2build.h
set LINK=/LIBPATH:C:\directory\containing\freetype.lib

如果您选择此方法，但需要重置和重建以更改设置，请记住在重新构建之前清除您的工件。

git clean -xfd

从源文件#

如果自动下载不起作用（例如，在隔离系统上），最好使用系统库。但是，您可以手动将 tarball 下载到检出存储库顶层的 subprojects/packagecache 中。如果您希望验证下载的 tarball，则预期 SHA256 哈希值位于 subprojects/*.wrap 中，但它们也会在解包之前由构建系统检查。

最小 pip / manylinux 支持（linux）#

Matplotlib 发布了 manylinux 轮子，它们具有 pip 的最小版本，该版本将识别这些轮子。

  • Python 3.9+: manylinux2014 / pip >= 19.3

在所有情况下，所需的 pip 版本都嵌入在 CPython 源代码中。

构建依赖项#

Python#

默认情况下，pip 将使用构建隔离来构建软件包，这意味着这些构建依赖项会在 Matplotlib 构建过程的持续时间内由 pip 临时安装。但是，在 安装 Matplotlib 用于开发 时，构建隔离会被禁用；因此，我们建议使用我们的 虚拟环境配置 之一来创建一个开发环境，其中这些软件包会自动安装。

如果您正在开发 Matplotlib 并且无法使用我们的环境配置，那么您必须手动将以下软件包安装到您的开发环境中。

  • meson-python (>= 0.13.1).

  • ninja (>= 1.8.2)。这可能在您的包管理器中可用，或者与 Meson 捆绑在一起，但可以通过 pip 安装，如果否则不可用。

  • PyBind11 (>= 2.6)。用于将 C/C++ 代码与 Python 连接起来。

  • setuptools_scm (>= 7)。用于根据当前 git 提交更新报告的 mpl.__version__。对于可编辑安装也是运行时依赖项。

  • NumPy (>= 1.22)。也是运行时依赖项。

编译扩展#

Matplotlib 需要支持 C++17 的 C++ 编译器，每个平台都有一个开发环境，必须在安装编译器之前安装。您可能还需要安装编译扩展源文件中使用的各种库的头文件。

在某些 Linux 系统上，您可以安装元构建包。例如，在 Ubuntu 上 apt install build-essential

否则，使用系统发行版的包管理器安装 gcc。

安装 Xcode 用于 Apple 平台开发。

安装 Visual Studio Build Tools

确保选中“使用 C++ 进行桌面开发”，并且选中并安装了最新的 MSVC、“用于 Windows 的 C++ CMake 工具”以及与您的 Windows 版本兼容的 Windows SDK。它们应该在“可选”子标题下默认选中，但需要从源代码构建 Matplotlib。

或者，您可以安装类似 Linux 的环境，例如 CygWin 或 Windows Subsystem for Linux。如果使用 MinGW-64，我们需要 `Mingw-w64-x86_64-headers 的 **v6** 版本。

我们强烈建议您使用平台工具（即 Xcode、VS Code 或 Linux 包管理器）安装编译器。从以下列表中选择 **一个** 编译器

编译器

最低版本

平台

备注

GCC

7.2

Linux、macOS、Windows

gcc 7.2，GCC：二进制文件，

Clang (LLVM)

5

Linux、macOS

clang 5，LLVM

MSVC++

16.0

Windows

Visual Studio 2019 C++

测试依赖项#

本节列出了运行测试所需的额外软件。

必需#

可选#

除了主库的所有可选依赖项之外，如果安装了以下内容，则将用于测试。

如果任何这些依赖项未被发现，那么依赖它们的测试将被 pytest 跳过。

注意

在 Windows 上安装 Inkscape 时，请确保选择“将 Inkscape 添加到系统 PATH”，无论是针对所有用户还是当前用户，否则测试将无法找到它。

文档依赖项#

Python#

构建 文档 所需的额外 Python 包列在 doc-requirements.txt 中，可以使用以下命令安装：

pip install -r requirements/doc/doc-requirements.txt

doc-requirements.txt 的内容如下所示

# Requirements for building docs
#
# You will first need a matching Matplotlib installation
# e.g (from the Matplotlib root directory)
#     pip install --no-build-isolation --editable .[dev]
#
# Install the documentation requirements with:
#     pip install -r requirements/doc/doc-requirements.txt
#
sphinx>=3.0.0,!=6.1.2
colorspacious
ipython
ipywidgets
ipykernel
numpydoc>=1.0
packaging>=20
pydata-sphinx-theme~=0.15.0
mpl-sphinx-theme~=3.9.0
pyyaml
sphinxcontrib-svg2pdfconverter>=1.1.0
sphinx-copybutton
sphinx-design
sphinx-gallery>=0.12.0
sphinx-tags>=0.3.0

外部工具#

文档需要 LaTeX 和 Graphviz。这些不是 Python 包，必须单独安装。

必需的#

以下 LaTeX 包

许多 LaTex 发行版安装程序的完整版本，例如“texlive-full”或“texlive-all”，通常会自动包含这些包。

可选的#

文档可以在没有 Inkscape 和 optipng 的情况下构建，但构建过程会引发各种警告。

本页内容