mattergen

环境要求

• Linux 系统（README 的安装流程以 Linux 为前提）
• 具备 CUDA GPU
• Python 3.10
• 已安装 uv（包与项目管理器，README 推荐方式）
• 安装 Git LFS 以获取数据集与模型权重

安装与启动步骤

1. 1克隆项目仓库

   把 MatterGen 源码下载到本地，后续本地安装需要在该目录内执行命令。

   git clone https://github.com/microsoft/mattergen.git
   cd mattergen

   复制

2. 2安装 uv

   README 推荐的安装方式依赖 uv，先用 pip 把它装上。

   pip install uv

   复制

3. 3创建并激活虚拟环境

   用 uv 创建 Python 3.10 虚拟环境并激活，README 明确要求 3.10。

   uv venv .venv --python 3.10
   source .venv/bin/activate

   复制

4. 4本地安装依赖

   在仓库根目录以可编辑方式安装项目及其依赖。注意需在激活的虚拟环境中执行。

   uv pip install -e .

   复制

5. 5或从 PyPI 安装

   不想装源码时，可用带 PyTorch Geometric CUDA wheel 的方式安装发行包。

   uv pip install mattergen --find-links https://data.pyg.org/whl/torch-2.2.0+cu121.html

   复制

6. 6检查 Git LFS

   数据集和模型 checkpoint 通过 Git LFS 提供，先确认本机是否已安装。

   git lfs --version

   复制

7. 7安装 Git LFS

   若上一步没有输出版本号（如 git-lfs/3.0.2），按 README 安装并初始化。

   sudo apt install git-lfs
   git lfs install

   复制

如何确认成功

README 未给出启动验证命令；可确认 git lfs --version 正常输出，且 uv pip install -e . 或 PyPI 安装命令无报错。

常见问题

注意事项

• README 的安装流程假设使用 Linux 并具备 CUDA GPU。
• 虚拟环境必须指定 Python 3.10。
• 数据集与模型 checkpoint 由 Git LFS 托管，克隆后需确保 LFS 文件已实际拉取。
• README 未提供端口、服务启动或配置文件说明，本项目以命令行/库方式使用。