FALCON 项目安装与使用指南

1. 项目目录结构及介绍

FALCON 项目是一个用于组装长读取序列的 toolkit，其目录结构如下：

.
├── doc/                    # 项目文档目录
├── examples/               # 示例数据和脚本
├── falcon_kit/             # FALCON 核心代码包
├── src/                    # 源代码目录，包含 C 语言编写的后端代码
├── test/                   # 测试代码和测试数据
├── test_data/              # 测试数据目录
├── .gitignore              # Git 忽略文件列表
├── .gitmodules             # Git 子模块配置文件
├── .travis.yml             # Travis CI 持续集成配置文件
├── LICENSE                 # 项目许可证文件
├── MANIFEST.in             # 打包时包含的文件列表
├── README.md               # 项目说明文件
├── bamboo_build.sh         # bamboo CI 构建脚本
├── bamboo_wheel.sh         # bamboo 构建_wheel 包脚本
├── falcon.snake            # Snakemake 流程定义文件
├── makefile                # Makefile 文件，用于构建项目
├── setup.cfg               # Python 打包配置文件
├── setup.py                # Python 打包脚本
└── travis.sh               # Travis CI 脚本

• doc/：存放项目文档，包括用户手册和开发者文档。
• examples/：包含示例数据和脚本，用于展示如何使用 FALCON 进行组装。
• falcon_kit/：FALCON 的核心代码库，包含了 Python 编写的简单前端代码和 C 语言编写的后端代码。
• src/：源代码目录，主要包含 C 语言编写的代码。
• test/：包含测试代码和测试数据，用于验证项目的功能和性能。
• test_data/：存储用于测试的数据。
• .gitignore：定义了 Git 忽略的文件和目录。
• .gitmodules：如果项目包含子模块，此文件用于配置子模块。
• .travis.yml：Travis CI 的配置文件，用于自动化测试和构建。
• LICENSE：项目的许可证信息。
• MANIFEST.in：指定打包时包含的文件。
• README.md：项目的说明文件，包含项目的基本信息和安装指南。
• bamboo_build.sh 和 bamboo_wheel.sh：构建和打包脚本，用于 CI/CD 流程。
• falcon.snake：使用 Snakemake 定义的组装流程。
• makefile：Makefile 文件，用于自动化构建过程。
• setup.cfg 和 setup.py：Python 包的配置和构建脚本。
• travis.sh：Travis CI 脚本，用于在 CI 环境中执行测试。

2. 项目的启动文件介绍

FALCON 的启动通常是通过命令行进行的。主要使用的启动文件是 falcon_kit 目录中的 Python 脚本。以下是一个简单的启动示例：

# 假设你已经安装了必要的依赖
# 运行 FALCON 组装流程
python -m falcon_kit.mains.run_falcon -t <thread_number> -x <extra_params> <input_data>

这里 <thread_number> 是你希望使用的线程数，<extra_params> 是额外的参数，<input_data> 是输入的数据文件。

3. 项目的配置文件介绍

FALCON 的配置主要是通过命令行参数进行的。但是，也可以使用配置文件来定义参数。配置文件通常是 JSON 格式，例如：

{
  "input_fofn": "input.fofn",
  "input_type": "consensus",
  "miniasm_options": ["-a", "1000", "-o", "1000", "-l", "5000"],
  // 其他配置项...
}

你可以在运行 FALCON 时通过 --config 参数指定配置文件的路径：

python -m falcon_kit.mains.run_falcon --config /path/to/config.json

确保配置文件中的路径和参数与你的数据和需求相匹配。