MGWR 项目教程

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

mgwr/
├── ci/
│   └── github/workflows/
├── doc/
├── mgwr/
├── notebooks/
├── tools/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── codecov.yml
├── readthedocs.yml
├── requirements.txt
├── requirements_docs.txt
├── requirements_tests.txt
├── setup.cfg
└── setup.py

目录结构介绍

• ci/: 包含持续集成相关的配置文件，如 GitHub Actions 的工作流配置。
• doc/: 存放项目的文档文件。
• mgwr/: 项目的主要代码目录，包含 MGWR 模型的实现。
• notebooks/: 存放 Jupyter Notebook 文件，用于演示和测试 MGWR 模型。
• tools/: 存放项目使用的工具脚本。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 用于打包项目的配置文件。
• README.md: 项目介绍和使用说明。
• codecov.yml: Codecov 配置文件，用于代码覆盖率报告。
• readthedocs.yml: Read the Docs 配置文件，用于文档构建。
• requirements.txt: 项目依赖的 Python 包列表。
• requirements_docs.txt: 文档构建所需的 Python 包列表。
• requirements_tests.txt: 测试所需的 Python 包列表。
• setup.cfg: 项目安装配置文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 setup.py，它是一个标准的 Python 安装脚本。通过运行 python setup.py install，可以安装 MGWR 项目及其依赖项。

setup.py 文件内容概述

from setuptools import setup, find_packages

setup(
    name='mgwr',
    version='2.2.1',
    packages=find_packages(),
    install_requires=[
        # 依赖项列表
    ],
    # 其他配置项
)

启动步骤

1. 克隆项目仓库：

   git clone https://github.com/pysal/mgwr.git
   

2. 进入项目目录：

   cd mgwr
   

3. 安装项目及其依赖项：

   python setup.py install
   

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是一个配置文件，用于定义项目的安装选项和其他配置。以下是 setup.cfg 的部分内容：

[metadata]
name = mgwr
version = 2.2.1
description = Multiscale Geographically Weighted Regression (MGWR)
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/pysal/mgwr
author = Taylor Oshan, Ziqi Li, Wei Kang, Levi Wolf, and A. Stewart Fotheringham
license = BSD-3-Clause

[options]
packages = find:
install_requires =
    numpy
    scipy
    pandas
    # 其他依赖项

requirements.txt

requirements.txt 文件列出了项目运行所需的 Python 包及其版本。以下是部分内容：

numpy
scipy
pandas
# 其他依赖项

readthedocs.yml

readthedocs.yml 是用于配置 Read the Docs 文档构建的文件。以下是部分内容：

version: 2

sphinx:
  configuration: doc/conf.py

python:
  version: 3.8
  install:
    - requirements: requirements_docs.txt

通过这些配置文件，可以确保项目在不同环境下的正确安装和文档构建。