rHEALPixDGGS 0.5.14

An implementation of the rHEALPix discrete global grid system

rHEALPixDGGS is a Python package that implements the rHEALPix Discrete Global Grid System (DGGS).

Release Notes

This package was originally authored in 2013 and has had only minor code updates since then.

0.5.14

Added compact_cells to conversion: takes a single-resolution iterable of cell IDs and returns a fully compacted set, recursing until no further merges are possible. Added recursive keyword argument to compress_order_cells (default False) for the same behaviour with sorted-list output. Updated polyfill to use compact_cells when compress=True.

Refer to file CHANGES.rst for a more detailed history of changes.

Requirements

• requirements.txt - all the module requirements for operation

  • NumPy >=1.25.2,<2 Base N-dimensional array package

  • SciPy >=1.11.2 Fundamental library for scientific computing

  • Matplotlib >=3.7.2 Comprehensive 2D Plotting

  • Pyproj >=3.6.1 Python interface to the PROJ.4 cartographic library

  • Shapely >=2.0.1 Manipulation and analysis of planar GEOS geometries

• requirements.dev.txt - packages needed for developing this package

Installation

This package is available on PyPI, the Python Package Index from where it can be installed as follows:

pip install rhealpixdggs

rHEALPixDGGS is also available for download from the github repository https://github.com/manaakiwhenua/rhealpixdggs-py from where the latest version can be cloned.

You can install from source using Poetry in a virtual environment (MacOS and Linux, assuming Poetry is already installed on your system):

python3 -m venv rhealpixdggs
source rhealpixdggs/bin/activate
python install --upgrade pip
poetry install

Or on Windows:

python3 -m venv rhealpixdggs
rhealpixdggs\Scripts\activate
python install --upgrade pip
poetry install

For development:

::

poetry shell poetry install

Tests

The files in the tests directory test the rHEALPixDGGS modules. These files are plain unittest files (the Python testing framework contained within the standard distribution). Tests for examples in documents need the doctest module installed (see requirements.dev.txt).

Two UNIX shell scripts are included in this repository to run all unit and doc tests:

• run_doctests.sh

• run_unittests.sh

Running the command python tests/test_<foo>.py performs a sequence of automated tests of <foo>.py.

For example, tests/test_distortion.py automatically tests distortion.py.

If you update a module, then update its test file to test the changes you made!

Test early, test often, test automatically!

There are a couple of files in the main package directory that can be used to run all tests, starting run_....

Documentation

Documentation can be found at:

• The rHEALPix Discrete Global Grid System - The rHEALPix Discrete Global Grid System

• docs/build/latex/rHEALPixDGGS.pdf - The rHEALPixDGGS manual

• docs/build/html/index.html - The rHEALPixDGGS manual in HTML format

The latter two documents are generated automatically from the source code of the rhealpixdggs package modules. To automatically build these yourself, install the Python package Sphinx (but do not run sphinx-quickstart, because the make file Makefile and the configuration file docs/source/conf.py already exist) and then from the docs directory run the command make latexpdf to make the PDF documentation or make html to make the HTML documentation. For the PDF documentation, you might also need to install LaTeX.

The source and build directories contain all the Sphinx source and build files, respectively.

License

This code is dual-licensed. You may choose to use it under either:

• GNU Lesser General Public License v3.0 (see LICENSE-LGPL)

• MIT License (see LICENSE-MIT)

See the file LICENSE for more information about the dual licensing arrangement.

This dual licensing approach allows the software to be used in contexts where LGPL may not be permitted (such as certain corporate environments or standards bodies like the OGC) while still maintaining a copyleft option for those who prefer it.

# NB make a build/release makefile or script Releasing ——-

For PyPI:

::

# Build the distribution (.tar.gz and .whl) poetry build

# Upload to PyPI (test) poetry publish –repository testpypi

# Test install from testpypi pip install –index-url https://test.pypi.org/simple/ –extra-index-url https://pypi.org/simple rhealpixdggs

# Upload to PyPI poetry publish

A conda package rhealpixdggs is also maintained at [conda-forge](https://github.com/conda-forge/rhealpixdggs-feedstock).

Contact

Maintainer:

Richard Law

Manaaki Whenua – Landcare Research

[e-mail]

Release Manager:

Dr Nicholas J. Car

SURROUND Australia Pty Ltd

[e-mail]

Original author:

Alexander Raichev

https://raichev.net/

[e-mail]

Former Maintainer:

Robert Gibb

Manaaki Whenua – Landcare Research

[e-mail]