Metadata-Version: 2.1
Name: pybelbg
Version: 26.7.29
Summary: Pure Python Belgian hBG18 and Lambert conversions
Home-page: https://GitHub.com/mrJean1/PyBeLBG
Author: Jean M. Brouwers
Author-email: mrJean1@Gmail.com
Maintainer: Jean M. Brouwers
Maintainer-email: mrJean1@Gmail.com
License: MIT
Keywords: BD08 BD72 BD50 Belgium BE bilinear Deuxième-Nivellement-Général DNG hBG hBG18 hybrid-quasi-geoid Lambert Lambert-Conformal-Conic quasi-geoid TAW Tweede-Algemene-Waterpassing Uccle Ukkel
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering :: GIS


=======
PyBeLBG
=======

A pure Python implementation of the Belgian **hybrid quasi-geoid** hBG18_ with several Belgian ``Lambert
2018``, ``-1972`` and ``-1950`` conformal conic projections to convert between geodetic lat-, longitude and
ellipsoidal height and local ``Lambert`` easting, northing and orthometric height using bilinear interpolation
of quasi-geoid hBG18_ heights.

Each of 5 ``Be*LBG`` transformer classes provides a ``forward`` method to convert a geodetic lat-, longitude
and ellipsoidal height to local easting, northing and orthometric height (``H``) and a ``reverse`` method to
transform local to geodetic coordinates and orthometric to ellipsoidal height.

Quasi-geoid hBG18_ height is interpolated only for locations within the ``hBG18 region``.  Heights outside that
region are ``NAN`` unless raising a ``BeLBGError`` exception is specified.

For further details see the documentation_ and the main_ module.

Installation
============

To install ``pybelbg``, type ``python[3] -m pip install pybelbg`` or ``python[3] -m easy_install pybelbg``
in a terminal or command window.

Alternatively, download ``pybelbg-yy.m.d.tar.gz`` from PyPI_ or GitHub_, ``unzip`` the downloaded file,
``cd`` to directory ``pybelbg-yy.m.d`` and type ``python[3] setup.py install``.

To run the ``pybelbg`` tests, type ``python[3] test/run.py`` or type ``python[3] test/unitTestSuite.py``
before or after installation.

Dependencies
============

Installation of Python package pygeodesy_ is required, version 26.7.27 or newer.  Type
``python[3] -m pip install -r requirements.txt`` to install.

Documentation
=============

In addition to the ``pybelbg`` package, the pybelbg_ `distribution file`_ contain the tests, the test
results (on macOS only) and the complete documentation_ generated by Epydoc_ using command line:
``epydoc --html --no-private --no-source --name=pybelbg --url=... -v pybelbg``.

Tests
=====

The tests ran with Python 3.14.6, 2.7.18 and with PyPy 7.3.17 (Python 3.10.14), all with pygeodesy_
26.5.26 and on macOS 26.5.2 Tahoe in 64-bit.  The results of those tests are included in the
distribution file.

Python 3.14.6 and PyPy 7.3.17 run on Apple M4 (``arm64``), *natively*.  Python 2.7.18 runs on
Intel (``x86_64``) or Intel *emulation* (\"``arm64_x86_64``\", see function `pybelbg.machine`_).

Test coverage has been measured with coverage_ 7.14.0 using Python 3.14.6.  The complete coverage
report in HTML and a PDF summary are included in the distribution file.

The tests also ran with Python 3.14.6 on `Windows 2019Server`_ and with Python 3.13.3 on Windows 11,
both in 64-bit only.

Notes
=====

All Python source code has been statically checked_ with Ruff_ using Python 3.13.12 and with
PyChecker_, PyFlakes_, PyCodeStyle_ (formerly Pep8) and McCabe_ using Python 2.7.18, both in
64-bit on macOS 26.5.2 Tahoe only.

*Last updated: July 29, 2026.*

License
=======

**Copyright (C) 2026-2026 -\- mrJean1 at Gmail -\- All Rights Reserved.**

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

.. image:: https://Img.Shields.io/pypi/pyversions/pybelbg.svg?label=Python
  :target: https://PyPI.org/project/pybelbg
.. image:: https://Img.Shields.io/pypi/v/pybelbg.svg?label=PyPI
  :target: https://PyPI.org/project/pybelbg
.. image:: https://Img.Shields.io/appveyor/ci/mrJean1/PyBeLBG.svg?branch=master&label=AppVeyor
  :target: https://CI.AppVeyor.com/project/mrJean1/PyBeLBG/branch/master
.. image:: https://Img.Shields.io/badge/coverage-96%25-brightgreen
  :target: https://GitHub.com/mrJean1/PyBeLBG/blob/master/testcoverage.pdf
.. image:: https://Img.Shields.io/pypi/wheel/pybelbg.svg
  :target: https://PyPI.org/project/pybelbg/#files
.. image:: https://Img.Shields.io/pypi/l/pybelbg.svg
  :target: https://PyPI.org/project/pybelbg
.. image:: https://img.shields.io/pypi/dm/pybelbg
  :target: https://PyPI.org/project/pybelbg

.. _checked: https://GitHub.com/ActiveState/code/tree/master/recipes/Python/546532_PyChecker_postprocessor
.. _coverage: https://PyPI.org/project/coverage
.. _distribution file: https://GitHub.com/mrJean1/PyBeLBG/tree/master/dist
.. _documentation: https://mrJean1.GitHub.io/PyBeLBG
.. _Epydoc: https://PyPI.org/project/epydoc
.. _GitHub: https://GitHub.com/mrJean1/PyBeLBG
.. _GitHub/dist: https://GitHub.com/mrJean1/PyBeLBG/tree/master/dist
.. _hBG18: https://DOI.org/10.5880/isg.2018.003
.. _main: https://GitHub.com/mrJean1/PyBeLBG/blob/main/docs/pybelbg.__main__-module.html
.. _McCabe: https://PyPI.org/project/mccabe
.. _MIT License: https://OpenSource.org/licenses/MIT
.. _PyChecker: https://PyPI.org/project/pychecker
.. _PyCodeStyle: https://PyPI.org/project/pycodestyle
.. _PyFlakes: https://PyPI.org/project/pyflakes
.. _pygeodesy: https://PyPI.org/project/pygeodesy
.. _PyPI: https://PyPI.org/project/pybelbg
.. _PyPI Download files: https://PyPI.org/project/pybelbg/#files
.. _PyPy: https://formulae.brew.sh/formula/pypy3.10
.. _pybelbg: https://PyPI.org/project/pybelbg
.. _pybelbg.machine: https://mrJean1.GitHub.io/PyGeodesy/docs/pygeodesy.internals-module.html#machine
.. _Ruff: https://GitHub.com/astral-sh/ruff
.. _Windows 2019Server: https://CI.AppVeyor.com/project/mrJean1/pybelbg
