Open-Catalyst-Dataset 项目启动与配置教程

1. 项目的目录结构及介绍

Open-Catalyst-Dataset 是一个开源项目，用于生成吸附剂-催化剂输入配置的工作流。以下是项目的目录结构及其介绍：

Open-Catalyst-Dataset/
├── .github/              # GitHub 工作流和配置文件
│   ├── workflows/
│   └── ...
├── scripts/             # 脚本文件，用于项目操作和数据处理
├── tests/               # 测试文件，用于验证代码功能
├── ocdata/              # 项目核心代码，包含类和函数
├── .flake8              # Flake8 配置文件，用于代码风格检查
├── .gitignore           # Git 忽略文件列表
├── .pre-commit-config.yaml # Pre-commit 配置文件，用于代码提交前的钩子检查
├── LICENSE.md           # 项目许可证文件
├── README.md            # 项目说明文件
├── README_legacy_OC20.md # 旧版项目说明文件
├── codecov.yml          # CodeCov 配置文件，用于代码覆盖率报告
└── ...

2. 项目的启动文件介绍

项目的启动主要通过 Python 包管理工具进行，以下是启动项目的基本步骤：

1. 克隆项目到本地：

   git clone https://github.com/Open-Catalyst-Project/Open-Catalyst-Dataset.git
   

2. 创建一个新的 Python 环境并激活：

   conda create -n ocp python=3.9
   conda activate ocp
   

3. 安装项目依赖：

   pip install pymatgen==2023.5.10 ase==3.22.1
   

4. 将项目安装为本地包：

   pip install -e .
   

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• .flake8：此文件用于配置 Flake8 代码风格检查工具，确保代码风格的一致性。

• .pre-commit-config.yaml：此文件用于配置 Pre-commit 钩子，这些钩子在代码提交前自动运行，用于检查代码风格、测试等。

• pyproject.toml：此文件是 Python 的项目配置文件，用于定义项目的元数据和依赖。

在进行项目配置时，你可能需要根据自己的需求修改这些文件。例如，如果你需要自定义代码风格检查的规则，可以在 .flake8 文件中进行相应的修改。

此外，项目还可能需要一些特定的数据库文件（如吸附剂和催化剂数据库），这些文件需要在项目启动前准备好，并放置在正确的路径下。

以上是 Open-Catalyst-Dataset 项目的启动和配置基本教程，按照这些步骤，你将能够成功搭建和运行该项目。