跳转到主要内容

rHEALPixDGGS离散全局网格系统(DGGS)的实现

项目描述

rHEALPixDGGS是一个Python包,实现了rHEALPix离散全局网格系统(DGGS)。

发行说明

这个包最初于2013年编写,自那时以来只有少量代码更新。

0.5.4 - 当前

代码与0.5.3相同,除更新到Python 3.11外

有关更改历史的详细信息,请参阅CHANGES.rst文件。

需求

安装

此包可在PyPI(Python包索引)上找到,您可以通过以下方式安装:

pip install rhealpixdggs

rHEALPixDGGS也可从GitHub仓库https://github.com/manaakiwhenua/rhealpixdggs-py下载,最新版本可以从那里克隆。

测试

“tests”目录中的文件测试了rHEALPixDGGS模块。这些文件是普通的unittest文件(包含在标准分发中的Python测试框架)。文档中的示例测试需要安装doctest模块(见requirements.dev.txt)。

此仓库包含两个UNIX外壳脚本,用于运行所有单元和文档测试

  • run_doctests.sh

  • run_unittests.sh

运行命令python tests/test_<foo>.py会执行一系列自动测试<foo>.py

例如,tests/test_distortion.py会自动测试distortion.py

如果您更新了模块,请更新其测试文件以测试所做的更改!

尽早测试,经常测试,自动测试!

主要包目录中有几个文件可以用来运行所有测试,从run_...开始。

文档

文档可以在以下位置找到

  • rHEALPix离散全局网格系统 - rHEALPix离散全局网格系统

  • docs/build/latex/rHEALPixDGGS.pdf - rHEALPixDGGS手册

  • docs/build/html/index.html - rHEALPixDGGS手册的HTML格式

后两个文档是从rhealpixdggs包模块的源代码自动生成的。要自己自动构建这些文档,请安装Python包Sphinx(但不要运行sphinx-quickstart,因为已经存在make文件Makefile和配置文件docs/source/conf.py),然后从docs目录运行命令make latexpdf以生成PDF文档或运行make html以生成HTML文档。对于PDF文档,您可能还需要安装LaTeX

sourcebuild目录分别包含所有Sphinx源文件和构建文件。

许可证

此代码根据GNU Lesser General Public License v3.0授权。有关许可证副本,请参阅文件LICENSE

联系

支持