Scanpy 项目教程

Scanpy 项目教程

scanpy Single-cell analysis in Python. Scales to >1M cells. 项目地址: https://gitcode.com/gh_mirrors/sc/scanpy

1. 项目的目录结构及介绍

Scanpy 项目的目录结构如下：

scanpy/
├── benchmarks/
├── ci/
│   └── scripts/
├── docs/
├── notebooks/
├── src/
│   └── scanpy/
├── tests/
├── .azure-pipelines.yml
├── .codecov.yml
├── .editorconfig
├── .gitignore
├── .gitmodules
├── .pre-commit-config.yaml
├── .readthedocs.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── pyproject.toml

目录结构介绍

• benchmarks/: 包含性能测试相关的文件。
• ci/scripts/: 包含持续集成（CI）脚本。
• docs/: 包含项目的文档文件。
• notebooks/: 包含示例 Jupyter 笔记本。
• src/scanpy/: 包含 Scanpy 的核心代码。
• tests/: 包含测试代码。
• .azure-pipelines.yml: Azure Pipelines 配置文件。
• .codecov.yml: Codecov 配置文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• .pre-commit-config.yaml: pre-commit 钩子配置。
• .readthedocs.yml: Read the Docs 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• pyproject.toml: Python 项目配置文件。

2. 项目的启动文件介绍

Scanpy 项目的启动文件是 src/scanpy/__init__.py。这个文件是 Scanpy 包的入口点，负责初始化和导入 Scanpy 的核心功能。

启动文件介绍

• __init__.py: 这个文件初始化了 Scanpy 包，并导入了主要的模块和函数，使得用户可以通过 import scanpy as sc 来使用 Scanpy 的功能。

3. 项目的配置文件介绍

Scanpy 项目中有多个配置文件，用于不同的配置和集成。

配置文件介绍

• .azure-pipelines.yml: 配置 Azure Pipelines 的 CI/CD 流程。
• .codecov.yml: 配置 Codecov 代码覆盖率工具。
• .editorconfig: 配置编辑器设置，确保代码风格一致。
• .gitignore: 配置 Git 忽略的文件和目录。
• .gitmodules: 配置 Git 子模块。
• .pre-commit-config.yaml: 配置 pre-commit 钩子，用于代码格式化和检查。
• .readthedocs.yml: 配置 Read the Docs 文档构建。
• pyproject.toml: 配置 Python 项目，包括依赖管理、构建系统和工具配置。

这些配置文件确保了 Scanpy 项目的开发、测试、文档构建和持续集成流程的顺利进行。

scanpy Single-cell analysis in Python. Scales to >1M cells. 项目地址: https://gitcode.com/gh_mirrors/sc/scanpy