BIDD-MolMap 使用教程
1. 项目目录结构及介绍
BIDD-MolMap 是一个开源项目,用于分子深度学习中的分子表示。项目目录结构如下:
bidd-molmap/
├── docs/ # 项目文档
├── molmap/ # molmap 相关模块代码
├── paper/ # 论文相关材料
├── misc/ # 杂项文件
├── .gitignore # git 忽略文件
├── README.md # 项目说明文件
├── LICENSE # 项目许可证文件
├── MANIFEST.in # 打包时包含的文件列表
├── clean.sh # 清理脚本
├── make_pip_pkg.md # 打包指南
├── requirements.txt # 项目依赖
├── setup.py # 设置脚本,用于打包和安装
文件和目录说明:
docs/
: 包含项目的文档,可以使用 Sphinx 等工具生成 HTML 文档。molmap/
: 包含项目的主要代码,包括数据预处理、模型架构、训练和测试等。paper/
: 包含论文相关的材料,如数据集和结果。misc/
: 包含一些杂项文件,如排行榜结果等。.gitignore
: 指定 Git 忽略的文件和目录。README.md
: 项目的主说明文件,介绍项目的用途、如何安装和使用。LICENSE
: 项目的许可证信息。MANIFEST.in
: 指定在打包时需要包含的文件和目录。clean.sh
: 用于清理项目文件的脚本。make_pip_pkg.md
: 提供了如何将项目打包成 pip 包的指南。requirements.txt
: 列出了项目运行所需的依赖库。setup.py
: 用于配置和构建项目的 Python 包。
2. 项目的启动文件介绍
在 BIDD-MolMap 项目中,没有特定的启动文件。用户通常需要通过命令行或 Python 脚本来使用项目中的模块和功能。
例如,用户可以通过以下方式使用 MolMap:
from molmap import MolMap
# 定义 MolMap 实例
mp_name = './descriptor.mp'
mp = MolMap(ftype='descriptor', fmap_type='grid', split_channels=True, metric='cosine', var_thr=1e-4)
# 拟合 MolMap
mp.fit(method='umap', verbose=2)
# 保存 MolMap
mp.save(mp_name)
# 可视化
mp.plot_scatter()
mp.plot_grid()
3. 项目的配置文件介绍
在 BIDD-MolMap 项目中,配置文件主要是 requirements.txt
,它列出了项目运行所需的依赖库。以下是配置文件的一个示例:
numpy
scikit-learn
rdkit
tamp
matplotlib
这些依赖可以通过 pip
工具安装:
pip install -r requirements.txt
此外,项目还可能需要一些环境变量的配置,例如在 README.md
中提到的安装 RDKit 的步骤:
conda create -c conda-forge -n molmap rdkit python=3.7
conda activate molmap
conda install -c tmap tmap
pip install molmap
用户应当根据项目的具体需求,在运行之前配置好所有必需的环境和依赖。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考