Hyppo 项目启动与配置教程

1. 项目目录结构及介绍

Hyppo 是一个用于统计比较两个数据集之间相关性的库。以下是项目的目录结构及其简要介绍：

hyppo/
├── .gitignore       # Git 忽略文件
├── .travis.yml      # Travis CI 配置文件
├── contributing.md  # 贡献指南
├── docs/            # 文档目录
│   ├── ...
│   └── ...
├── examples/        # 示例代码目录
│   ├── ...
│   └── ...
├── hyppo/           # Hyppo 库的源代码目录
│   ├── __init__.py  # 初始化文件
│   ├── ...
│   └── ...
├── MANIFEST.in      # 打包文件列表
├── README.md        # 项目说明文件
├── requirements.txt # 项目依赖列表
├── setup.cfg        # 设置配置文件
├── setup.py         # 设置脚本
└── tests/           # 测试代码目录
    ├── ...
    └── ...

• .gitignore：指定 Git 忽略跟踪的文件和目录。
• .travis.yml：用于配置 Travis CI 进行自动测试和部署。
• contributing.md：提供贡献指南，指导他人如何为项目做贡献。
• docs/：存放项目的文档。
• examples/：包含一些使用 Hyppo 的示例代码。
• hyppo/：项目的核心代码库，包括模块和包。
• MANIFEST.in：指定打包时需要包含的文件和目录。
• README.md：项目的主说明文件，包含项目介绍和安装指南。
• requirements.txt：列出项目运行所需的外部依赖。
• setup.cfg：包含项目的配置信息。
• setup.py：用于构建、打包和安装项目的 Python 脚本。
• tests/：包含用于测试项目代码的测试用例。

2. 项目的启动文件介绍

项目的启动文件通常是 setup.py。此文件用于构建、打包和安装 Hyppo。以下是 setup.py 的主要内容：

from setuptools import setup, find_packages

setup(
    name='hyppo',
    version='0.0.1',
    packages=find_packages(),
    install_requires=[
        'numpy', 'scipy', 'pandas', 'matplotlib', 'seaborn'
    ],
    # 其他配置...
)

通过运行以下命令，可以安装 Hyppo：

pip install .

或者，如果您希望从源代码安装，可以使用：

python setup.py install

3. 项目的配置文件介绍

项目的配置文件通常包括 setup.cfg，此文件提供了项目的基本配置信息。以下是 setup.cfg 的示例内容：

[metadata]
name = hyppo
version = 0.0.1
author = NeuroData
author_email = [e-mail]
license = MIT
url = https://github.com/neurodata/hyppo
description = A Python library for hypothesis testing on distances
long_description = file: README.md
long_description_content_type = text/markdown

[options]
packages = find:
install_requires =
    numpy
    scipy
    pandas
    matplotlib
    seaborn

这个配置文件定义了项目的元数据和依赖关系，使得安装和使用 Hyppo 时更加方便。在安装过程中，setup.py 会读取 setup.cfg 中的配置信息。