Refine.bio 项目使用教程

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

Refine.bio 是一个旨在整合公开的生物数据，为癌症研究者和 AI/ML 科学家提供即用数据集的项目。以下是项目的目录结构及各部分的简要介绍：

• ami/: 包含与亚马逊机器镜像（AMI）相关的代码。
• api/: 包含构建 refinebio API 的代码。
• common/: 包含 foreman 和 workers 都需要使用的通用代码。
• config/: 包含配置文件和相关设置。
• foreman/: 负责发现和下载/处理数据，并管理任务。
• infrastructure/: 管理 refinebio 基础设施。
• keys/: 存储密钥和相关安全文件。
• scripts/: 包含各种脚本，用于安装、启动服务和执行其他任务。
• test_volume/: 用于测试的数据卷。
• workers/: 负责运行下载器和处理器任务。
• .boto/: 保存 boto 配置文件。
• .dockerignore: 指定不应添加到 Docker 镜像中的文件和目录。
• .gitignore: 指定不应添加到 Git 仓库中的文件和目录。
• DEBUGGING.md: 提供调试信息。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• codecov.yml: Codecov 配置文件。
• schema.png: 项目架构图。
• setup.cfg: 设置配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过一系列的脚本来完成的，以下是一些主要的启动文件：

• scripts/install_all.sh: 自动安装所有必要的依赖。
• scripts/run_postgres.sh: 启动本地 Postgres 服务器。
• scripts/install_db_docker.sh: 初始化数据库。
• scripts/run_psql_shell.sh: 启动 psql 命令行界面。
• scripts/run_es.sh: 启动本地 ElasticSearch 实例。
• scripts/rebuild_es_index.sh: 重建 ES 索引。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，以下是一些重要的配置文件：

• config/settings.py: 包含项目的全局设置，如数据库连接信息、API 密钥等。
• config/local_settings.py: 包含特定于本地开发环境的设置。
• config/production_settings.py: 包含生产环境的配置设置。

在使用项目之前，需要根据实际环境对配置文件进行相应的调整。确保所有敏感信息，如数据库密码和 API 密钥，都正确设置并安全存储。