PySAL Segregation 项目启动与配置教程

1. 项目目录结构及介绍

PySAL Segregation 是一个用于分析和测量城市隔离模式的工具包。以下是项目的目录结构及各部分的简要介绍：

pysal/segregation/
├── .devcontainer/              # 开发环境配置文件
├── .github/                    # GitHub 工作流和自动化脚本
├── ci/                         # 持续集成配置文件
├── docs/                       # 文档资源
├── figs/                       # 项目中使用的图表和图形
├── notebooks/                  # Jupyter 笔记本，用于代码演示和教学
├── segregation/                # 核心代码模块
├── tools/                      # 辅助工具和脚本
├── .gitattributes              # Git 属性配置
├── .gitignore                  # Git 忽略文件配置
├── LICENSE.txt                 # 项目许可证文件
├── README.md                   # 项目说明文件
├── environment.yml             # Conda 环境配置文件
├── pyproject.toml              # 项目构建和打包配置文件

• .devcontainer/: 包含开发环境配置，用于集成开发环境（如 VS Code）。
• .github/: 包含 GitHub Actions 工作流文件，用于自动化项目的构建、测试和发布等流程。
• ci/: 包含持续集成相关的配置文件和脚本。
• docs/: 包含项目文档资源，如 Sphinx 文档源文件。
• figs/: 包含项目文档和演示中使用的图表和图形。
• notebooks/: 包含 Jupyter 笔记本文件，用于代码演示和教学。
• segregation/: 包含项目的核心代码，包括隔离度测量、统计推断和解构分析等。
• tools/: 包含辅助工具和脚本，用于项目开发和测试。
• .gitattributes: 配置 Git 属性，如代码换行符等。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE.txt: 项目使用的许可证信息。
• README.md: 项目说明文件，包含项目介绍、安装和使用说明等。
• environment.yml: Conda 环境配置文件，用于创建和管理项目依赖的环境。
• pyproject.toml: 项目构建和打包配置文件，用于指定项目构建系统和依赖。

2. 项目的启动文件介绍

项目的启动文件主要是 pyproject.toml 和 setup.py，它们用于配置和管理项目环境和依赖。

• pyproject.toml: 包含项目的基本信息和构建系统配置。例如，它定义了项目的名称、版本、作者、依赖项等。
• setup.py: 用于项目的安装和打包。它定义了项目的包信息、依赖项和其他安装脚本。

要启动项目，你需要首先创建一个虚拟环境并安装项目依赖：

conda create -f environment.yml
conda activate segregation
python setup.py develop

这将创建一个名为 segregation 的虚拟环境，安装所有必要的依赖，并将项目开发版本安装到环境中。

3. 项目的配置文件介绍

项目的配置文件包括 environment.yml 和 pyproject.toml，它们用于配置和管理项目的开发环境。

• environment.yml: Conda 环境配置文件，用于指定项目所需的 Python 版本和依赖项。通过运行 conda env create -f environment.yml 命令，你可以创建一个包含所有依赖项的独立环境。

• pyproject.toml: 项目构建和打包配置文件，用于指定项目的构建系统和依赖。它包含了项目的基本信息，如名称、版本和作者，以及项目的依赖关系。

这些配置文件确保项目的开发环境一致，并且可以轻松地部署到不同的机器上。