Home
欢迎来到 FastQTools 开发 Wiki！本 Wiki 为项目的核心技术文档中心，涵盖架构设计、API 参考、构建部署、质量工程等内容。
在线文档站: https://lessup.github.io/fastq-tools/
源代码仓库: https://github.com/LessUp/fastq-tools
FastQTools 是一个面向 FASTQ 文件 的现代 C++ 高性能处理工具集，专注于生物信息学场景中的质控、过滤和统计分析。
| 模块 | 命令 | 说明 |
|---|---|---|
| 统计分析 | stat |
Per-base/per-read 质量统计、GC 含量、碱基组成、长度分布 |
| 过滤清洗 | filter |
质量阈值、长度范围、N-ratio 过滤；质量/长度/接头修剪 |
| 高性能 I/O | — | 基于 TBB 并行流水线、零拷贝批量处理、gzip/libdeflate 压缩 |
| 领域 | 技术 |
|---|---|
| 语言 | C++23 (GCC 15 / Clang 21) |
| 构建 | CMake 3.28+, Ninja |
| 依赖管理 | Conan 2.x |
| 并发 | Intel oneTBB (tbb::parallel_pipeline) |
| 压缩 | zlib-ng, libdeflate |
| CLI | cxxopts 3.1.1 |
| 日志 | spdlog 1.17.0 + fmt 12.1.0 |
| 测试 | Google Test 1.14.0, Google Benchmark |
| JSON | nlohmann_json 3.11.3 |
| 操作 | 吞吐量 | 耗时 |
|---|---|---|
| FastQReader Medium | 1696.50 MB/s | 18.8 ms |
| FastQWriter Medium | 1.76 M reads/s | 57.0 ms |
| Filter Combined (100K) | 1.67 M reads/s | 60.5 ms |
| Stat Full (100K) | 301.91 MB/s | 104.6 ms |
- Getting Started — 环境搭建、依赖安装、第一个命令
-
CLI Reference —
stat/filter命令完整用法
- Architecture — 分层架构、并发模型、CMake 模块拆分
- API Reference — C++ 公共 API（IO / Processing / Statistics / Core）
- Build and CI — 构建系统、Conan 依赖、CMake 选项、CI 流程
- DevContainer and Docker — 开发容器、生产镜像、部署方案
- Testing Strategy — 单元/集成/E2E 测试策略与运行
- Code Quality Tools — Sanitizers / Valgrind / clang-tidy / Fuzzing
- Performance Benchmarks — 基准测试系统、回归检测、调优指南
- FASTQ Format Notes — FASTQ 格式规范、边界情况、异常处理
- Coding Standards — 命名约定、代码组织、现代 C++ 实践
- Contributing Guide — Git 提交规范、开发流程、PR 模板
# 一键构建
./scripts/core/build
# 运行测试
./scripts/core/test
# 代码格式化
./scripts/core/lint format
# 统计分析
FastQTools stat -i reads.fq.gz -o stats.txt -t 8
# 质量过滤 + 修剪
FastQTools filter -i reads.fq.gz -o clean.fq.gz \
--min-quality 20 --min-length 50 --max-n-ratio 0.1 \
--trim-quality 20 --trim-mode both