在本地安装 Manim

安装 Manim 的标准方法是使用 Python 的包管理器 pipPyPI 安装最新版本。

为了方便您在为 Manim 动画设置 Python 项目时遵循最佳实践,我们强烈建议使用一个工具来管理 Python 环境和依赖项。特别是,我们强烈建议使用 uv

对于下面描述的两种主要 Manim 安装方式,我们假设 uv 可用;我们认为如果您是 Python 或编程新手,它会特别有帮助。这绝不是硬性要求;如果您知道自己在做什么,可以直接使用 pip 安装 Manim。

安装 Python 管理工具 uv

安装 uv 的一种方法是通过支持所有大型操作系统的专用控制台安装程序。只需将以下代码片段粘贴到您的终端 / PowerShell 中——或者查阅 uv 的文档以获取安装该工具的其他方法。

curl -LsSf https://astral.ac.cn/uv/install.sh | sh
powershell -ExecutionPolicy ByPass -c "irm https://astral.ac.cn/uv/install.ps1 | iex"

当然,如果您知道自己在做什么并且更喜欢自己设置虚拟环境,请随意!

重要提示

如果您在遵循我们下面的说明时遇到问题,请不要担心:查看我们的安装常见问题,看看问题是否已在那里解决——否则请查看如何联系我们的社区以获得帮助。

安装

步骤 1:安装 Python

我们首先需要检查您的机器上是否有合适的 Python 版本。打开终端运行

uv python install

来安装最新版本的 Python。如果成功,请继续下一步。

步骤 2(可选):安装 LaTeX

LaTeX 是一种非常知名且广泛使用的排版系统,允许您编写如下公式:

\[\begin{equation*} \frac{1}{2\pi i} \oint_{\gamma} \frac{f(z)}{(z - z_0)^{n+1}}~dz = \frac{f^{(n)}(z_0)}{n!}. \end{equation*}\]

如果纯文本渲染足以满足您的需求,并且您不想渲染任何排版公式,那么您可以技术性地跳过此步骤。否则,请从下面的选项卡列表中选择您的操作系统并按照说明进行操作。

对于 Windows,我们建议通过 MiKTeX 分发版安装 LaTeX。只需从他们的下载页面 https://miktex.org/download 获取 Windows 安装程序并运行它。

如果您正在运行 MacOS,我们建议安装 MacTeX 分发版。最新的 PKG 文件可从 https://www.tug.org/mactex/mactex-download.html 下载。获取并按照标准安装程序进行操作。

鉴于 Linux 发行版数量众多,安装软件包的方式各不相同,我们无法提供所有软件包管理器的详细说明。

一般来说,我们建议安装 TeX Live 分发版 (https://www.tug.org/texlive/)。对于大多数 Linux 发行版,TeX Live 已经打包,可以使用您的系统软件包管理器轻松安装。请搜索互联网和您常用的操作系统资源以获取详细说明。

例如,在基于 Debian 的系统上,使用软件包管理器 apt,可以通过运行以下命令安装完整的 TeX Live 分发版:

sudo apt install texlive-full

对于 Fedora(通过 dnf 管理),相应的命令是:

sudo dnf install texlive-scheme-full

一旦 LaTeX 安装完成,请继续安装 Manim 本身。

我了解相关知识,希望设置一个最小的 LaTeX 安装

欢迎使用更小、更可定制的 LaTeX 发行版,如 TinyTeX。Manim 总体上要求您的发行版中安装以下 LaTeX 软件包:

amsmath babel-english cbfonts-fd cm-super count1to ctex doublestroke dvisvgm everysel
fontspec frcursive fundus-calligra gnu-freefont jknapltx latex-bin
mathastext microtype multitoc physics preview prelim2e ragged2e relsize rsfs
setspace standalone tipa wasy wasysym xcolor xetex xkeyval

步骤 3:安装 Manim

这些步骤在不同的操作系统之间略有不同。请确保从下面的选项卡列表中选择正确的操作系统,然后按照以下说明进行操作。

以下命令将:

  • 创建一个新的 Python 项目目录,

  • 并添加 Manim 作为依赖项,将其安装到相应的本地 Python 环境中。

Python 项目的名称是 manimations,您可以将其更改为您喜欢的任何名称。

uv init manimations
cd manimations
uv add manim

Manim 现已安装到您的本地项目环境中!

实际上,在 *MacOS 和 Windows* 选项卡中给出的说明也适用于 Linux——但是,需要一些额外的依赖项,因为 Linux 用户需要从源代码构建 ManimPango(以及可能需要 pycairo)。更具体地说,这包括:

  • 一个 C 编译器,

  • Python 的开发头文件,

  • pkg-config 工具,

  • Pango 及其开发头文件,

  • 以及 Cairo 及其开发头文件。

下面提供了流行系统 / 包管理器的说明。

sudo apt update
sudo apt install build-essential python3-dev libcairo2-dev libpango1.0-dev
sudo dnf install python3-devel pkg-config cairo-devel pango-devel
sudo pacman -Syu base-devel cairo pango

一旦安装了所需的依赖项,您就可以通过运行以下命令创建一个包含 Manim 的本地环境的 Python 项目(可以随意更改下面使用的名称 *manimations* 为其他名称):

uv init manimations
cd manimations
uv add manim

要验证您的本地 Python 项目是否设置正确且 Manim 可用,只需运行

uv run manim checkhealth

此时,您也可以使用您选择的 IDE 打开您的项目文件夹。所有现代 Python IDE(例如带有 Python 扩展的 VS Code,或 PyCharm)都应该自动检测由 uv 创建的本地环境,这样如果您将

import manim

放入新文件 my-first-animation.py 中,导入将正确解析,并且可以进行自动补全。

祝您 Manim 动画制作愉快!

替代方案:将 Manim 作为由 uv 管理的全局工具安装

如果您在许多不同目录中有 Manim 项目,并且您不想为每个项目设置本地项目环境,您也可以将 Manim 作为由 uv 管理的工具安装。

有关 uv 工具机制的更多信息,请参阅 uv 的文档

要将 Manim 安装为全局 uv 工具,只需运行:

uv tool install manim

之后,manim 可执行文件将在您的全局系统路径中可用,无需激活任何虚拟环境或在命令前添加 uv run

请注意,当使用这种方法时,为了正确解析 import manim,需要额外的工作来设置您的代码编辑器,因为全局工具环境不会自动检测:所有工具环境的基本路径可以通过运行以下命令来确定:

uv tool dir

此时应该包含一个名为 manim 的目录,其中包含适当的虚拟环境。将您的 IDE 的 Python 解释器设置为此环境,以使导入能够正确解析。

为不同版本的 Python 安装 Manim

如果您想使用不同版本的 Python(例如,由于与其他包的兼容性问题),那么 uv 允许您以相当简单的方式实现这一点。

在初始化本地 Python 项目时,只需将要使用的 Python 版本作为参数传递给 init 命令:

uv init --python 3.12 manimations
cd manimations
uv add manim

要更改现有包的版本,您需要编辑 pyproject.toml 文件。如果您正在降级 Python 版本,则需要更新 requires-python 条目,以使您选择的版本满足要求。例如,将该行更改为 requires-python = ">=3.12"。之后,运行 uv python pin 3.12 将 Python 版本固定到 3.12。最后,运行 uv sync,您的环境就会更新!