Pingouin 项目教程

1. 项目目录结构及介绍

Pingouin 项目的目录结构如下：

pingouin/
├── docs/
├── notebooks/
├── src/
│   └── pingouin/
├── tests/
├── .gitattributes
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── MANIFEST.in
├── README.rst
├── pyproject.toml

目录介绍：

• docs/：包含项目的文档文件，通常是 Markdown 或 reStructuredText 格式的文件。
• notebooks/：包含 Jupyter Notebook 文件，用于展示 Pingouin 的主要功能和示例。
• src/pingouin/：项目的源代码目录，包含 Pingouin 的主要功能实现。
• tests/：包含项目的测试文件，用于确保代码的正确性和稳定性。
• .gitattributes：Git 属性文件，用于指定文件的特定行为。
• .gitignore：Git 忽略文件，用于指定不需要跟踪的文件和目录。
• CODE_OF_CONDUCT.md：项目的行为准则，规定了参与者的行为规范。
• LICENSE：项目的开源许可证文件，Pingouin 使用 GPL-3.0 许可证。
• MANIFEST.in：用于指定在打包项目时需要包含的文件。
• README.rst：项目的介绍文件，通常包含项目的概述、安装说明和使用指南。
• pyproject.toml：Python 项目的配置文件，用于指定项目的构建系统和依赖。

2. 项目的启动文件介绍

Pingouin 项目没有明确的“启动文件”，因为它是一个 Python 库，而不是一个独立的应用程序。用户可以通过导入 pingouin 模块来使用其功能。例如：

import pingouin as pg

# 使用 Pingouin 进行 T 检验
pg.ttest(x, y)

3. 项目的配置文件介绍

Pingouin 项目的主要配置文件是 pyproject.toml，它用于指定项目的构建系统和依赖。以下是一个简化的 pyproject.toml 示例：

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

[project]
name = "pingouin"
version = "0.5.5"
description = "Statistical package in Python based on Pandas"
authors = [
    { name="Raphael Vallat", email="[e-mail]" }
]
dependencies = [
    "numpy",
    "scipy",
    "pandas",
    "pandas-flavor",
    "statsmodels",
    "matplotlib",
    "seaborn",
    "scikit-learn",
    "mpmath"
]

配置文件介绍：

• [build-system]：指定构建系统的要求和后端。
• [project]：包含项目的基本信息，如名称、版本、描述、作者和依赖项。

通过这些配置文件，用户可以了解项目的依赖关系和构建方式，从而更好地进行安装和使用。