安装 (Installation)¶
系统要求 & 环境准备 (System Requirements) (点击展开)
1. 操作系统与系统架构¶
- 支持的操作系统: 原生 Linux（例如 Ubuntu >= 18.04, CentOS >= 7, Debian >= 10）。Windows 用户可以通过 WSL2 运行。macOS 用户可以通过 Docker 运行。
- 系统架构: 支持
linux-64和linux-aarch64。 - 基础系统库:
- Linux 内核版本
>= 3.10.0 - GNU C Library (glibc)
libc >= 2.17
- Linux 内核版本
2. 环境管理器（必需）¶
要安装 CPhasing，你需要准备好以下环境管理器之一:
- Pixi（推荐）: 极速、跨平台的包管理器。Pixi 会自动下载并隔离运行环境中的所有外部生物信息学工具和 Python 包。
- Conda / Miniconda: 支持作为传统管理环境的备选方案。
自动依赖解析
你不需要手动安装具体的第三方工具（如 minimap2、samtools、bedtools）或 Python 库。在通过 Pixi 或 Conda 进行安装时，所有这一切都预配置好并会自动被解析。
安装指南 (Installation Instructions)¶
下载预编译的 CPhasing 组件并使用 activate_cphasing 脚本激活环境：
下载预编译的 CPhasing 组件并使用 activate_cphasing 脚本激活环境。请选择与您系统架构对应的命令：
激活环境¶
解压完成后，运行以下命令激活部署：
退出环境¶
Note
第一次配置需要在有网络的情况下运行./CPhasing/bin/activate_cphasing.
Note
大陆用户由于网络问题可能没办法安装pixi这个软件，可以直接自行从github release快速下载通道下载：
例如：
mkdir -p ~/.pixi/bin
cd ~/.pixi/bin
wget https://gh.zwy.one/https://github.com/prefix-dev/pixi/releases/download/v0.60.0/pixi-x86_64-unknown-linux-musl.tar.gz
tar xzvf pixi-x86_64-unknown-linux-musl.tar.gz
之后再次运行activate_cphasing安装CPhasing依赖的包
Note
如果你的服务器不能访问anaconda的仓库，可以配置镜像源，如配置浙江大学的镜像源：
1. 打开配置文件
[mirrors]
"https://conda.anaconda.org/conda-forge" = [
"https://mirrors.zju.edu.cn/anaconda/cloud/conda-forge"
]
"https://conda.anaconda.org/bioconda" = [
"https://mirrors.zju.edu.cn/anaconda/cloud/bioconda"
]
ctrl + X，然后再按Y, 保存退出
Note
如果你想运行在arm(aarch64)平台上，请从github release页面下载，git仓库里默认存放x86-64版本
!!! tip "版本升级与环境迁移 (Upgrading & Environment Migration)" 如果您是从旧版本的 CPhasing 进行版本升级，可以使用内置的自动迁移工具来安全、迅速地复用之前已下载的本地包缓存。这能够避免重新下载数 GB 的依赖软件，并在无需联网的情况下在本地实现秒级快速重构与对齐。
请在您的**新版本** CPhasing 目录下执行以下迁移指令：
```bash
# 用法: bash bin/migrate_cphasing_env <旧版本 CPhasing 目录路径>
bash bin/migrate_cphasing_env /path/to/old/CPhasing
```
迁移程序会为您自动对齐可能更新的依赖包。处理完成后，您可以直接像往常一样在终端中运行 `source bin/activate_cphasing` 激活并开始使用新环境。 !!! tip "版本升级与环境迁移 (Upgrading & Environment Migration)"
如果您是从旧版本的 CPhasing 进行版本升级，可以使用内置的自动迁移工具来安全、迅速地复用之前已下载的本地包缓存。这能够避免重新下载数 GB 的依赖软件，并在无需联网的情况下在本地实现秒级快速重构与对齐。
请在您的**新版本** CPhasing 目录下执行以下迁移指令：
```bash
# 用法: bash bin/migrate_cphasing_env <旧版本 CPhasing 目录路径>
bash bin/migrate_cphasing_env /path/to/old/CPhasing
```
迁移程序会为您自动对齐可能更新的依赖包。处理完成后，您可以直接像往常一样在终端中运行 `source bin/activate_cphasing` 激活并开始使用新环境。
从 GitHub 仓库下载 C-Phasing 代码，并使用 Anaconda 或 Miniconda 导入环境依赖：
git clone https://github.com/wangyibin/CPhasing.git
cd CPhasing
conda env create -f environment.yml
conda activate cphasing
.bash_profile或者.bashrc
如果你希望手动管理环境和路径，可以通过 pip 直接从源码构建：
## Download C-Phasing and install python dependencies
git clone https://github.com/wangyibin/CPhasing.git
cd CPhasing
pip install .
~/.bash_profile 或者~/.bashrc
第三方依赖包¶
软件具体依赖包明细列表 (Detailed Software & Library Dependencies)¶
软件具体依赖包明细列表 (Detailed Software & Library Dependencies) (点击展开)
CPhasing 会自动解析并配置好全部底层依赖。以下是其所需的完整外置软件与程序包清单列表：
1. 核心生物信息学工具¶
# 序列比对与三维基因组构建
minimap2 >= 2.28, < 3
chromap >= 0.3.2, < 0.4
bwa-mem2 >= 2.3, < 3
minibwa >= 0.1, < 0.4
minigraph >= 0.21, < 0.22
wfmash 0.17.0.*
# 序列处理与文件操作
samtools >= 1.20, < 1.21
bedtools >= 2.31.1, < 3
seqkit >= 2.9.0, < 3
samblaster >= 0.1.26, < 0.2
pigz >= 2.8, < 3
crabz >= 0.10.0, < 0.11
2. Python 运行时与核心库¶
# Python 运行时
python 3.12.0.*
# 生物信息分析相关库
biopython >= 1.84, < 2
pysam >= 0.22.1, < 0.23
cooler >= 0.10.2, < 0.11
hicmatrix >= 17.2, < 18
pyranges >= 0.1.2, < 0.2
ncls >= 0.0.68, < 0.0.69
needletail >= 0.7.1, < 0.8
# 数据处理与计算性能
pandas >= 2.2.3, < 3
numpy >= 1.26.4, < 2
polars >= 1.17.1, < 1.18.0
pyarrow >= 18.1.0, < 19
dask >= 2024.11.2, < 2025
joblib >= 1.4.2, < 2
pandarallel >= 1.6.5, < 2
scikit-learn >= 1.5.2, < 2
sparse_dot_mkl >= 0.9.10, < 0.10 (仅限 linux-64 平台)
# 图论与网络分析
networkx >= 3.4.2, < 3.5
python-igraph >= 0.11.8, < 0.12
cdlib >= 0.4.0, < 0.5
graph-tool >= 2.97, < 3
# 数据可视化
matplotlib >= 3.9.3, < 4
seaborn >= 0.13.2, < 0.14
plotly >= 6.2.0, < 7
plotnine >= 0.15.3, < 0.16
patchworklib >= 0.6.3, < 0.7
colormaps >= 0.4.2, < 0.5
3. 特定分析流程与可选依赖¶
验证安装与运行示例 (Verifying Installation)¶
为了验证 CPhasing 及其所需的所有外部三方软件是否正确配置，我们提供了一套预包装的轻量化示例数据集和一键式自动测试脚本。详情亦可参阅完整的 examples/README.md 说明文档。
第一步：下载测试数据集 (Example Dataset)¶
导航到 CPhasing 的 examples（示例代码）目录，进行下载和解压：
下载示例数据：
# 下载轻量玩具测试数据集
wget https://github.com/wangyibin/CPhasing/releases/download/v0.3.2/example_data.tar.gz
# 提取并解压（这会自动生成 data/ 文件夹）
tar -xzvf example_data.tar.gz
第二步：激活 CPhasing 环境¶
在使用测试组件之前，确保你的应用隔离环境已被正确激活：
- 如果是 Pixi 一键激活（推荐手法）:
- 如果是 Conda 环境:
第三步：一键运行示例脚本¶
在 examples/ 目录下执行自动验证脚本：
预期结果与运行耗时¶
脚本会将 Pore-C pipeline 和 Hi-C pipeline 流程全部运行并验证完毕：
- Pore-C 输出文件夹:
examples/cphasing_output_porec/ - Hi-C 输出文件夹:
examples/cphasing_output_hic/ - 预期总运行时间: 在主流 8 核处理器工作站上耗时约 5 分钟。
在无报错的情况下干净利落地运行完毕，代表您的 CPhasing 状态已被完全正确部署，即可放心用于您大型的真实基因组数据集上。