PICRUSt2 项目教程

1. 项目目录结构及介绍

PICRUSt2 项目的目录结构如下：

picrust2/
├── circleci/
├── picrust2/
├── scripts/
├── tests/
├── .gitignore
├── INSTALL.md
├── LICENSE
├── README.md
├── picrust2-env.yaml
├── pyproject.toml
└── setup.py

目录介绍：

• circleci/: 包含 CircleCI 配置文件，用于持续集成和持续部署。
• picrust2/: 包含 PICRUSt2 的核心代码。
• scripts/: 包含用于运行 PICRUSt2 的脚本。
• tests/: 包含项目的单元测试代码。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 跟踪。
• INSTALL.md: 安装指南，包含项目的安装步骤。
• LICENSE: 项目的开源许可证，PICRUSt2 使用 GPL-3.0 许可证。
• README.md: 项目的主文档，包含项目的概述、安装和使用说明。
• picrust2-env.yaml: Conda 环境配置文件，用于创建项目的运行环境。
• pyproject.toml: Python 项目配置文件，包含项目的依赖和构建配置。
• setup.py: Python 安装脚本，用于安装项目及其依赖。

2. 项目启动文件介绍

PICRUSt2 项目的启动文件主要是 setup.py 和 picrust2-env.yaml。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于安装项目及其依赖。通过运行以下命令可以安装 PICRUSt2：

python setup.py install

picrust2-env.yaml

picrust2-env.yaml 是 Conda 环境配置文件，用于创建项目的运行环境。通过以下命令可以创建并激活环境：

conda env create -f picrust2-env.yaml
conda activate picrust2-env

3. 项目配置文件介绍

PICRUSt2 项目的配置文件主要包括 pyproject.toml 和 picrust2-env.yaml。

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，包含项目的依赖和构建配置。以下是 pyproject.toml 的部分内容示例：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "picrust2"
version = "2.5.3"
description = "Phylogenetic Investigation of Communities by Reconstruction of Unobserved States"
authors = [
    { name="Gavin Douglas", email="[e-mail]" },
    { name="Robyn Wright", email="[e-mail]" },
    { name="Valentyn Bezshapkin", email="[e-mail]" }
]
dependencies = [
    "numpy",
    "scipy",
    "pandas",
    "biopython",
    "h5py"
]

picrust2-env.yaml

picrust2-env.yaml 是 Conda 环境配置文件，定义了项目运行所需的所有依赖包。以下是 picrust2-env.yaml 的部分内容示例：

name: picrust2-env
channels:
  - conda-forge
  - defaults
dependencies:
  - python=3.8
  - numpy
  - scipy
  - pandas
  - biopython
  - h5py
  - pip
  - pip:
    - picrust2

通过以上配置文件，用户可以轻松地安装和配置 PICRUSt2 项目，并开始使用其功能。