教程：TeachOpenCADD开源项目使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01061/article/details/147087111

教程：TeachOpenCADD开源项目使用指南

teachopencadd TeachOpenCADD: a teaching platform for computer-aided drug design (CADD) using open source packages and data 项目地址: https://gitcode.com/gh_mirrors/te/teachopencadd

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

TeachOpenCADD开源项目的目录结构如下：

teachopencadd/
├── .binder/
├── .github/
├── devtools/
├── docs/
├── teachopencadd/
│   ├── .gitattributes
│   ├── .gitignore
│   ├── README.md
│   ├── setup.cfg
│   ├── setup.py
│   ├── versioneer.py
│   └── ...
├── .readthedocs.yml
├── LICENSE
├── MANIFEST.in
└── ...

.binder/: 包含用于在Binder平台上运行Jupyter笔记本的配置文件。
.github/: 存放GitHub工作流程文件，如自动化测试和构建的配置。
devtools/: 开发工具相关的目录，可能包含一些脚本或工具。
docs/: 项目的文档目录，存放项目文档和相关文件。
teachopencadd/: 主项目目录，包含项目的核心文件和模块。
- .gitattributes: 定义如何对待项目中的不同文件类型。
- .gitignore: 定义哪些文件和目录应该被Git忽略。
- README.md: 项目的基本介绍和说明。
- setup.cfg和setup.py: Python项目的配置和设置文件。
- versioneer.py: 用于管理项目版本号的Python模块。
.readthedocs.yml: Read the Docs的配置文件，用于构建和发布项目文档。
LICENSE: 项目的开源许可证文件。
MANIFEST.in: 定义在打包和分发项目时包含哪些文件。

2. 项目的启动文件介绍

项目的启动通常涉及到运行Jupyter笔记本，具体步骤如下：

克隆项目到本地：

git clone https://github.com/volkamerlab/teachopencadd.git

使用Binder在线启动Jupyter笔记本：

点击以下链接启动Binder，然后导航到teachopencadd/talktorials/目录下，就可以找到并运行Jupyter笔记本了。

或者，在本地环境中启动：

安装conda（如果尚未安装）。
创建新的conda环境并安装项目依赖。

conda create -n teachopencadd_env python=3.8
conda activate teachopencadd_env
conda install -c conda-forge teachopencadd

运行Jupyter笔记本：

jupyter notebook teachopencadd/talktorials

3. 项目的配置文件介绍

项目的配置文件主要包括以下内容：

setup.py: 这个文件用于定义Python包的配置，包括包名、版本、描述、依赖项等。

from setuptools import setup

setup(
    name='teachopencadd',
    version='0.1',
    packages=['teachopencadd'],
    install_requires=[
        'rdkit',
        'pypdb',
        'biopandas',
        'nglview',
        'mdanalysis',
        # 添加其他依赖项
    ],
    # 其他配置项...
)

setup.cfg: 这个文件可以用来提供setup.py中的配置信息，使得setup.py更为简洁。
.gitignore: 这个文件用于定义哪些文件和目录不应该提交到Git仓库中，例如Python的缓存文件、日志文件等。
```
__pycache__/
*.pyc
*.pyo
*.log
*.md
# 其他要忽略的文件或目录...
```