ShadowFinder 项目教程

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

ShadowFinder 项目的目录结构如下：

ShadowFinder/
├── .github/
│   └── workflows/
├── src/
│   └── shadowfinder/
├── tests/
├── .gitignore
├── pre-commit-config.yaml
├── LICENSE
├── README.md
├── ShadowFinderColab.ipynb
├── poetry.lock
├── pyproject.toml
├── timezone_grid.json
└── tox.ini

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• src/shadowfinder/: 项目的源代码目录，包含主要的 Python 代码。
• tests/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• ShadowFinderColab.ipynb: Google Colab 笔记本文件，用于在云端运行项目。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。
• timezone_grid.json: 时区网格数据文件。
• tox.ini: Tox 配置文件，用于多版本测试。

2. 项目的启动文件介绍

ShadowFinder 项目的主要启动文件是 ShadowFinderColab.ipynb，这是一个 Google Colab 笔记本文件。用户可以通过 Google Colab 直接运行这个笔记本，无需本地安装。

启动步骤

1. 打开 Google Colab: Google Colab
2. 上传 ShadowFinderColab.ipynb 文件到 Colab。
3. 按照笔记本中的说明运行代码。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 Poetry 项目的配置文件，包含项目的依赖、脚本等信息。

[tool.poetry]
name = "shadowfinder"
version = "0.1.0"
description = "A lightweight tool and Google Colab notebook for estimating the points on the Earth's surface where a shadow of a particular length could occur, for geolocation purposes."
authors = ["Your Name <[e-mail]>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.7"
numpy = "^1.19.4"
matplotlib = "^3.3.3"

[tool.poetry.dev-dependencies]
pytest = "^6.2.1"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

timezone_grid.json

timezone_grid.json 是时区网格数据文件，用于在计算阴影位置时提供时区信息。

tox.ini

tox.ini 是 Tox 配置文件，用于多版本测试。

[tox]
envlist = py37, py38, py39

[testenv]
deps =
    pytest
commands =
    pytest

通过这些配置文件，用户可以了解项目的依赖关系、测试配置以及时区数据的存储方式。