PrimeKG 项目使用教程

1. 项目目录结构及介绍

PrimeKG 项目的目录结构如下：

PrimeKG/
├── case_study/
├── datasets/
│   ├── omim/
│   └── processing_scripts/
├── fig/
├── knowledge_graph/
├── scripts/
├── .gitignore
├── LICENSE
├── README.md
├── environment.yml
├── requirements.txt
├── setup.sh
├── setup_jupyter.sh
└── updated_requirements.txt

目录介绍

• case_study/: 包含项目的案例研究文件。
• datasets/: 包含项目使用的数据集，包括 OMIM 数据集和处理脚本。
• fig/: 包含项目中使用的图表文件。
• knowledge_graph/: 包含构建知识图谱的相关文件。
• scripts/: 包含项目中使用的脚本文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• environment.yml: Conda 环境配置文件。
• requirements.txt: Python 依赖包列表。
• setup.sh: 项目设置脚本。
• setup_jupyter.sh: Jupyter Notebook 设置脚本。
• updated_requirements.txt: 更新后的 Python 依赖包列表。

2. 项目启动文件介绍

PrimeKG 项目的启动文件主要是 setup.sh 和 setup_jupyter.sh。

setup.sh

setup.sh 是一个 Bash 脚本，用于设置项目环境。它会自动创建所需的目录结构，拉取数据，并运行所有必要的处理和特征提取步骤。

setup_jupyter.sh

setup_jupyter.sh 是一个 Bash 脚本，用于设置 Jupyter Notebook 环境。它可以帮助用户在 Jupyter Notebook 中运行项目代码。

3. 项目的配置文件介绍

PrimeKG 项目的主要配置文件包括 environment.yml 和 requirements.txt。

environment.yml

environment.yml 是 Conda 环境配置文件，用于定义项目所需的 Python 环境和依赖包。用户可以使用以下命令创建 Conda 环境：

conda env create --name PrimeKG --file=environment.yml

requirements.txt

requirements.txt 是 Python 依赖包列表，用于定义项目所需的 Python 包。用户可以使用以下命令安装这些依赖包：

pip install -r requirements.txt

updated_requirements.txt

updated_requirements.txt 是更新后的 Python 依赖包列表，包含最新的依赖包版本。用户可以使用以下命令安装这些依赖包：

pip install -r updated_requirements.txt

通过以上配置文件，用户可以轻松地设置和运行 PrimeKG 项目。