autodE 项目教程

autodE 项目教程

autodE automated reaction profile generation 项目地址: https://gitcode.com/gh_mirrors/au/autodE

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

autodE/
├── autodE/
│   ├── __init__.py
│   ├── config.py
│   ├── core/
│   │   ├── __init__.py
│   │   ├── reaction.py
│   │   ├── species.py
│   │   └── ...
│   ├── conformers/
│   │   ├── __init__.py
│   │   ├── conformer.py
│   │   └── ...
│   ├── wrappers/
│   │   ├── __init__.py
│   │   ├── gaussian.py
│   │   ├── orca.py
│   │   └── ...
│   └── ...
├── examples/
│   ├── example1.py
│   ├── example2.py
│   └── ...
├── tests/
│   ├── test_reaction.py
│   ├── test_species.py
│   └── ...
├── docs/
│   ├── conf.py
│   ├── index.rst
│   └── ...
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── pyproject.toml
├── requirements.txt
└── setup.py

目录结构介绍

• autodE/: 项目的主要代码目录，包含核心模块、配置文件、以及各种功能模块。
  • core/: 包含反应和物种的核心处理逻辑。
  • conformers/: 包含构象搜索和处理的模块。
  • wrappers/: 包含与不同电子结构理论代码的接口。
• examples/: 包含使用 autodE 的示例脚本。
• tests/: 包含项目的单元测试。
• docs/: 包含项目的文档配置和源文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 项目许可证。
• README.md: 项目介绍和使用说明。
• pyproject.toml: 项目配置文件。
• requirements.txt: 项目依赖列表。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

在 autodE 项目中，没有明确的“启动文件”，因为该项目是一个 Python 模块，通常通过导入模块并调用其中的函数来使用。例如，可以通过以下方式启动一个反应计算：

import autode as ade

r = ade.Reactant(name='reactant', smiles='CC[C]([H])[H]')
p = ade.Product(name='product', smiles='C[C]([H])C')
reaction = ade.Reaction(r, p, name='1-2_shift')
reaction.calculate_reaction_profile()

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于定义项目的元数据和构建系统。以下是 autodE 项目中的 pyproject.toml 示例：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "autode"
version = "1.4.3"
description = "automated reaction profile generation"
authors = [
    { name="Tom Young", email="tom.young@example.com" },
    { name="Joseph Silcock", email="joseph.silcock@example.com" }
]
dependencies = [
    "numpy>=1.18.0",
    "scipy>=1.4.0",
    "rdkit>=2020.03.1"
]

requirements.txt

requirements.txt 文件列出了项目运行所需的所有 Python 依赖包及其版本。以下是 autodE 项目中的 requirements.txt 示例：

numpy>=1.18.0
scipy>=1.4.0
rdkit>=2020.03.1

config.py

config.py 文件包含了项目的配置选项，例如计算的核心数、默认的电子结构理论代码等。以下是 autodE 项目中的 config.py 示例：

class Config:
    n_cores = 8
    default_method = 'ORCA'
    default_basis_set = 'def2-SVP'

通过这些配置文件，用户可以自定义 autodE 的行为，以适应不同的计算需求。

autodE automated reaction profile generation 项目地址: https://gitcode.com/gh_mirrors/au/autodE