Scanpy 开源项目教程
scanpy项目地址:https://gitcode.com/gh_mirrors/sca/scanpy
1. 项目的目录结构及介绍
Scanpy 项目的目录结构如下:
scanpy/
├── .github/
├── docs/
├── scanpy/
│ ├── _settings.py
│ ├── _compat.py
│ ├── _utils.py
│ ├── __init__.py
│ ├── api/
│ ├── datasets/
│ ├── external/
│ ├── logging.py
│ ├── plotting/
│ ├── preprocessing/
│ ├── tools/
│ ├── utils.py
│ └── readwrite.py
├── tests/
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── setup.cfg
├── setup.py
└── requirements.txt
目录结构介绍
.github/
: 包含 GitHub 相关的配置文件,如 issue 模板和 pull request 模板。docs/
: 包含项目的文档文件,通常是 Markdown 格式。scanpy/
: 核心代码目录,包含项目的所有源代码文件。_settings.py
: 配置文件,用于设置项目的全局参数。_compat.py
: 兼容性文件,处理不同 Python 版本之间的兼容性问题。_utils.py
: 工具函数文件,包含一些通用的辅助函数。__init__.py
: 包初始化文件,使目录成为一个 Python 包。api/
: API 接口目录,包含项目的 API 相关文件。datasets/
: 数据集目录,包含一些示例数据集。external/
: 外部工具目录,包含一些外部工具和插件。logging.py
: 日志记录文件,用于记录项目的运行日志。plotting/
: 绘图工具目录,包含一些绘图相关的函数和类。preprocessing/
: 预处理工具目录,包含一些数据预处理函数。tools/
: 工具目录,包含一些高级分析工具。utils.py
: 工具函数文件,包含一些通用的辅助函数。readwrite.py
: 读写工具文件,包含一些数据读写函数。
tests/
: 测试目录,包含项目的单元测试和集成测试文件。.gitignore
: Git 忽略文件,指定 Git 忽略的文件和目录。LICENSE
: 许可证文件,指定项目的开源许可证。MANIFEST.in
: 清单文件,指定打包时包含的文件。README.md
: 项目说明文件,包含项目的介绍和使用说明。setup.cfg
: 安装配置文件,包含项目的安装配置信息。setup.py
: 安装脚本文件,用于安装项目。requirements.txt
: 依赖文件,列出项目依赖的第三方库。
2. 项目的启动文件介绍
Scanpy 项目的启动文件是 scanpy/__init__.py
。这个文件是 Scanpy 包的入口点,负责初始化包并导入必要的模块和函数。
# scanpy/__init__.py
from ._settings import settings, Verbosity # 导入配置和日志级别
from . import datasets # 导入数据集模块
from . import external # 导入外部工具模块
from . import logging # 导入日志模块
from . import plotting # 导入绘图模块
from . import preprocessing # 导入预处理模块
from . import tools # 导入工具模块
from . import utils # 导入工具函数模块
from . import readwrite # 导入读写工具模块
# 设置版本号
__version__ = '1.9.1'
# 设置包的名称
__author__ = ', '.join([
'Alex Wolf',
'Philipp Angerer',
'Fidel Ramirez',
'Isaac Virshup',
'Sergei Rybakov',
'Gokcen Eraslan',
'Tom White',
'Malte Luecken',
'Davide Cittaro',
'Tobias Callies',
'Marius Lange',
'Andrés R. Muñoz-Rojas',
])
# 设置包的描述
__email__ = 'alex.wolf@helmholtz-muenchen.de'
__description__ = 'Single-