************
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 <https://www.numpy.org/>`_ Base N-dimensional array package
- `SciPy >=1.11.2 <https://www.scipy.org/>`_ Fundamental library for scientific computing
- `Matplotlib >=3.7.2 <https://matplotlib.org/>`_ Comprehensive 2D Plotting
- `Pyproj >=3.6.1 <https://code.google.com/p/pyproj/>`_ Python interface to the PROJ.4 cartographic library
- `Shapely >=2.0.1 <https://shapely.readthedocs.io/>`_ 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 <https://datastore.landcareresearch.co.nz/dataset/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 <http://sphinx-doc.org/>`_ (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 <http://www.latex-project.org/>`_.
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, <http://www.gnu.org/licenses/lgpl-3.0.html>`_. 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 <https://www.landcareresearch.co.nz/>`_
| `lawr@landcareresearch.co.nz <mailto:lawr@landcareresearch.co.nz>`_
|
| *Release Manager*:
| **Dr Nicholas J. Car**
| `SURROUND Australia Pty Ltd <https://surround.com>`_
| `nicholas.car@surroundaustralia.com <mailto:nicholas.car@surroundaustralia.com>`_
|
| *Original author*:
| **Alexander Raichev**
| `<https://raichev.net/>`_
| `alex@raichev.net <mailto:alex@raichev.net>`_
|
| *Former Maintainer*:
| **Robert Gibb**
| `Manaaki Whenua – Landcare Research <https://www.landcareresearch.co.nz/>`_
| `gibbr@landcareresearch.co.nz <mailto:gibbr@landcareresearch.co.nz>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "rHEALPixDGGS",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "DGGS, Discrete Global Grid System, reference system, spatial, geospatial",
"author": "Alexander Raichev",
"author_email": "alex@raichev.net",
"download_url": "https://files.pythonhosted.org/packages/ec/1e/3fa5e50e2f2a4a98d68cd58424ca961dda88acceb4525746952aa0f5f5d8/rhealpixdggs-0.5.12.tar.gz",
"platform": null,
"description": "************\nrHEALPixDGGS\n************\n\nIntroduction\n============\nrHEALPixDGGS is a Python package that implements the rHEALPix Discrete Global Grid System (DGGS).\n\nRelease Notes\n-------------\nThis package was originally authored in 2013 and has had only minor code updates since then.\n\n0.5.12\n^^^^^^\nFixes bug (off-by-one error) in `RHEALPixDGGS.rhp_to_center_child` function in the wrapper API.\n\nRefer to file CHANGES.rst for a more detailed history of changes.\n\nRequirements \n-------------\n* ``requirements.txt`` - all the module requirements for operation\n - `NumPy >=1.25.2,<2 <https://www.numpy.org/>`_ Base N-dimensional array package\n - `SciPy >=1.11.2 <https://www.scipy.org/>`_ Fundamental library for scientific computing\n - `Matplotlib >=3.7.2 <https://matplotlib.org/>`_ Comprehensive 2D Plotting\n - `Pyproj >=3.6.1 <https://code.google.com/p/pyproj/>`_ Python interface to the PROJ.4 cartographic library\n - `Shapely >=2.0.1 <https://shapely.readthedocs.io/>`_ Manipulation and analysis of planar GEOS geometries\n* ``requirements.dev.txt`` - packages needed for developing this package\n\nInstallation\n--------------\nThis package is available on PyPI, the Python Package Index from where it can be installed as follows:\n\n::\n\n pip install rhealpixdggs\n\nrHEALPixDGGS is also available for download from the github repository `<https://github.com/manaakiwhenua/rhealpixdggs-py>`_ from where the latest version can be cloned.\n\nYou can install from source using Poetry in a virtual environment (MacOS and Linux, assuming Poetry is already installed on your system):\n\n::\n\n python3 -m venv rhealpixdggs\n source rhealpixdggs/bin/activate\n python install --upgrade pip\n poetry install\n\nOr on Windows:\n\n::\n\n python3 -m venv rhealpixdggs\n rhealpixdggs\\Scripts\\activate\n python install --upgrade pip\n poetry install\n\n\nFor development:\n\n::\n poetry shell\n poetry install\n\n\nTests\n------\nThe 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``).\n\nTwo UNIX shell scripts are included in this repository to run all unit and doc tests:\n\n* ``run_doctests.sh``\n* ``run_unittests.sh``\n\nRunning the command ``python tests/test_<foo>.py`` performs a sequence of automated tests of ``<foo>.py``.\n\nFor example, ``tests/test_distortion.py`` automatically tests ``distortion.py``.\n\nIf you update a module, then update its test file to test the changes you made!\n\nTest early, test often, test automatically!\n\nThere are a couple of files in the main package directory that can be used to run all tests, starting ``run_...``.\n\nDocumentation\n--------------\nDocumentation can be found at:\n\n- `The rHEALPix Discrete Global Grid System <https://datastore.landcareresearch.co.nz/dataset/rhealpix-discrete-global-grid-system>`_ - The rHEALPix Discrete Global Grid System\n- ``docs/build/latex/rHEALPixDGGS.pdf`` - The rHEALPixDGGS manual\n- ``docs/build/html/index.html`` - The rHEALPixDGGS manual in HTML format\n\nThe latter two documents are generated automatically from the source code of the ``rhealpixdggs`` package modules.\nTo automatically build these yourself, install the Python package `Sphinx <http://sphinx-doc.org/>`_ (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.\nFor the PDF documentation, you might also need to install `LaTeX <http://www.latex-project.org/>`_.\n\nThe ``source`` and ``build`` directories contain all the Sphinx source and build files, respectively. \n\nLicense\n-------\nThis code is licensed under the `GNU Lesser General Public License v3.0, <http://www.gnu.org/licenses/lgpl-3.0.html>`_. See the file ``LICENSE`` for a copy of the deed.\n\n# NB make a build/release makefile or script\nReleasing\n-------\n\nFor PyPI:\n\n::\n # Build the distribution (.tar.gz and .whl)\n poetry build\n\n # Upload to PyPI (test)\n poetry publish --repository testpypi\n\n # Test install from testpypi\n pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple rhealpixdggs\n\n # Upload to PyPI\n poetry publish\n\nA **conda package** `rhealpixdggs` is also maintained at [conda-forge](https://github.com/conda-forge/rhealpixdggs-feedstock).\n\n\nContact\n-------\n| *Maintainer*:\n| **Richard Law**\n| `Manaaki Whenua \u2013 Landcare Research <https://www.landcareresearch.co.nz/>`_\n| `lawr@landcareresearch.co.nz <mailto:lawr@landcareresearch.co.nz>`_\n|\n| *Release Manager*:\n| **Dr Nicholas J. Car**\n| `SURROUND Australia Pty Ltd <https://surround.com>`_\n| `nicholas.car@surroundaustralia.com <mailto:nicholas.car@surroundaustralia.com>`_\n|\n| *Original author*:\n| **Alexander Raichev**\n| `<https://raichev.net/>`_\n| `alex@raichev.net <mailto:alex@raichev.net>`_\n|\n| *Former Maintainer*:\n| **Robert Gibb**\n| `Manaaki Whenua \u2013 Landcare Research <https://www.landcareresearch.co.nz/>`_\n| `gibbr@landcareresearch.co.nz <mailto:gibbr@landcareresearch.co.nz>`_\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An implementation of the rHEALPix discrete global grid system",
"version": "0.5.12",
"project_urls": {
"bug_reports": "https://github.com/manaakiwhenua/rhealpixdggs-py/issues",
"source": "https://github.com/manaakiwhenua/rhealpixdggs-py"
},
"split_keywords": [
"dggs",
" discrete global grid system",
" reference system",
" spatial",
" geospatial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a3179a2406ac607c5fd3d03936195186b23af6df864e706a6d9c800c1d9f1de",
"md5": "3d7e79189bbb4014ba5e04bc14edc093",
"sha256": "0b27faafdce246ac05375c26cffbc9619d18885f46c86b219317d331a4075ece"
},
"downloads": -1,
"filename": "rhealpixdggs-0.5.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d7e79189bbb4014ba5e04bc14edc093",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 62641,
"upload_time": "2025-08-15T01:37:58",
"upload_time_iso_8601": "2025-08-15T01:37:58.674513Z",
"url": "https://files.pythonhosted.org/packages/3a/31/79a2406ac607c5fd3d03936195186b23af6df864e706a6d9c800c1d9f1de/rhealpixdggs-0.5.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec1e3fa5e50e2f2a4a98d68cd58424ca961dda88acceb4525746952aa0f5f5d8",
"md5": "401e3c85b8979b8faf3d12c18d2ebba7",
"sha256": "2d2b53b78192d585e13e580274dc8fab19516b8bcf1dd1892b16f0b4a4c338fd"
},
"downloads": -1,
"filename": "rhealpixdggs-0.5.12.tar.gz",
"has_sig": false,
"md5_digest": "401e3c85b8979b8faf3d12c18d2ebba7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 539254,
"upload_time": "2025-08-15T01:38:02",
"upload_time_iso_8601": "2025-08-15T01:38:02.706463Z",
"url": "https://files.pythonhosted.org/packages/ec/1e/3fa5e50e2f2a4a98d68cd58424ca961dda88acceb4525746952aa0f5f5d8/rhealpixdggs-0.5.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-15 01:38:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manaakiwhenua",
"github_project": "rhealpixdggs-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rhealpixdggs"
}
JSON
