Skip to main content

Pure Python geodesy tools

Project description

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 several C++ classes by Charles Karney (C) 2008-2017 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 Cassini-Soldner, UTM (Universal Transverse Mercator), UPS (Universal Polar Stereographic) 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 EPSG, Geohashes, Georefs (WGRS) and Garefs (GARS) .

Other modules provide Lambert conformal conic projections and positions (from John P. Snyder, Map Projections – A Working Manual, 1987, pp 107-109), functions to clip a path or polygon of LatLon points using the Cohen-Sutherland and the Sutherland-Hodgman methods, 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 and classes to interpolate the height of LatLon points and several Geoid models.

Testing

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

The tests have been run with Python 2.7.16 and 3.7.3 (both with geographiclib 1.49, numpy 1.16.1, and scipy 1.2.1) and with PyPy 6.0.0 (Python 2.7.13 and 3.5.3) on macOS 10.13.6 High Sierra. The results of those tests are included in the distribution files.

The tests also run with Python 2.6.9, 2.7.14, 3.5.6 and 3.6.3 (and geographiclib 1.49) on Ubuntu 14.04 and with Python 3.7.3 (and geographiclib 1.49) on Debian 9, all in 64-bit only and with Python 2.7.15, 3.6.8 and 3.7.2 (all with geographiclib 1.49) on Windows Server 2012R2 in both 32- and 64-bit.

On Python 3.7+, the tests run with and without lazy import.

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, 2.7.15 (and numpy 1.13.1, 1.14.0 or 1.15.2), 3.5.3, 3.6.2, 3.6.3, 3.6.4, 3.6.5, 3.7.0, 3.7.2 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.5 High Sierra and macOS 10.14 Mojave, 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.

Documentation

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.

Installation

To install PyGeodesy, type pip install PyGeodesy or easy_install PyGeodesy in a terminal or command window. Alternatively, download PyGeodesy-yy.m.d.zip 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 GeographicLib, NumPy and SciPy is optional. However, the former is required for module css classes CassiniSoldner and Css and function toCss and for module ellipsoidalKarney classes LatLon and Cartesian and functions areaOf and perimeterOf. The latter are needed for the Geoid… and Height… interpolators, except GeoidKarney, HeightIDW, HeightIDW2 and HeightIDW3.

Notes

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

Last updated: June 18, 2019.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyGeodesy-19.6.18.zip (1.7 MB view hashes)

Uploaded Source

Built Distribution

PyGeodesy-19.6.18-py2.py3-none-any.whl (248.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page