Pure Python geodesy tools
Switch branches/tags
Nothing to show
Clone or download
mrJean1 Again nearestOn*, more cleanup.
Added 2 functions nearestOn3 and degrees2m and a LatLon method haversineTo and more documentation cleanup.
Latest commit a921bc7 Oct 10, 2018

README.rst

PyGeodesy

A pure Python implementation of geodesy tools for various ellipsoidal and spherical earth models using precision trigonometric, vector-based and approximate methods for geodetic (lat-/longitude) and geocentric cartesian (x/y/z) coordinates.

Transcribed from JavaScript originals by Chris Veness (C) 2005-2016 and published under the same MIT License.

There are three modules for ellipsoidal earth models, ellipsoidalKarney, -Vincenty and -Nvector and two for spherical ones, sphericalTrigonometry and -Nvector. Each module provides a LatLon class with methods and functions to compute distance, initial and final bearing, intermediate and nearest points, area, perimeter, conversions and unrolling, among other things. For more information and further details see the documentation, the descriptions of Latitude/Longitude, Vincenty and Vector-based geodesy, the original JavaScript source or docs and the Python GeographicLib.

Also included are modules for conversions to and from UTM (Universal Transverse Mercator) and Web Mercator (Pseudo-Mercator) coordinates, MGRS (NATO Military Grid Reference System) and OSGR (British Ordinance Survery Grid Reference) grid references and a module for encoding and decoding Geohashes.

Two other modules provide Lambert conformal conic projections and positions (from John P. Snyder, Map Projections -- A Working Manual, 1987, pp 107-109) and several functions to simplify or linearize a path of LatLon points (or a NumPy array), including implementations of the Ramer-Douglas-Peucker, the Visvalingam-Whyatt and the Reumann-Witkam algorithms and modified versions of the former.

All Python source code has been statically checked with PyChecker, PyFlakes, PyCodeStyle (formerly Pep8) and McCabe using Python 2.7.15 and with Flake8 using Python 3.7.0, both in 64-bit on macOS 10.13.6 High Sierra.

The tests have been run with Python 2.7.15 (with geographiclib 1.49 and numpy 1.14.0), with Python 3.7.0 (with geographiclib 1.49) and with PyPy 6.0.0 (Python 2.7.13 and 3.5.3) on macOS 10.13.6 High Sierra and macOS 10.14 Mojave, with Python 2.6.9, 2.7.14, 3.5.6 and 3.6.3 (and geographiclib 1.49) on Debian 8 and with Python 3.7.0 (and geographiclib 1.49) on Debian 9, all in 64-bit only and with Python 2.7.15, 3.6.6 and 3.7.0 (all with geographiclib 1.49) on Windows Server 2012R2 in 32- and 64-bit.

Previously, the tests were run with Python 2.6.9 (and numpy 1.6.2), 2.7.10 (and numpy 1.8.0rc1), 2.7.13, 2.7.14 (and numpy 1.13.1), 3.5.3, 3.6.2, 3.6.3, 3.6.4, 3.6.5 and Intel-Python 3.5.3 (and numpy 1.11.3) on MacOS X 10.10 Yosemite, MacOS X 10.11 El Capitan, macOS 10.12 Sierra, macOS 10.13.4 and/or 10.13.5 High Sierra, with Pythonista 3.1 on iOS 10.3.3, 11.0.3, 11.1.2 and 11.3 on iPad4, with Pythonista 3.2 on iOS 11.4.1 and 12.0 on iPad4, iPhone7 and/or iPhone10, all in 64-bit only and with 32-bit Python 2.6.6 on Windows XP SP3 and with 32-bit Python 2.7.14 on Windows 10 Pro.

In addition to the PyGeodesy package, the distribution files 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=PyGeodesy --url=... -v pygeodesy.

To install PyGeodesy, type pip install PyGeodesy or easy_install PyGeodesy in a terminal or command window. Alternatively, download PyGeodesy-yy.m.d from PyPI or GitHub, unzip the downloaded file, cd to directory PyGeodesy-yy.m.d and type python setup.py install. To run all PyGeodesy tests, type python setup.py test before installation.

Installation of NumPy and GeographicLib is optional. However, the latter is required for module ellipsoidalKarney classes LatLon and Cartesian and the functions areaOf and perimeterOf.

Some function and method names differ from the JavaScript version. In such cases documentation tag JS name: shows the original JavaScript name.

Last updated: Oct 10, 2018.

https://Img.Shields.io/pypi/pyversions/PyGeodesy.svg?label=Python https://Img.Shields.io/appveyor/ci/mrJean1/PyGeodesy.svg?branch=master&label=AppVeyor https://Img.Shields.io/travis/mrJean1/PyGeodesy.svg?branch=master&label=Travis https://API.Cirrus-CI.com/github/mrJean1/PyGeodesy.svg?branch=master&label=Cirrus https://Img.Shields.io/pypi/v/PyGeodesy.svg?label=PyPI

Copyright (C) 2016-2018 -- mrJean1 at Gmail dot com

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.