🛠️ 环境准备#

在运行 MotrixSim 示例程序之前，您需要准备示例环境。本指南将引导您完成环境配置的全部步骤。

环境配置步骤#

以下示例使用了 Python 项目管理工具：UV

在开始之前，请先安装该工具。

步骤 1: 克隆仓库#

git clone https://github.com/Motphys/motrixsim-docs
cd motrixsim-docs
git lfs pull
通过国内站点克隆仓库并配置国内镜像源（可选）

如果您身处中国大陆，建议通过下面方式克隆仓库，并配置国内镜像源以加速依赖下载：

  1. 克隆仓库

    git clone https://www.modelscope.cn/datasets/motphysdevelopers/motrixsim-docs.git
cd motrixsim-docs
git lfs pull

  2. 修改 pyproject.toml 文件，添加国内镜像源

    [[tool.uv.index]]
name = "mirror"
# 请填写您选择的国内镜像源，例如：
# 清华源: "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"
url = ""

步骤 2: 安装依赖#

您可以选择以下任一方式安装依赖：

uv sync --upgrade

uv sync

步骤 3: 验证安装#

运行一个简单的示例来验证环境配置是否成功：

uv run examples/getting_started/empty.py

如果能够正常打开仿真窗口，说明环境配置成功！

常见问题#

Q1: 可以不使用 UV 吗？

A1: 当然可以！示例仓库支持多种 Python 包管理工具。您只需要确保安装了 motrixsim 和相关依赖即可。

Q2: 运行示例时出现模型加载错误怎么办？

A2: 请确保：

  • 当前工作目录在 motrixsim-docs 根目录下

  • 已正确安装所有依赖（可用 uv pip list 检查）

  • 模型文件路径正确

下一步#

环境准备完成后，您可以：