BioPyTools

A Python toolkit for bioinformatics analysis and computational biology.

一个用于生物信息学分析和计算生物学的Python工具包。

JOSS submission materials: manuscript, references, and submission checklist.

简介 | Overview

BioPyTools 是一个专为生物信息学研究设计的Python工具包，提供了一系列常用的生物数据分析功能。

BioPyTools is a Python toolkit designed for bioinformatics research, providing a series of commonly used biological data analysis functions.

当前版本与更新历史见 CHANGELOG | See CHANGELOG for the current version and update history.

系统要求 | Requirements

• Python >= 3.10
• NumPy
• Pandas
• Matplotlib >= 3.5.0
• pyfastx >= 0.8.4
• scikit-learn >= 1.0.0
• seaborn >= 0.11.0
• click >= 8.0.0

环境配置 | Environment Setup

功能域 Conda 环境（超算团队用户|HPC team users）

自 2026-08 起，超算上的软件环境按功能域合并为 14 个：

align  pop  asm  hic  annot  repeat  rna
protein  phylo  pan  viz  misc  r  busco

快速开始|Quick start:

# 超算上创建全部 14 个域环境（已存在自动跳过）
bash scripts/build_domains.sh
# 或单个域
mamba env create -f envs/align.yml

旧环境导出备份（本地|local only, 不入库）

历史环境导出保存在本地 conda_envs_backup/（git 忽略），共 214 个旧环境的 yaml 快照，仅供回溯与故障排查。

普通用户 | General users

多数模块可通过 pip 安装与 PATH 中的工具直接使用，无需 conda 域环境。

安装方法 | Installation

从 PyPI 安装 | Install from PyPI

pip install biopytools

从源码安装 | Install from source

git clone https://github.com/lixiang117423/biopytools.git
cd biopytools
pip install -e .

# or
pip install .

使用方法 | Usage

查看帮助 | Getting Help

biopytools -h

查看所有可用命令 | List all commands:

biopytools

查看特定命令的帮助 | Help for specific command:

biopytools <命令>-h    # 例如: biopytools fastp -h

模块文档 | Module Documentation

BioPyTools 提供220+个模块（运行 biopytools 查看全部命令），按功能分为以下类别。

BioPyTools provides 220+ modules (run biopytools to list all commands), organized by functionality into the following categories.

数据下载与质控 | Data Download & QC

• ena_downloader - ENA数据下载工具（biopytools ena-downloader）
• ncbi_datasets - NCBI taxon基因组批量下载（biopytools ncbi-datasets）
• check_reads - FASTQ完整性检查（biopytools check-reads）
• fof - FOF文件生成工具（biopytools fof）
• fastp - FASTQ数据质量控制（biopytools fastp）
• fastq_gc_filter - FASTQ文件GC含量和序列长度过滤（biopytools fastq-gc-filter）
• fastq_stats - FASTQ文件统计工具（biopytools fq-stats）
• get_link_from_CNCB - 从CNCB批量获取测序数据下载链接（biopytools get-link-from-CNCB）
• iseq - 公共测序数据下载工具（biopytools iseq）
• pair_fastq - FASTQ配对修复工具（biopytools pair-fastq）
• sra2fastq - SRA转FASTQ转换工具（biopytools sra2fastq）
• wgsim - Wgsim基因组测序数据模拟（biopytools wgsim）

基因组组装 | Genome Assembly

• genomeasm - 三代基因组组装流程（biopytools genomeasm）
• get_plastome - 叶绿体基因组组装工具（biopytools get-plastome）
• hicanu - HiCanu基因组组装工具（biopytools hicanu）
• hifi_hic - 使用HiFi和Hi-C数据进行基因组组装（biopytools hifi-hic）
• hifi_hic_workflow - HiFi+Hi-C基因组组装与挂载完整流程（biopytools hifi-hic-workflow）
• hifiasm - 运行hifiasm基因组组装（biopytools hifiasm）
• mga - MGA共识基因组组装(HiFi)（biopytools mga）

组装评估与QC | Assembly QC

• assembly_qc - 基因组组装质量综合评估（biopytools assembly-qc）
• assembly_qv - 装配质量QV值计算（biopytools assembly-qv）
• assembly_stats - 基因组装配统计（biopytools assembly-stats）
• busco - BUSCO质量评估分析工具（biopytools busco）
• centier - CentIER着丝粒鉴定工具（biopytools centier）
• gap_stat - 基因组Gap统计工具（biopytools gap-stat）
• hic_qc - Hi-C数据质量评估工具（biopytools hic-qc）
• lai - LAI组装质量指数计算工具（biopytools lai）

Hi-C与挂载 | Hi-C & Scaffolding

• allhic - 使用ALLHiC进行染色体挂载（biopytools allhic）
• cphasing - CPhasing基因组分相和挂载工具（biopytools cphasing）
• find_telomere - 端粒识别分析工具（biopytools find-telomere）
• genome_mount_rate - 基因组挂载率统计（biopytools genome-mount-rate）
• haphic - HapHiC基因组scaffolding工具（biopytools haphic）
• hic_heatmap - Hi-C全基因组热图分析（biopytools hic-heatmap）
• subphaser - SubPhaser异源多倍体亚基因组分离（biopytools subphaser）
• telocomp - TeloComp端粒鉴定工具（biopytools telocomp）
• yahs - YaHS Hi-C scaffolding流程（biopytools yahs）
• subgenome_assign - 亚基因组归属(异源多倍体,亲本比对判定)（biopytools subgenome-assign）

基因组后处理与工具 | Polishing & Utilities

• agp2table - AGP转表格工具（biopytools agp2table）
• assembly2agp - Assembly文件转AGP格式工具（biopytools assembly2agp）
• chr_rename - 基于minimap2的染色体重命名工具（biopytools chr-rename）
• gap_fill - TGS-GapCloser Gap填充工具（biopytools gap-fill）
• genebank2fasta - GenBank序列提取工具（biopytools genebank2fasta）
• gffconverter - GFF文件整理工具（biopytools renamegff）
• gtf2gff - GTF到GFF文件转换工具（biopytools gtf2gff）
• promoter_extractor - 启动子提取工具（biopytools promoter-extractor）
• purge_dups - Purge_Dups基因组去冗余工具（biopytools purge-dups）
• ragtag - RagTag基因组scaffolding工具（biopytools ragtag）
• rename_chromosomes - 染色体重命名工具（biopytools rename-chromosomes）
• rename_genome_id - 基因组ID重命名工具（biopytools rename-genome-id）
• split_fasta_id - 分割FASTA文件ID（biopytools split-fasta-id）
• subseq - 序列子集提取工具（biopytools subseq）
• seq_extract - 序列提取(seqkit封装,自动识别ID/ID文件/BED)（biopytools seq-extract）

比对与BAM处理 | Alignment & BAM

• bam2fastq - BAM to FASTQ批量转换工具（biopytools bam2fastq）
• bam_cov - BAM覆盖度统计（biopytools bam-cov）
• bam_stats - BAM文件批量统计分析（biopytools bam-stats）
• bam_view - BAM比对可视化工具（biopytools bam-view）
• blast - BLAST序列比对分析（biopytools blast）
• bwa - 全基因组比对工具（biopytools bwa）
• bwa_gatk - 全基因组比对和变异检测（biopytools bwa-gatk）
• coverage - BAM覆盖度分析工具（biopytools coverage）
• coverage_filter - 基于覆盖度的序列质量过滤（biopytools coverage-filter）
• extract_reads - 基于contig-reads对应关系提取fastq reads（biopytools extract-reads）
• longestmrna - 提取最长转录本（biopytools longest-mrna）
• mafft_fasttree - 系统发育树构建工具（biopytools mafft-fasttree）
• minibwa - Minibwa短读长比对（标准/Hi-C/BS-seq/长读）（biopytools minibwa）
• minimap2 - Minimap2比对与区域提取（biopytools minimap2）
• msa - 多序列比对分析工具（biopytools msa）
• msaviz - MSA可视化工具（自动比对+可视化）（biopytools msaviz）
• parse_gene_dna - 基因DNA序列提取工具（biopytools parse-gene-dna）
• parse_seq - 核酸或蛋白序列提取工具（biopytools parse-seq）
• pep2genome - 蛋白质到基因组比对工具（biopytools pep2genome）
• samplot - Samplot结构变异可视化工具（biopytools samplot）
• seq2genome - 序列到基因组比对工具（支持DNA/蛋白质自动检测）（biopytools seq2genome）

变异检测与VCF | Variant & VCF

• annovar - ANNOVAR变异注释（biopytools annovar）
• fastq2vcf_gtx - Fastq到VCF (GTX) 全流程分析（biopytools fastq2vcf-gtx）
• fastq2vcf_parabricks - Fastq到VCF (Parabricks) 全流程分析（biopytools fastq2vcf-parabricks）
• filter_snp_indel - SNP和INDEL过滤工具（biopytools filter-snp-indel）
• gatk_joint - GATK Joint Genotyping工具（biopytools gatk-joint）
• geneinfo - 从GFF文件提取基因信息（biopytools geneinfo）
• gffcompare - GFF/GTF文件两两比较分析（biopytools gffcompare）
• gtx - 运行GTX WGS流程（biopytools gtx）
• gtx_joint - GTX Joint Calling命令生成工具（biopytools gtx-joint）
• hap_type - 单倍型可视化工具（biopytools hap-type）
• indelpav - INDEL PAV分析工具（biopytools indelpav）
• insert_detection - 插入序列位点检测（biopytools insert-detection）
• genome2sv - 组装间结构变异检测（biopytools genome2sv）
• parabricks - 基于GPU的全基因组流程（biopytools parabricks）
• swave - Swave结构变异检测工具（biopytools swave）
• vcf2gene - VCF变异基因注释工具（biopytools vcf2gene）
• vcf2genotype - VCF基因型提取（biopytools vcf2genotype）
• vcf2pav - VCF转PAV矩阵（biopytools vcf2pav）
• vcf_filter - VCF文件筛选（biopytools vcf-filter）
• vcf_merger - VCF按染色体合并工具（biopytools vcf-merger）
• vcf_renamer - VCF样品名称重命名工具（biopytools vcf-renamer）
• vcf_sample_hete - VCF样本基因型统计（biopytools vcf-sample-hete）
• vcf_sampler - VCF文件SNP抽样工具（biopytools vcf-sampler）
• vcf_sequence - 从基因组和VCF提取序列（biopytools vcf-sequence）
• vg - VG变异图分析工具（construct/index/giraffe/deconstruct）（biopytools vg）

泛基因组 | Pan-genome

• cactus - Cactus泛基因组构建和分析工具（biopytools cactus）
• minigraph - Minigraph泛基因组图构建和分析工具（biopytools minigraph）
• pan_blocks - 泛基因组Block构建工具（biopytools pan-blocks）
• pandepth - PanDepth覆盖度计算工具（biopytools pandepth）
• panman - Panman泛基因组构建和分析工具（biopytools panman）
• panvar - 泛基因组变异分析（biopytools panvar）
• pggb - PGGB泛基因组图构建工具（biopytools pggb）
• psvcp - PSVCP线性泛基因组构建（biopytools psvcp）

注释与功能预测 | Annotation

• braker - BRAKER3基因组注释工具（biopytools braker）
• braker4phyto - BRAKER3疫霉菌基因组注释（biopytools braker4phyto）
• anno_curate - GSA提交前注释校正（biopytools anno-curate）
• annorefine - BRAKER+查漏补漏端到端（biopytools annorefine）
• func_anno - 蛋白功能注释（biopytools func-anno）
• deeploc - DeepLoc 2.1蛋白质亚细胞定位预测工具（biopytools deeploc）
• egapx_batch - EGAPx批量运行配置生成工具（biopytools egapx-batch）
• eviann - EviAnn基因组注释工具（biopytools eviann）
• gff_renamer - GFF文件ID规范化工具（biopytools gff-renamer）
• hmmsearch - HMMsearch结果处理工具（biopytools hmmsearch）
• interproscan - InterProScan蛋白质功能注释（biopytools interproscan）
• meme_parser - MEME Motif发现和解析工具（biopytools meme-parser）
• nlr_annotator - NLR基因预测工具（biopytools nlr-annotator）
• signalp - SignalP 6.0信号肽预测工具（biopytools signalp）
• tmhmm - TMHMM跨膜螺旋预测（biopytools tmhmm）
• deeptmhmm - DeepTMHMM跨膜螺旋/信号肽预测（biopytools deeptmhmm）
• transcript_assembly - 转录本从头组装(HISAT2+StringTie)（biopytools transcript-assembly）
• oomycete_anno - 疫霉菌基因组注释(T2T Augustus流程)（biopytools oomycete-anno）
• eggnog_mapper - eggNOG功能注释(GO/KEGG/COG/CAZy/Pfam)（biopytools eggnog-mapper）
• phobius - Phobius跨膜拓扑+信号肽预测（biopytools phobius）

转座子与重复序列 | TE & Repeats

• edta - EDTA转座子注释（biopytools edta）
• hite - HiTE转座子检测与注释（biopytools hite）
• pathorepeat - 病原菌重复序列注释（biopytools pathorepeat）
• panedta - PanEDTA泛基因组转座子注释（biopytools panedta）
• panhite - panHiTE群体基因组TE分析（biopytools panhite）
• repeat_analyzer - 重复序列分析模块（biopytools repeat-analyzer）
• repeatmask - 重复序列屏蔽工具（biopytools repeatmask）

RNA-seq与转录组 | RNA-seq

• dual_rnaseq - 互作转录组分析（biopytools dual-rnaseq）
• gene_rnaseq_check - 候选基因RNA-seq转录验证（biopytools gene-rnaseq-check）
• longrnaseq - 三代转录组比对工具（biopytools longrnaseq）
• rna_iso - 全长转录本分析（biopytools rna-iso）
• rnabloom - RNA-Bloom转录组从头组装工具（biopytools rnabloom）
• rnaseq - RNA-seq表达定量流程（biopytools rnaseq）
• rnaseq2vcf - 转录组变异检测（biopytools rnaseq2vcf）
• rnaseq_val - 转录组验证注释（biopytools rnaseq-val）

共线性与比较基因组 | Synteny

• genomesyn - 基因组共线性分析（biopytools genomesyn）
• genomesyn2 - GenomeSyn2比较基因组学可视化工具（biopytools genomesyn2）
• jcvi - JCVI共线性分析工具集（biopytools jcvi）
• kaks - Ka/Ks计算（biopytools kaks）
• microsynteny - 微观共线性分析工具（biopytools microsynteny）
• ngenomesyn - NGenomeSyn可视化工具（biopytools ngenomesyn）
• orthofinder - OrthoFinder泛基因组分析工具包（biopytools orthofinder）
• plotsr - 多基因组共线性可视化工具（biopytools plotsr）
• wgdi - WGDI比较基因组学分析工具（biopytools wgdi）
• aliner - a-liner共线性可视化pipeline（FASTA→minimap2→图）（biopytools aliner）

系统发育 | Phylogenetics

• iqtree - IQ-TREE系统发育树分析工具（biopytools iqtree）
• reads2tree - FASTQ目录免组装构建物种树（biopytools reads2tree）
• genome2tree - 基因组目录免比对物种树（biopytools genome2tree）
• vcf2tree - VCF转系统发育树（biopytools vcf2tree）
• vcf2splitstree - VCF转SplitsTree6距离矩阵（biopytools vcf2splitstree）
• phy2fa - Phylip转FASTA（biopytools phy2fa）
• trimal - 多序列比对自动修剪（biopytools trimal）
• phylo_trim - 比对修剪前后树整合分析（biopytools phylo-trim）
• phylo_selector - 系统发育树样品选择工具（biopytools phylo-selector）
• raxml - RAxML系统发育树（biopytools raxml）
• vcf2nj - VCF构建NJ进化树（biopytools vcf2nj）
• vcf2phylip - VCF转phylip格式（biopytools vcf2phylip）
• raxml_ng - RAxML-NG系统发育树(最大似然,自适应模型+bootstrap)（biopytools raxml-ng）

群体遗传 | Population Genetics

• admixture - ADMIXTURE群体结构分析（biopytools admixture）
• dsuite - Dsuite D统计量分析工具（biopytools dsuite）
• fastani - 全基因组ANI计算（biopytools fastani）
• easyhap - 区域单倍型分析（biopytools easyhap）
• fst - Fst遗传分化计算工具（biopytools fst）
• pi - 核苷酸多样性计算工具（biopytools pi）
• pi4gene - 基因分组核苷酸多样性计算（biopytools pi4gene）
• pixy - Pixy群体遗传学统计工具（biopytools pixy）
• poplddecay - 连锁不平衡衰减分析工具（biopytools poplddecay）
• smudgescope - GenomeScope2+Smudgeplot基因组评估工具（biopytools smudgescope）
• treemix - TreeMix群体历史与基因流分析（biopytools treemix）
• vcf2pca - VCF主成分分析 (PCA)（biopytools vcf2pca）

GWAS与BSA | GWAS & BSA

• atomm - 双物种混合效应模型关联分析（biopytools atomm）
• cim - R/qtl复合区间作图(CIM)分析（biopytools cim）
• deepbsa - DeepBSA批量分析工具（biopytools deepbsa）
• gctb - GCTB全基因组复杂性状贝叶斯分析（biopytools gctb）
• gemma_gwas - GEMMA GWAS批量分析工具（biopytools gemma-gwas）
• gwas2gene - GWAS候选基因筛选工具（biopytools gwas2gene）
• gwas_gec - GWAS基因组范围多重检验校正（biopytools gwas-gec）
• gwas_lambda - GWAS Lambda GC计算工具（biopytools gwas-lambda）
• janusx - JanusX GWAS和基因组选择分析（biopytools janusx）
• ldblockshow - 连锁不平衡热图分析（biopytools ldblockshow）
• ocbsa - BSA分析工具套件（biopytools ocbsa）
• plinkgwas - PLINK GWAS分析（biopytools plink-gwas）
• rmvp - rMVP GWAS批量分析工具（GLM/MLM/FarmCPU）（biopytools rmvp）
• snp_index - SNP index计算和分析工具（biopytools snp-index）
• snp_region_gene - SNP区域基因提取工具（biopytools snp-region-gene）
• tassel_gwas - TASSEL GWAS分析工具（biopytools tassel-gwas）
• vcf2gwas - vcf2gwas GWAS分析工具（biopytools vcf2gwas）
• vcf2deepbsa - VCF转DeepBSA输入CSV（biopytools vcf2deepbsa）
• selective_sweep - 选择性扫荡检测（biopytools selective-sweep）
• xpclr - XP-CLR跨群体选择信号扫描（biopytools xpclr）
• mixrace - WGS混合小种检测（biopytools mixrace）

微生物组与k-mer | Microbiome & k-mer

• kmc - KMC k-mer统计和分析工具（biopytools kmc）
• kmeria - K-mer GWAS全流程分析工具（biopytools kmeria）
• kmertools - K-mer工具集 - 建库、查询和分析（biopytools kmertools）
• kraken2 - Kraken2宏基因组分类工具（biopytools kraken2）
• mcyc - 甲烷循环基因丰度分析工具（biopytools mcyc）
• ncbi_taxo - NCBI分类学注释工具（biopytools ncbi-taxo）
• picrust2 - PICRUSt2微生物群落功能丰度预测（biopytools picrust2）
• faprotaxtax - FAPROTAX微生物群落生态功能注释（biopytools faprotaxtax）
• qiime2 - QIIME2微生物组多样性分析(16S/ITS,ASV/OTU)（biopytools qiime2）

甲基化 | Methylation

• bismark - 全基因组甲基化分析（biopytools bismark）

效应子与抗病 | Effectors

• phyto_effector - Phytophthora效应子鉴定(rxlr/crn)（biopytools phyto-effector）
• resistify - Resistify NLR分析工具（biopytools resistify）
• predgpi - PredGPI GPI锚定蛋白预测（biopytools predgpi）
• rxlr_scanner - RxLR效应蛋白扫描工具（biopytools rxlr-scanner）
• indel_marker - 抗病/感病INDEL共显性标记开发（biopytools indel-marker）

其他工具 | Other Utilities

• primer3 - Primer3引物设计工具（biopytools primer3）
• protein_stats - Protein Stats理化性质分析工具（biopytools protein-stats）
• gene_density - 基因密度计算（每窗口基因数+基因/Mb）（biopytools gene-density）
• gene_table - 基因信息+序列合并表(基因DNA+CDS+蛋白)（biopytools gene-table）
• insert2locus - 转基因插入位点提取（biopytools insert2locus）
• needle_identity - 序列两两identity计算（biopytools needle-identity）
• seq_len - FASTA序列长度统计（biopytools seq-len）
• allelic_genes - 已废弃，迁移到 jcvi allelic（biopytools allelic-genes）

许可证 | License

本项目采用 MIT 许可证 - 详见 LICENSE 文件

This project is licensed under the MIT License - see the LICENSE file for details.

测试 | Testing

python -m pip install -e ".[dev,test]"
python -m pytest

External executables are mocked in the default test suite. End-to-end tests that invoke real bioinformatics software should run on a compute node.

引用 | Citation

Citation metadata are provided in CITATION.cff, with archive metadata in .zenodo.json. The JOSS manuscript is available at paper/paper.md. A version-specific archive DOI will be added after the JOSS release is accepted.

贡献 | Contributing

Contribution guidelines are in CONTRIBUTING.md. Please use the GitHub issue templates for bug reports and feature requests, and follow CODE_OF_CONDUCT.md in all project interactions.

支持 | Support

Usage questions, bug reports, and feature requests are handled through GitHub Issues. See SUPPORT.md for the information needed in a report.

作者信息 | Author

李详 (Xiang Li)

• Email: lixiang117423@gmail.com
• GitHub: @lixiang117423
• ORCID: 0000-0002-8400-7116
• Affiliation: Yazhouwan National Laboratory, Sanya, Hainan, China

致谢 | Acknowledgments

• 感谢所有为本项目做出贡献的开发者 | Thanks to all developers who contributed to this project
• 感谢开源社区的支持 | Thanks to the open source community for support
• AI 辅助开发 | AI-assisted development: Claude Code (Anthropic), GLM 5.2, and OpenAI Codex (GPT-5)

问题反馈 | Issues

如果遇到问题或有建议，请在GitHub上提交issue：

If you encounter problems or have suggestions, please submit an issue on GitHub:

https://github.com/lixiang117423/biopytools/issues