菜单

安装与设置

相关源文件

本页面提供了 ManimGL(3b1b 的 Manim 版本)的安装和配置的全面指南。我们将涵盖系统要求、不同平台的安装方法、配置选项以及验证步骤,以确保您的设置正常工作。

有关安装 Manim 后的使用方法,请参阅命令行界面。有关内部架构的详细信息,请参阅核心架构

系统要求

在安装 ManimGL 之前,请确保您的系统满足以下先决条件

要求版本目的
Python3.7 或更高版本运行时环境
FFmpeg任何最新版本视频渲染和编码
OpenGL最新版本通过 GPU 进行图形渲染
LaTeX任何最新版本数学排版(可选)
Pango任何最新版本文本渲染(仅限 Linux)

来源:README.md24-27 requirements.txt setup.cfg21-26

安装流程架构

下图展示了 Manim 的通用安装流程

来源:README.md30-44 docs/source/getting_started/installation.rst41-65

安装方法

安装 ManimGL 的最简单方法

这将安装 ManimGL 及其所有 Python 依赖项。运行不带参数的 manimgl 将启动一个简单的测试场景。

来源:README.md32-40

从源代码安装

用于开发或获取最新版本

来源:README.md42-50

特定平台说明

Windows

  1. 安装 FFmpeg

    • 使用 Chocolatey:choco install ffmpeg
    • 或从官方网站下载
    • 确保其在 PATH 中
  2. 安装 LaTeX(可选但推荐)

    • 推荐 Windows 用户使用 MiKTeX
  3. 安装 Python 包

来源:README.md54-64 docs/source/getting_started/installation.rst67-81

macOS

  1. 使用 Homebrew 安装依赖项

  2. 安装 Python 包

来源:README.md66-79 docs/source/getting_started/installation.rst34-36

Linux

  1. 安装系统依赖项

  2. 安装 Python 包

来源:README.md27-28 docs/source/getting_started/installation.rst26-32

使用 Anaconda

如果您更喜欢使用 Anaconda 进行环境管理

  1. 如上所述安装系统依赖项(FFmpeg、LaTeX)
  2. 创建并激活 conda 环境
  3. 安装 ManimGL

来源:README.md81-87 docs/source/getting_started/installation.rst83-95

配置系统

ManimGL 使用分层配置系统,结合了默认设置、自定义配置文件和命令行参数。

配置架构

来源:manimlib/config.py22-51 manimlib/config.py235-393

initialize_manim_config() 函数按以下顺序加载配置

  1. 从 ManimGL 安装目录中的 default_config.yml 加载默认设置
  2. 如果存在,则用工作目录中的 custom_config.yml 中的设置覆盖
  3. 如果提供了 --config_file 参数,则用指定文件中的设置进一步覆盖
  4. 应用命令行参数以修改特定设置

创建自定义配置

在您的项目目录中创建一个名为 custom_config.yml 的文件来覆盖默认设置

来源:manimlib/default_config.yml1-176 manimlib/config.py33-39

主要配置部分

章节目的示例设置
directories文件位置output、raster_images、vector_images、sounds
window显示窗口position, size, monitor_index
camera视频输出resolution, background_color, fps
file_writer视频编码write_to_movie, movie_file_extension, ffmpeg_bin
scene动画行为skip_animations, show_animation_progress, default_wait_time
texLaTeX 渲染template, alignment
colors默认颜色blue_e, red_c, 等

来源:manimlib/default_config.yml11-171

命令行界面

manimgl 命令是运行 Manim 场景的主要入口点。其基本语法是

命令处理流程

来源: manimlib/__main__.py14-65 manimlib/extract_scene.py112-195 manimlib/scene/scene.py147-184

常用命令行选项

选项描述示例
-w将视频写入文件manimgl example.py Scene -w
-o写入并打开视频manimgl example.py Scene -o
-s仅显示最终帧manimgl example.py Scene -s
-n从动画编号开始manimgl example.py Scene -n 2
-f全屏窗口manimgl example.py Scene -f
-p演示模式manimgl example.py Scene -p
-l低质量(480p)manimgl example.py Scene -l
-m中等质量(720p)manimgl example.py Scene -m
--hd高质量(1080p)manimgl example.py Scene --hd
--uhd超高质量(4K)manimgl example.py Scene --uhd

来源: manimlib/config.py54-227 README.md98-106

目录结构

默认情况下,ManimGL 按以下结构组织文件

您可以在 custom_config.yml 文件中自定义这些目录。

来源: manimlib/default_config.yml11-37 manimlib/utils/directories.py12-46

验证您的安装

要验证 ManimGL 是否已正确安装,请运行

这应该会打开一个窗口,播放一个简单的动画,其中有一个徽标出现在屏幕上。

来源: README.md90-96 docs/source/getting_started/installation.rst64-65

常见问题排查

找不到 FFmpeg

如果您看到有关 FFmpeg 的错误

  • 验证安装: ffmpeg -version
  • 检查它是否在您的 PATH 中
  • 在 Windows 上,您可能需要重新启动终端

LaTeX 错误

如果您遇到 LaTeX 渲染问题

  • 确保 LaTeX 已正确安装
  • 首先尝试使用不要求 LaTeX 的场景
  • 检查是否需要特殊包

OpenGL 问题

有关 OpenGL 相关的错误

  • 更新您的显卡驱动程序
  • 确保您的 GPU 支持 OpenGL 3.3+
  • 如果可能,请尝试在不同的机器上运行

Python依赖项

如果缺少依赖项

  • 运行 pip install -r requirements.txt
  • 或使用 pip install manimgl --upgrade 重新安装

来源: requirements.txt1-30 setup.cfg30-61