RXNMapper 开源项目教程

RXNMapper 开源项目教程

rxnmapperRXNMapper: Unsupervised attention-guided atom-mapping. Code complementing our Science Advances publication on "Extraction of organic chemistry grammar from unsupervised learning of chemical reactions" (https://advances.sciencemag.org/content/7/15/eabe4166). 项目地址:https://gitcode.com/gh_mirrors/rx/rxnmapper

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

RXNMapper 项目的目录结构如下：

rxnmapper/
├── docs/
│   ├── docs_source/
│   └── ...
├── examples/
│   └── ...
├── scripts/
│   └── ...
├── tests/
│   └── ...
├── github/
│   └── workflows/
│       └── ...
├── rxnmapper/
│   └── ...
├── bumpversion.cfg
└── ...

目录结构介绍

• docs/: 包含项目的文档源文件，用于生成项目的文档。
• examples/: 包含项目的示例代码，帮助用户理解如何使用 RXNMapper。
• scripts/: 包含项目的脚本文件，可能用于自动化任务或辅助功能。
• tests/: 包含项目的测试代码，用于确保代码的正确性和稳定性。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化 CI/CD 流程。
• rxnmapper/: 包含项目的主要代码文件，是 RXNMapper 的核心功能实现。
• bumpversion.cfg: 项目的版本管理配置文件，用于自动化版本号的更新。

2. 项目的启动文件介绍

RXNMapper 项目的启动文件位于 rxnmapper/ 目录下。主要的启动文件是 rxnmapper.py，该文件包含了 RXNMapper 的核心功能实现。

启动文件介绍

• rxnmapper.py: 这是 RXNMapper 的主要启动文件，包含了用于化学反应映射的核心功能。用户可以通过导入该文件中的类和函数来使用 RXNMapper 的功能。

3. 项目的配置文件介绍

RXNMapper 项目的配置文件主要包括 bumpversion.cfg 和 github/workflows/ 目录下的工作流配置文件。

配置文件介绍

• bumpversion.cfg: 该配置文件用于管理项目的版本号。通过配置该文件，可以自动化地更新项目的版本号，确保版本管理的规范性和一致性。
• github/workflows/: 该目录下的配置文件用于定义 GitHub Actions 的工作流。这些工作流可以自动化项目的构建、测试和部署流程，确保代码的质量和稳定性。

以上是 RXNMapper 开源项目的目录结构、启动文件和配置文件的介绍。通过这些内容，用户可以更好地理解和使用 RXNMapper 项目。

rxnmapperRXNMapper: Unsupervised attention-guided atom-mapping. Code complementing our Science Advances publication on "Extraction of organic chemistry grammar from unsupervised learning of chemical reactions" (https://advances.sciencemag.org/content/7/15/eabe4166). 项目地址:https://gitcode.com/gh_mirrors/rx/rxnmapper