rhealpixdggs

rHEALPixDGGS-py implements code to both define an rHEALPix DGGS Reference System and to perform topological queries on its Identfiers. Our roadmap is for v1.0 to be fully compliant with OGC Topic 21 v2.0 / ISO 19170-1:2020.

https://github.com/manaakiwhenua/rhealpixdggs-py

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary

Keywords

dggs gis reference-system

Last synced: 7 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: manaakiwhenua
License: lgpl-3.0
Language: Python
Default Branch: master
Homepage:
Size: 60.6 MB

Statistics

Stars: 21
Watchers: 8
Forks: 6
Open Issues: 5
Releases: 6

Topics

dggs gis reference-system

Created almost 6 years ago · Last pushed 8 months ago

Metadata Files

Readme Changelog License Citation

README.rst

************
rHEALPixDGGS
************

Introduction
============
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.12
^^^^^^
Fixes bug (off-by-one error) in `RHEALPixDGGS.rhp_to_center_child` function in the wrapper API.

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 ``_ 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_.py`` performs a sequence of automated tests of ``.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 licensed under the `GNU Lesser General Public License v3.0, `_. See the file ``LICENSE`` for a copy of the deed.

# 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 `_
| `lawr@landcareresearch.co.nz `_
|
| *Release Manager*:
| **Dr Nicholas J. Car**
| `SURROUND Australia Pty Ltd `_
| `nicholas.car@surroundaustralia.com `_
|
| *Original author*:
| **Alexander Raichev**
| ``_
| `alex@raichev.net `_
|
| *Former Maintainer*:
| **Robert Gibb**
| `Manaaki Whenua – Landcare Research `_
| `gibbr@landcareresearch.co.nz `_

Owner

Name: Manaaki Whenua – Landcare Research
Login: manaakiwhenua
Kind: organization

Website: https://www.landcareresearch.co.nz/
Repositories: 14
Profile: https://github.com/manaakiwhenua

Citation (CITATION.CFF)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Raichev"
    given-names: "Alex"
  - family-names: "Gibb"
    given-names: "Robert"
    orcid: "https://orcid.org/0000-0001-9032-7733"
  - family-names: "Car"
    given-names: "Nicholas"
    orcid: "https://orcid.org/0000-0002-8742-7730"
  - family-names: "De Maio"
    given-names: "Nicoletta"
  - family-names: "Gilić"
    given-names: "Frane"
    orcid: "https://orcid.org/0000-0003-4957-3400"
  - family-names: "Law"
    given-names: "Richard"
    orcid: "https://orcid.org/0000-0002-7400-2530"
title: "rHEALPixDGGS"
version: 0.5.12
date-released: 2025-08-15
url: "https://github.com/manaakiwhenua/rhealpixdggs-py"

GitHub Events

Total

Create event: 14
Release event: 5
Issues event: 7
Watch event: 3
Delete event: 6
Issue comment event: 26
Push event: 65
Pull request review event: 21
Pull request review comment event: 17
Pull request event: 18
Fork event: 1

Last Year

Create event: 14
Release event: 5
Issues event: 7
Watch event: 3
Delete event: 6
Issue comment event: 26
Push event: 65
Pull request review event: 21
Pull request review comment event: 17
Pull request event: 18
Fork event: 1

Committers

Last synced: about 2 years ago

All Time

Total Commits: 54
Total Committers: 5
Avg Commits per committer: 10.8
Development Distribution Score (DDS): 0.667

Past Year

Commits: 20
Committers: 2
Avg Commits per committer: 10.0
Development Distribution Score (DDS): 0.2

Top Committers

Name	Email	Commits
Nicholas Car	n**r@s**m	18
Nicoletta De Maio	d**n@l**z	16
Robert Gibb	g**r@l**z	15
alpha-beta-soup	r**w@g**m	4
Ben Jolly	b**y@g**m	1

Committer Domains (Top 20 + Academic)

landcareresearch.co.nz: 2 surroundaustralia.com: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time

Total issues: 16
Total pull requests: 18
Average time to close issues: almost 2 years
Average time to close pull requests: 11 days
Total issue authors: 8
Total pull request authors: 7
Average comments per issue: 2.38
Average comments per pull request: 1.72
Merged pull requests: 16
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 4
Pull requests: 13
Average time to close issues: 12 days
Average time to close pull requests: 8 days
Issue authors: 2
Pull request authors: 4
Average comments per issue: 0.5
Average comments per pull request: 1.77
Merged pull requests: 12
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

rggibb (4)
alpha-beta-soup (4)
aaime (4)
ndemaio (2)
araichev (1)
weiji14 (1)
ChocopieKewpie (1)
nicholascar (1)

Pull Request Authors

ndemaio (12)
alpha-beta-soup (5)
fgilic (5)
heaysa (4)
recalcitrantsupplant (1)
nicholascar (1)
rggibb (1)

Top Labels

Issue Labels

bug (6) enhancement (4) documentation (1)

Pull Request Labels

enhancement (4)

Packages

Total packages: 1
Total downloads:
- pypi 425 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 12
Total maintainers: 2

pypi.org: rhealpixdggs

An implementation of the rHEALPix discrete global grid system

Documentation: https://rhealpixdggs.readthedocs.io/
License: GPL-3.0-or-later
Latest release: 0.5.12
published 8 months ago

Versions: 12
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 425 Last month

Rankings

Dependent packages count: 10.1%

Stargazers count: 15.2%

Forks count: 15.3%

Average: 18.8%

Dependent repos count: 21.6%

Downloads: 31.8%

Maintainers (2)

ncar alpha-beta-soup

Last synced: 7 months ago

Dependencies

requirements.dev.txt pypi

black * development
doctest * development
pytest * development
twine * development
wheel * development

requirements.txt pypi

matplotlib >=1.2.1
numpy >=1.7
pyproj >=1.9.3
scipy >=0.12
shapely >=1.7.1

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

rhealpixdggs

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

Citation (CITATION.CFF)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: rhealpixdggs

Rankings

Maintainers (2)

Dependencies