TheoremExplainAgent 安装与配置指南

1. 项目基础介绍

TheoremExplainAgent 是一个开源项目，旨在通过生成详细的 Manim 视频来视觉化解释数学定理，展现对定理深层理解的同时，揭示文本解释中可能隐藏的推理缺陷。

该项目主要使用 Python 编程语言。

2. 项目使用的关键技术和框架

• Manim: 一个用于生成数学和科学动画的 Python 库。
• OpenAI: 使用 OpenAI 的模型来生成视频内容。
• Retrieval Augmented Generation (RAG): 一种结合检索和生成的方法，用于增强生成过程。
• Visual Language Model (VLM): 用于修正代码中与渲染视觉相关的错误。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统满足以下要求：

• Python 3.12.8
• Conda (用于管理 Python 环境和依赖)
• LaTeX (用于 Manim 生成数学公式)

安装步骤

1. 创建 Conda 环境

   打开命令行，执行以下命令来创建一个名为 tea 的 Conda 环境，并激活它：

   conda create --name tea python=3.12.8
   conda activate tea
   

2. 安装项目依赖

   在激活的 Conda 环境中，使用以下命令安装项目所需的依赖：

   pip install -r requirements.txt
   

3. 安装 Manim

   根据官方文档安装 Manim。具体步骤请参考 Manim 安装文档。

4. 安装额外的系统依赖（Linux Ubuntu）

   如果您使用的是 Linux Ubuntu 系统，可能还需要安装以下依赖：

   sudo apt-get install portaudio19-dev
   sudo apt-get install libsdl-pango-dev
   

5. 下载模型和声音文件

   创建一个名为 models 的文件夹，并下载所需的模型和声音文件：

   mkdir -p models
   && wget -P models https://github.com/thewh1teagle/kokoro-onnx/releases/download/model-files/kokoro-v0_19.onnx
   && wget -P models https://github.com/thewh1teagle/kokoro-onnx/releases/download/model-files/voices.bin
   

6. 配置环境变量

   基于提供的 .env.template 文件，创建一个 .env 文件并填写相应的环境变量：

   touch .env
   

   使用文本编辑器打开 .env 文件并按以下格式填写：

   # OpenAI
   OPENAI_API_KEY=
   "
   "
   # Azure OpenAI
   AZURE_API_KEY=
   "
   "
   AZURE_API_BASE=
   "
   "
   AZURE_API_VERSION=
   "
   "
   # Google Vertex AI
   VERTEXAI_PROJECT=
   "
   "
   VERTEXAI_LOCATION=
   "
   "
   GOOGLE_APPLICATION_CREDENTIALS=
   "
   "
   # Google Gemini
   GEMINI_API_KEY=
   "
   "
   ...
   # Kokoro TTS Settings
   KOKORO_MODEL_PATH=
   "models/kokoro-v0_19.onnx"
   KOKORO_VOICES_PATH=
   "models/voices.bin"
   KOKORO_DEFAULT_VOICE=
   "af"
   KOKORO_DEFAULT_SPEED=
   "1.0"
   KOKORO_DEFAULT_LANG=
   "en-us"
   

   根据您选择的模型填写 API 密钥。

7. 配置 Python 路径

   为了避免导入问题，您需要配置 Python 路径。执行以下命令：

   export PYTHONPATH=$(pwd):$PYTHONPATH
   

至此，您已经完成了 TheoremExplainAgent 的安装和配置。您可以按照项目文档中的指示开始生成和查看视频了。