PoseBusters 项目使用教程

PoseBusters 项目使用教程

posebusters Plausibility checks for generated molecule poses. 项目地址: https://gitcode.com/gh_mirrors/po/posebusters

1. 项目目录结构及介绍

PoseBusters 项目的目录结构如下：

posebusters/
├── docs/
│   └── ...
├── posebusters/
│   ├── __init__.py
│   └── ...
├── tests/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
└── ...

目录结构介绍

• docs/: 存放项目的文档文件，通常包括用户手册、API 文档等。
• posebusters/: 项目的主要代码目录，包含项目的核心功能实现。
• tests/: 存放项目的测试代码，用于确保代码的正确性和稳定性。
• .gitignore: Git 版本控制系统的忽略文件，指定哪些文件或目录不需要被版本控制。
• LICENSE: 项目的开源许可证文件，通常为 BSD-3-Clause 许可证。
• README.md: 项目的介绍文件，通常包含项目的概述、安装方法、使用说明等。
• pyproject.toml: 项目的配置文件，用于指定项目的依赖、构建工具等信息。

2. 项目的启动文件介绍

PoseBusters 项目的启动文件是 posebusters/__init__.py。该文件通常包含项目的初始化代码和入口函数。

# posebusters/__init__.py

def main():
    # 项目的主入口函数
    pass

if __name__ == "__main__":
    main()

启动文件介绍

• main(): 项目的入口函数，通常用于启动项目的核心功能。
• if name == "main":: 确保该脚本在作为主程序运行时才会执行 main() 函数。

3. 项目的配置文件介绍

PoseBusters 项目的配置文件是 pyproject.toml。该文件使用 TOML 格式，用于配置项目的依赖、构建工具等信息。

# pyproject.toml

[tool.poetry]
name = "posebusters"
version = "0.1.0"
description = "Plausibility checks for generated molecule poses"
authors = ["Your Name <you@example.com>"]

[tool.poetry.dependencies]
python = "^3.7"
rdkit = "^2021.09.1"
pandas = "^1.3.3"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

配置文件介绍

• [tool.poetry]: 定义项目的元数据，如项目名称、版本号、描述、作者等。
• [tool.poetry.dependencies]: 定义项目的依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 定义开发环境下的依赖包及其版本要求。
• [build-system]: 定义项目的构建系统及其要求。

通过以上配置，PoseBusters 项目可以方便地管理依赖、构建和发布。

posebusters Plausibility checks for generated molecule poses. 项目地址: https://gitcode.com/gh_mirrors/po/posebusters