Coverage for pygeodesy/__init__.py: 12%
181 statements
« prev ^ index » next coverage.py v7.2.2, created at 2023-04-21 13:14 -0400
« prev ^ index » next coverage.py v7.2.2, created at 2023-04-21 13:14 -0400
2# -*- coding: utf-8 -*-
4u'''A pure Python implementation of geodesy tools for various ellipsoidal and spherical earth
5models using precision trigonometric, vector-based, exact, elliptic, iterative and approximate
6methods for geodetic (lat-/longitude) and geocentric (U{ECEF<https://WikiPedia.org/wiki/ECEF>}
7cartesian) coordinates.
9Transcoded from U{JavaScript originals<https://GitHub.com/ChrisVeness/geodesy>} by I{Chris Veness
10(C) 2005-2022} and from several U{C++ classes<https://GeographicLib.SourceForge.io/C++/doc/annotated.html>}
11by I{Charles F.F. Karney (C) 2008-2022} and published under the same U{MIT License
12<https://OpenSource.org/licenses/MIT>}**.
14There are four modules for ellipsoidal earth models, C{ellipsoidalExact}, C{-Karney},
15C{-Vincenty} and C{-Nvector} and two for spherical ones, C{sphericalTrigonometry}
16and C{-Nvector}. Each module provides a geodetic B{C{LatLon}} and a geocentric
17B{C{Cartesian}} class with methods and functions to compute distance, surface area,
18perimeter, initial and final bearing, intermediate and nearest points, circle intersections
19and secants, path intersections, 3-point resections, rhumb and rhumb lines, trilateration (by
20intersection, by overlap and in 3d), conversions and unrolling, among other things. For more
21information and further details see the U{documentation<https://mrJean1.GitHub.io/PyGeodesy>},
22the descriptions of U{Latitude/Longitude<https://www.Movable-Type.co.UK/scripts/latlong.html>},
23U{Vincenty<https://www.Movable-Type.co.UK/scripts/latlong-vincenty.html>} and
24U{Vector-based<https://www.Movable-Type.co.UK/scripts/latlong-vectors.html>} geodesy,
25the original U{JavaScript source<https://GitHub.com/ChrisVeness/geodesy>} or
26U{docs<https://www.Movable-Type.co.UK/scripts/geodesy/docs>} and I{Karney}'s Python
27U{geographiclib<https://PyPI.org/project/geographiclib>} and U{C++ GeographicLib
28<https://GeographicLib.SourceForge.io/C++/doc/index.html>}.
30Also included are modules for conversions to and from U{Cassini-Soldner
31<https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1CassiniSoldner.html>},
32U{ECEF<https://WikiPedia.org/wiki/ECEF>} (Earth-Centered, Earth-Fixed cartesian), U{UTM
33<https://www.Movable-Type.co.UK/scripts/latlong-utm-mgrs.html>} (Universal Transverse Mercator
34and U{Exact<https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1TransverseMercatorExact.html>}),
35U{UPS<https://WikiPedia.org/wiki/Universal_polar_stereographic_coordinate_system>} (Universal Polar
36Stereographic) and U{Web Mercator<https://WikiPedia.org/wiki/Web_Mercator>} (Pseudo-Mercator) coordinates,
37U{MGRS<https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1MGRS.html>} (Military Grid Reference
38System, UTM I{and} UPS) and U{OSGR<https://www.Movable-Type.co.UK/scripts/latlong-os-gridref.html>} (British
39Ordinance Survery Grid Reference) grid references, U{TRF<http://ITRF.ENSG.IGN.Fr>} (Terrestrial Reference
40Frames) and modules to encode and decode U{EPSG<https://EPSG.org>}, U{Geohashes
41<https://www.Movable-Type.co.UK/scripts/geohash.html>}, U{Georefs (WGRS)
42<https://WikiPedia.org/wiki/World_Geographic_Reference_System>} and U{Garefs (GARS)
43<https://WikiPedia.org/wiki/Global_Area_Reference_System>}.
45Other modules provide U{Albers equal-area<https://GeographicLib.SourceForge.io/
46html/classGeographicLib_1_1AlbersEqualArea.html>} projections, U{equidistant
47<https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1AzimuthalEquidistant.html>}
48and other I{azimuthal} projections, Lambert I{conformal conic} projections and
49positions, functions to clip paths or polygons of C{LatLon} points using the
50U{Cohen-Sutherland<https://WikiPedia.org/wiki/Cohen-Sutherland_algorithm>},
51U{Forster-Hormann-Popa<https://www.ScienceDirect.com/science/article/pii/S259014861930007X>},
52U{Greiner-Hormann<http://www.inf.USI.CH/hormann/papers/Greiner.1998.ECO.pdf>},
53U{Liang-Barsky<https://www.CS.Helsinki.FI/group/goa/viewing/leikkaus/intro.html>} and
54U{Sutherland-Hodgman<https://WikiPedia.org/wiki/Sutherland-Hodgman_algorithm>} methods,
55functions to U{simplify<https://Bost.Ocks.org/mike/simplify>} or linearize a path of C{LatLon}
56points (or a U{NumPy array<https://docs.SciPy.org/doc/numpy/reference/generated/numpy.array.html>}),
57including implementations of the U{Ramer-Douglas-Peucker<https://WikiPedia.org/wiki/
58Ramer-Douglas-Peucker_algorithm>}, the U{Visvalingam-Whyatt<https://hydra.Hull.ac.UK/
59resources/hull:8338>} and the U{Reumann-Witkam<https://psimpl.SourceForge.net/reumann-witkam.html>}
60algorithms and modified versions of the former. Other classes provide I{boolean} operations between
61(composite) polygons or U{interpolate <https://docs.SciPy.org/doc/scipy/reference/interpolate.html>}
62the L{height<pygeodesy.heights>} of C{LatLon} points and L{Geoid<pygeodesy.geoids>} models or
63compute various U{Fréchet<https://WikiPedia.org/wiki/Frechet_distance>} or U{Hausdorff
64<https://WikiPedia.org/wiki/Hausdorff_distance>} distances.
66Installation
67============
69To install PyGeodesy, type C{python[3] -m pip install PyGeodesy} or C{python[3] -m easy_install
70PyGeodesy} in a terminal or command window.
72Alternatively, download C{PyGeodesy-yy.m.d.zip} from U{PyPI<https://PyPI.org/project/PyGeodesy>}
73or U{GitHub<https://GitHub.com/mrJean1/PyGeodesy>}, C{unzip} the downloaded file, C{cd} to
74directory C{Pygeodesy-yy.m.d} and type C{python[3] setup.py install}.
76To run all PyGeodesy tests, type C{python[3] setup.py test} or type C{python[3]
77test/run.py} or type C{python[3] test/unitTestSuite.py} before or after installation.
79Dependencies
80============
82Installation of I{Karney}'s Python package U{geographiclib<https://PyPI.org/project/geographiclib>}
83is optional, but required to use modules L{ellipsoidalKarney} and L{css}, L{azimuthal} classes
84L{EquidistantKarney} and L{GnomonicKarney} and the L{HeightIDWkarney} interpolator.
86Both U{numpy<https://PyPI.org/project/numpy>} and U{scipy<https://PyPI.org/project/scipy>} must be
87installed for most L{Geoid...<pygeodesy.geoids>} and L{Height...<pygeodesy.heights>} interpolators,
88except L{GeoidKarney} and the L{HeightIDW...<pygeodesy.heights>} ones.
90Functions and C{LatLon} methods L{circin6}, L{circum3}, L{circum4_}, L{soddy4}, L{trilaterate3d2}
91and C{trilaterate5} require U{numpy<https://PyPI.org/project/numpy>}.
93Modules L{ellipsoidalGeodSolve} and L{geodsolve} and L{azimuthal} classes L{EquidistantGeodSolve}
94and L{GnomonicGeodSolve} depend on I{Karney}'s C++ utility U{GeodSolve
95<https://GeographicLib.SourceForge.io/C++/doc/GeodSolve.1.html>} to be executable and set with
96env variable C{PYGEODESY_GEODSOLVE}.
98To compare C{MGRS} results from modules L{mgrs} and C{testMgrs} with I{Karney}'s C++ utility
99U{GeoConvert<https://GeographicLib.SourceForge.io/C++/doc/GeoConvert.1.html>}, the latter must
100be executable and set with env variable C{PYGEODESY_GEOCONVERT}.
102Module L{rhumbsolve} needs I{Karney}'s C++ utility U{RhumbSolve
103<https://GeographicLib.SourceForge.io/C++/doc/RhumbSolve.1.html>} to be executable and set with
104env variable C{PYGEODESY_RHUMBSOLVE}.
106Documentation
107=============
109In addition to the C{pygeodesy} package, the U{PyGeodesy<https://PyPI.org/project/PyGeodesy>}
110U{distribution files<https://GitHub.com/mrJean1/PyGeodesy/tree/master/dist>} contain the tests,
111the test results (on macOS only) and the complete U{documentation<https://mrJean1.GitHub.io/PyGeodesy>}
112(generated by U{Epydoc<https://PyPI.org/project/epydoc>} using command line:
113C{epydoc --html --no-private --no-source --name=PyGeodesy --url=... -v pygeodesy}).
115Tests
116=====
118The tests ran with Python 3.11.3 (with U{geographiclib<https://PyPI.org/project/geographiclib>} 2.0, U{numpy
119<https://PyPI.org/project/numpy>} 1.24.2 and U{scipy<https://PyPI.org/project/scipy>} 1.10.1), Python 3.10.8
120(with U{geographiclib<https://PyPI.org/project/geographiclib>} 2.0, U{numpy<https://PyPI.org/project/numpy>}
1211.23.3, U{scipy<https://PyPI.org/project/scipy>} 1.9.1, U{GeoConvert
122<https://GeographicLib.SourceForge.io/html/utilities.html>} 1.51, U{GeodSolve
123<https://GeographicLib.SourceForge.io/html/utilities.html>} 1.51 and U{RhumbSolve
124<https://GeographicLib.SourceForge.io/html/utilities.html>} 1.51), Python 3.9.6, Python 3.8.10 (with
125U{geographiclib<https://PyPI.org/project/geographiclib>} 1.52, U{numpy<https://PyPI.org/project/numpy>} 1.19.2
126and U{scipy<https://PyPI.org/project/scipy>} 1.5.2) and Python 2.7.18 (with U{geographiclib
127<https://PyPI.org/project/geographiclib>} 1.50, U{numpy<https://PyPI.org/project/numpy>} 1.16.6, U{scipy
128<https://PyPI.org/project/scipy>} 1.2.2, U{GeoConvert<https://GeographicLib.SourceForge.io/html/utilities.html>}
1291.51, U{GeodSolve<https://GeographicLib.SourceForge.io/html/utilities.html>} 1.51 and U{RhumbSolve
130<https://GeographicLib.SourceForge.io/html/utilities.html>} 1.51), all on macOS 13.3.1 Ventura and in 64-bit only.
132All tests ran with and without C{lazy import} for Python 3 and with command line option C{-W default} and
133env variable C{PYGEODESY_WARNINGS=on} for all Python versions. The results of those tests are included in
134the distribution files.
136Test coverage has been measured with U{coverage<https://PyPI.org/project/coverage>} 7.2.2 using only Python 3.11.3
137and 3.10.8. The complete coverage report in HTML and a PDF summary are included in the distribution files.
139Python 3.11.3, 3.10.8 and 3.9.6 ran on Apple M1 Silicon (C{arm64}), I{natively}. Python 3.8.10 and 2.7.18 ran
140on Intel (C{x86_64}) or Intel I{emulation} ("C{arm64_x86_64}", see function L{pygeodesy.machine}).
142The tests also ran with Python 3.11.3 (and U{geographiclib<https://PyPI.org/project/geographiclib>} 2.0) on
143U{Debian 11<https://Cirrus-CI.com/github/mrJean1/PyGeodesy/master>} in 64-bit only and with Python 3.11.3,
1443.10.10 and 2.7.18 (all with U{geographiclib<https://PyPI.org/project/geographiclib>} 1.52) on U{Windows 10
145<https://CI.AppVeyor.com/project/mrJean1/pygeodesy>} in 64- and/or 32-bit.
147A single-File and single-Directory application with C{pygeodesy} has been bundled using U{PyInstaller
148<https://PyPI.org/project/pyinstaller>} 3.4 and 64-bit Python 3.7.3 on macOS 10.13.6 High Sierra.
150Previously, the tests were run with Python 3.11.2, 3.10.1-7, 3.9.1, 3.8.7, 3.7.1, 2.7.15, U{PyPy
151<https://PyPy.org>}7.3.1 (Python 3.6.9) and U{PyPy<https://PyPy.org>} 7.1.1 (Python 2.7.13) (and U{geographiclib
152<https://PyPI.org/project/geographiclib>} 1.52, U{numpy<https://PyPI.org/project/numpy>} 1.16.3, 1.16.4, 1.16.6,
1531.19.0, 1.19.4, 1.19.5 or 1.22.4 and U{scipy<https://PyPI.org/project/scipy>} 1.2.1, 1.4.1, 1.5.2 or 1.8.1) on
154U{Ubuntu 16.04<https://Travis-CI.com/mrJean1/PyGeodesy>}, with Python 3.10.0-1, 3.9.0-5, 3.8.0-6, 3.7.2-6, 3.7.0,
1553.6.2-5, 3.5.3, 2.7.13-17, 2.7.10 and 2.6.9 (and U{numpy<https://PyPI.org/project/numpy>} 1.19.0, 1.16.5, 1.16.2,
1561.15.2, 1.14.0, 1.13.1, 1.8.0rc1 or 1.6.2 and U{scipy<https://PyPI.org/project/scipy>} 1.5.0), U{PyPy
157<https://PyPy.org>} 7.3.0 (Python 2.7.13 and 3.6.9), U{PyPy<https://PyPy.org>} 6.0.0 (Python 2.7.13 and 3.5.3)
158and U{Intel-Python<https://software.Intel.com/en-us/distribution-for-python>} 3.5.3 (and U{numpy
159<https://PyPI.org/project/numpy>} 1.11.3) on macOS 13.0-2.1 Ventura, 12.1-6 Monterey, 11.0-5.2-6.1 Big Sur (aka
16010.16), 10.15.3, 10.15.5-7 Catalina, 10.14 Mojave, 10.13.6 High Sierra and 10.12 Sierra, MacOS X 10.11 El Capitan
161and/or MacOS X 10.10 Yosemite, with U{Pythonista<https://OMZ-Software.com/pythonista>}3.2 (with geographiclib
1621.50 or 1.49 and numpy 1.8.0) on iOS 14.4.2, 11.4.1, 12.0-3 on iPad4, iPhone6, iPhone10 and/or iPhone12, with
163U{Pythonista<https://OMZ-Software.com/pythonista>} 3.1 on iOS 10.3.3, 11.0.3, 11.1.2 and 11.3 on iPad4, all in
16464-bit only and with 32-bit Python 2.7.14 on Windows Server 2012R2, Windows 10 Pro and with 32-bit Python 2.6.6
165on Windows XP SP3.
167Notes
168=====
170All Python source code has been statically U{checked<https://GitHub.com/ActiveState/code/tree/master/recipes/
171Python/546532_PyChecker_postprocessor>} with U{PyChecker<https://PyPI.org/project/pychecker>}, U{PyFlakes
172<https://PyPI.org/project/pyflakes>}, U{PyCodeStyle<https://PyPI.org/project/pycodestyle>} (formerly Pep8) and
173U{McCabe<https://PyPI.org/project/mccabe>} using Python 2.7.18 and with U{Flake8<https://PyPI.org/project/flake8>}
174using Python 3.11.3, both in 64-bit on macOS 13.3.1 Ventura.
176For a summary of all I{Karney}-based functionality in C{pygeodesy}, see module U{karney
177<https://mrJean1.GitHub.io/PyGeodesy/docs/pygeodesy.karney-module.html>}.
179In Python 2, symbols L{S_DEG}, L{S_MIN}, L{S_SEC}, L{S_RAD} and L{S_SEP} may be multi-byte, non-ascii
180characters and if so, I{not} C{unicode}.
182Env variables
183=============
185The following environment variables are observed by C{PyGeodesy}:
187 - C{PYGEODESY_EXCEPTION_CHAINING} - see module L{pygeodesy.errors}.
188 - C{PYGEODESY_FSUM_PARTIALS} - see module L{pygeodesy.fsums} and class L{pygeodesy.Fsum}.
189 - C{PYGEODESY_FSUM_RESIDUAL} - see module L{pygeodesy.fsums} and class L{pygeodesy.Fsum}.
190 - C{PYGEODESY_GEOCONVERT} - see module L{pygeodesy.mgrs}.
191 - C{PYGEODESY_GEODSOLVE} - see module L{pygeodesy.geodsolve}.
192 - C{PYGEODESY_LAZY_IMPORT} - see module L{pygeodesy.lazily} and variable L{pygeodesy.isLazy}.
193 - C{PYGEODESY_NOTIMPLEMENTED} - __special__ methods return C{NotImplemented} if set to "std".
194 - C{PYGEODESY_RHUMBSOLVE} - see module L{pygeodesy.rhumbsolve}.
195 - C{PYGEODESY_UPS_POLES} - see modules L{pygeodesy.ups} and L{pygeodesy.mgrs}.
197and these to control standard or I{named} C{repr}esentations:
199 - C{PYGEODESY_BEARING_STD_REPR} - see method L{pygeodesy.Bearing}C{.__repr__}.
200 - C{PYGEODESY_BOOL_STD_REPR} - see method L{pygeodesy.Bool}C{.__repr__}.
201 - C{PYGEODESY_DEGREES_STD_REPR} - see method L{pygeodesy.Degrees}C{.__repr__}.
202 - C{PYGEODESY_FLOAT_STD_REPR} - see method L{pygeodesy.Float}C{.__repr__}.
203 - C{PYGEODESY_INT_STD_REPR} - see method L{pygeodesy.Int}C{.__repr__}.
204 - C{PYGEODESY_METER_STD_REPR} - see method L{pygeodesy.Meter}C{.__repr__}.
205 - C{PYGEODESY_RADIANS_STD_REPR} - see method L{pygeodesy.Radians}C{.__repr__}.
206 - C{PYGEODESY_STR_STD_REPR} - see method L{pygeodesy.Str}C{.__repr__}.
208plus during development:
210 - C{PYGEODESY_FOR_DOCS} - for extended documentation by C{epydoc}.
211 - C{PYGEODESY_GEOGRAPHICLIB} - see module L{pygeodesy.karney}.
212 - C{PYGEODESY_WARNINGS} - see module L{pygeodesy.props} and function L{pygeodesy.DeprecationWarnings}.
213 - C{PYGEODESY_XPACKAGES} - see module L{pygeodesy.basics}.
214 - C{PYTHONDEVMODE} - see modules L{pygeodesy.errors} and L{pygeodesy.props}.
216and:
218 - C{PYGEODESY_INIT__ALL__} - Set env variable C{PYGEODESY_INIT__ALL__} to anything
219 other than C{"__all__"} to avoid importing all C{pygeodesy} modules unnecessarily
220 (in Python 2 or with C{PYGEODESY_LAZY_IMPORT} turned off in Python 3). However,
221 to import a C{pygeodesy} item, the item name must be qualified with the C{module}
222 name, for example C{ from pygeodesy.ellipsoidalExact import LatLon }
224License
225=======
227**) U{Copyright (C) 2016-2023 -- mrJean1 at Gmail -- All Rights Reserved.
228<https://OpenSource.org/licenses/MIT>}
230C{Permission is hereby granted, free of charge, to any person obtaining a
231copy of this software and associated documentation files (the "Software"),
232to deal in the Software without restriction, including without limitation
233the rights to use, copy, modify, merge, publish, distribute, sublicense,
234and/or sell copies of the Software, and to permit persons to whom the
235Software is furnished to do so, subject to the following conditions:}
237C{The above copyright notice and this permission notice shall be included
238in all copies or substantial portions of the Software.}
240C{THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
241OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
242FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
243THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
244OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
245ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
246OTHER DEALINGS IN THE SOFTWARE.}
248@newfield example: Example, Examples
250@var EPS: System's M{epsilon} ≈ 2.22044604925e-16 (C{float}).
251@var EPS0: M{EPS**2} ≈ 4.9e-32 for near-zero comparison
252@var EPS02: M{EPS**4} ≈ 2.4e-63 for near-zero squared comparison
253@var EPS1: M{1 - EPS} ≈ 0.9999999999999998 (C{float}).
254@var EPS2: M{EPS * 2} ≈ 4.440892098501e-16 (C{float}).
255@var EPS_2: M{EPS / 2} ≈ 1.110223024625e-16 (C{float}).
256@var EPS4: M{EPS * 4} ≈ 8.881784197001e-16 (C{float}).
258@var F_D: Format degrees as unsigned "deg°" with symbol, plus compass point suffix C{N, S, E} or C{W} (C{str}).
259@var F_DM: Format degrees as unsigned "deg°min′" with symbols, plus suffix (C{str}).
260@var F_DMS: Format degrees as unsigned "deg°min′sec″" with symbols, plus suffix (C{str}).
261@var F_DEG: Format degrees as unsigned "[D]DD" I{without} symbol, plus suffix (C{str}).
262@var F_MIN: Format degrees as unsigned "[D]DDMM" I{without} symbols, plus suffix (C{str}).
263@var F_SEC: Format degrees as unsigned "[D]DDMMSS" I{without} symbols, plus suffix (C{str}).
264@var F_D60: Format degrees as unsigned "[D]DD.MMSS" C{sexagecimal} I{without} symbols, plus suffix (C{str}).
265@var F__E: Format degrees as unsigned "%E" I{without} symbols, plus suffix (C{str}).
266@var F__F: Format degrees as unsigned "%F" I{without} symbols, plus suffix (C{str}).
267@var F__G: Format degrees as unsigned "%G" I{without} symbols, plus suffix (C{str}).
268@var F_RAD: Convert degrees to radians and format as unsigned "RR" with symbol, plus suffix (C{str}).
270@var F_D_: Format degrees as signed "-/deg°" with symbol, I{without} suffix (C{str}).
271@var F_DM_: Format degrees as signed "-/deg°min′" with symbols, I{without} suffix (C{str}).
272@var F_DMS_: Format degrees as signed "-/deg°min′sec″" with symbols, I{without} suffix (C{str}).
273@var F_DEG_: Format degrees as signed "-/[D]DD" I{without} symbol, I{without} suffix (C{str}).
274@var F_MIN_: Format degrees as signed "-/[D]DDMM" I{without} symbols, I{without} suffix (C{str}).
275@var F_SEC_: Format degrees as signed "-/[D]DDMMSS" I{without} symbols, I{without} suffix (C{str}).
276@var F_D60_: Format degrees as signed "-/[D]DD.MMSS" C{sexagecimal} I{without} symbols, I{without} suffix (C{str}).
277@var F__E_: Format degrees as signed "-/%E" I{without} symbols, I{without} suffix (C{str}).
278@var F__F_: Format degrees as signed "-/%F" I{without} symbols, I{without} suffix (C{str}).
279@var F__G_: Format degrees as signed "-/%G" I{without} symbols, I{without} suffix (C{str}).
280@var F_RAD_: Convert degrees to radians and format as signed "-/RR" I{without} symbol, I{without} suffix (C{str}).
282@var F_D__: Format degrees as signed "-/+deg°" with symbol, I{without} suffix (C{str}).
283@var F_DM__: Format degrees as signed "-/+deg°min′" with symbols, I{without} suffix (C{str}).
284@var F_DMS__: Format degrees as signed "-/+deg°min′sec″" with symbols, I{without} suffix (C{str}).
285@var F_DEG__: Format degrees as signed "-/+[D]DD" I{without} symbol, I{without} suffix (C{str}).
286@var F_MIN__: Format degrees as signed "-/+[D]DDMM" I{without} symbols, without suffix (C{str}).
287@var F_SEC__: Format degrees as signed "-/+[D]DDMMSS" I{without} symbols, I{without} suffix (C{str}).
288@var F_D60__: Format degrees as signed "-/+[D]DD.MMSS" C{sexagecimal} I{without} symbols, I{without} suffix (C{str}).
289@var F__E__: Format degrees as signed "-/+%E" I{without} symbols, I{without} suffix (C{str}).
290@var F__F__: Format degrees as signed "-/+%F" I{without} symbols, I{without} suffix (C{str}).
291@var F__G__: Format degrees as signed "-/+%G" I{without} symbols, I{without} suffix (C{str}).
292@var F_RAD__: Convert degrees to radians and format as signed "-/+RR" I{without} symbol, I{without} suffix (C{str}).
294@var DIG: System's M{float decimal digits} = 15 (C{int}).
295@var INF: Infinity (C{float}), see functions L{pygeodesy.isinf} and L{pygeodesy.isfinite} and C{NINF}.
296@var INT0: C{int(0)}, missing Z-components, C{if B{z}=B{INT0}}, see functions L{pygeodesy.isint0}, L{pygeodesy.meeus2}
297@var MANT_DIG: System's M{float mantissa bits} = 53 (C{int}).
298@var MAX: System's M{float max} ≈ 1.798e+308 (C{float}).
299@var MIN: System's M{float min} ≈ 2.225e-308 (C{float}).
300@var NAN: Not-A-Number (C{float}), see function L{pygeodesy.isnan}.
301@var NEG0: Negative 0.0 (C{float}), see function L{pygeodesy.isneg0}.
302@var NINF: Negative infinity (C{float}), see function L{pygeodesy.isninf} and C{INF}.
303@var NN: Empty (C{str}), U{I{Nomen Nescio}<https://Wiktionary.org/wiki/N.N.>}.
305@var PI: Constant M{math.pi} (C{float}).
306@var PI2: Two PI, M{PI * 2}, aka I{Tau} (C{float}).
307@var PI_2: Half PI, M{PI / 2} (C{float}).
308@var PI3: Three PI, M{PI * 3} (C{float}).
309@var PI3_2: One and a half PI, M{PI * 3 / 2} (C{float}).
310@var PI_3: One third PI, M{PI / 3} (C{float}).
311@var PI4: Four PI, M{PI * 4} (C{float}).
312@var PI_4: Quarter PI, M{PI / 4} (C{float}).
314@var R_MA: Equatorial earth radius (C{meter}), WGS84, EPSG:3785.
315@var R_MB: Polar earth radius (C{meter}), WGS84, EPSG:3785.
316@var R_M: Mean (spherical) earth radius (C{meter}).
317@var R_KM: Mean (spherical) earth radius (C{km}, kilometer).
318@var R_NM: Mean (spherical) earth radius (C{NM}, nautical miles).
319@var R_SM: Mean (spherical) earth radius (C{SM}, statute miles).
320@var R_FM: Former FAI-Sphere earth radius (C{meter}).
321@var R_GM: Average earth radius, distance to geoid surface (C{meter})
322@var R_QM: Earth' (triaxial) quadratic mean radius (C{meter})
323@var R_VM: Aviation/Navigation earth radius (C{meter}).
325@var S_DEG: Degrees symbol, default C{"°"}
326@var S_MIN: Minutes symbol, default C{"′"} aka I{PRIME}
327@var S_SEC: Seconds symbol, default C{"″"} aka I{DOUBLE_PRIME}
328@var S_RAD: Radians symbol, default C{""} aka L{pygeodesy.NN}
329@var S_DMS: If C{True} include, otherwise cancel all DMS symbols, default C{True}.
330@var S_SEP: Separator between C{deg°|min′|sec″|suffix}, default C{""} aka L{pygeodesy.NN}
332@var Conics: Registered, predefined conics (C{enum-like}).
333@var Datums: Registered, predefined datums (C{enum-like}).
334@var Ellipsoids: Registered, predefined ellipsoids (C{enum-like}).
335@var RefFrames: Registered, predefined reference frames (C{enum-like}).
336@var Transforms: Registered, predefined transforms (C{enum-like}).
338@var isLazy: Lazy import setting (C{int} 0, 1, 2 or 3+) from C{env} variable C{PYGEODESY_LAZY_IMPORT}, or C{None} if C{lazy import} is not supported or not enabled, or C{False} if initializing C{lazy import} failed.
340@var pygeodesy_abspath: Fully qualified C{pygeodesy} directory name (C{str}).
342@var version: Normalized C{PyGeodesy} version (C{str}).
343'''
345from os.path import abspath, basename, dirname
346import sys
348_init__all__ = True
349# <https://PyInstaller.ReadTheDocs.io/en/stable/runtime-information.html>
350_isfrozen = getattr(sys, 'frozen', False)
351pygeodesy_abspath = dirname(abspath(__file__)) # sys._MEIPASS + '/pygeodesy'
352_pygeodesy_ = __package__ or basename(pygeodesy_abspath)
354if _isfrozen: # avoid lazy import
355 _lazy_import2 = None
356else:
357 # setting __path__ should ...
358 __path__ = [pygeodesy_abspath]
359 try: # ... make this import work, ...
360 import pygeodesy.lazily as _
361 except ImportError: # ... if it doesn't, extend
362 # sys.path to include this very directory such
363 # that all public and private sub-modules can
364 # be imported (and checked by PyChecker, etc.)
365 sys.path.insert(0, pygeodesy_abspath) # XXX __path__[0]
367 try: # lazily requires Python 3.7+, see lazily.__doc__
368 from pygeodesy.lazily import _a_l_l_, _getenv, LazyImportError, \
369 _lazy_import2 # PYCHOK expected
370 _, __getattr__ = _lazy_import2(_pygeodesy_) # PYCHOK expected
371 _init__all__ = _getenv('PYGEODESY_INIT__ALL__', _a_l_l_) == _a_l_l_
372 del _a_l_l_, _getenv
374 except (ImportError, LazyImportError, NotImplementedError):
375 _lazy_import2 = None
377if _init__all__ and not _lazy_import2: # import and set __all__
379 # import all public modules and export as such
380 import pygeodesy.albers as albers # PYCHOK exported
381 import pygeodesy.azimuthal as azimuthal # PYCHOK exported
382 import pygeodesy.deprecated.bases as bases # PYCHOK DEPRECATED
383 import pygeodesy.basics as basics # PYCHOK exported
384 import pygeodesy.booleans as booleans # PYCHOK exported
385 import pygeodesy.cartesianBase as cartesianBase # PYCHOK exported
386 import pygeodesy.clipy as clipy # PYCHOK exported
387 import pygeodesy.constants as constants # PYCHOK exported
388 import pygeodesy.css as css # PYCHOK exported
389 import pygeodesy.deprecated.datum as datum # PYCHOK DEPRECATED
390 import pygeodesy.datums as datums # PYCHOK exported
391 import pygeodesy.deprecated as deprecated # PYCHOK exported
392 import pygeodesy.dms as dms # PYCHOK exported
393 import pygeodesy.ecef as ecef # PYCHOK exported
394 import pygeodesy.elevations as elevations # PYCHOK exported
395 import pygeodesy.ellipsoidalBase as ellipsoidalBase # PYCHOK exported
396 import pygeodesy.ellipsoidalBaseDI as ellipsoidalBaseDI # PYCHOK exported
397 import pygeodesy.ellipsoidalExact as ellipsoidalExact # PYCHOK exported
398 import pygeodesy.ellipsoidalGeodSolve as ellipsoidalGeodSolve # PYCHOK exported
399 import pygeodesy.ellipsoidalKarney as ellipsoidalKarney # PYCHOK exported
400 import pygeodesy.ellipsoidalNvector as ellipsoidalNvector # PYCHOK exported
401 import pygeodesy.ellipsoidalVincenty as ellipsoidalVincenty # PYCHOK exported
402 import pygeodesy.ellipsoids as ellipsoids # PYCHOK exported
403 import pygeodesy.elliptic as elliptic # PYCHOK exported
404 import pygeodesy.epsg as epsg # PYCHOK exported
405 import pygeodesy.etm as etm # PYCHOK exported
406 import pygeodesy.errors as errors # PYCHOK exported
407 import pygeodesy.fmath as fmath # PYCHOK exported
408 import pygeodesy.formy as formy # PYCHOK exported
409 import pygeodesy.frechet as frechet # PYCHOK exported
410 import pygeodesy.fstats as fstats # PYCHOK exported
411 import pygeodesy.fsums as fsums # PYCHOK exported
412 import pygeodesy.gars as gars # PYCHOK exported
413 import pygeodesy.geodesicw as geodesicw # PYCHOK exported
414 import pygeodesy.geodesicx as geodesicx # PYCHOK exported
415 import pygeodesy.geodsolve as geodsolve # PYCHOK exported
416 import pygeodesy.geohash as geohash # PYCHOK exported
417 import pygeodesy.geoids as geoids # PYCHOK exported
418 import pygeodesy.hausdorff as hausdorff # PYCHOK exported
419 import pygeodesy.heights as heights # PYCHOK exported
420 import pygeodesy.interns as interns # PYCHOK exported
421 import pygeodesy.iters as iters # PYCHOK exported
422 import pygeodesy.karney as karney # PYCHOK exported
423 import pygeodesy.ktm as ktm # PYCHOK exported
424 import pygeodesy.latlonBase as latlonBase # PYCHOK exported
425 import pygeodesy.lazily as lazily # PYCHOK exported
426 import pygeodesy.lcc as lcc # PYCHOK exported
427 import pygeodesy.ltp as ltp # PYCHOK exported
428 import pygeodesy.ltpTuples as ltpTuples # PYCHOK exported
429 import pygeodesy.mgrs as mgrs # PYCHOK exported
430 import pygeodesy.named as named # PYCHOK exported
431 import pygeodesy.namedTuples as namedTuples # PYCHOK exported
432 import pygeodesy.nvectorBase as nvectorBase # PYCHOK exported
433 import pygeodesy.deprecated.nvector as nvector # PYCHOK DEPRECATED
434 import pygeodesy.osgr as osgr # PYCHOK exported
435 import pygeodesy.points as points # PYCHOK exported
436 import pygeodesy.props as props # PYCHOK exported
437 import pygeodesy.resections as resections # PYCHOK exported
438 import pygeodesy.rhumbsolve as rhumbsolve # PYCHOK exported
439 import pygeodesy.rhumbx as rhumbx # PYCHOK exported
440 import pygeodesy.simplify as simplify # PYCHOK exported
441 import pygeodesy.sphericalBase as sphericalBase # PYCHOK exported
442 import pygeodesy.sphericalNvector as sphericalNvector # PYCHOK exported
443 import pygeodesy.sphericalTrigonometry as sphericalTrigonometry # PYCHOK exported
444 import pygeodesy.solveBase as solveBase # PYCHOK exported
445 import pygeodesy.streprs as streprs # PYCHOK exported
446 import pygeodesy.trf as trf # PYCHOK exported
447 import pygeodesy.triaxials as triaxials # PYCHOK exported
448 import pygeodesy.units as units # PYCHOK exported
449 import pygeodesy.unitsBase as unitsBase # PYCHOK exported
450 import pygeodesy.ups as ups # PYCHOK exported
451 import pygeodesy.utily as utily # PYCHOK exported
452 import pygeodesy.utm as utm # PYCHOK exported
453 import pygeodesy.utmups as utmups # PYCHOK exported
454 import pygeodesy.utmupsBase as utmupsBase # PYCHOK exported
455 import pygeodesy.vector2d as vector2d # PYCHOK exported
456 import pygeodesy.vector3d as vector3d # PYCHOK exported
457 import pygeodesy.vector3dBase as vector3dBase # PYCHOK exported
458 import pygeodesy.webmercator as webmercator # PYCHOK exported
459 import pygeodesy.wgrs as wgrs # PYCHOK exported
461 # lift all public classes, constants, functions, etc. but ONLY
462 # from the following modules ... (see also David Beazley's
463 # talk <https://DaBeaz.com/modulepackage/index.html>) ... BUT
464 # NOT modules ellipsoidal*, epsg, gars, geohash, spherical*,
465 # vector and wgrs ... in order keep those as modules ONLY
466 from pygeodesy.albers import * # PYCHOK __all__
467 from pygeodesy.azimuthal import * # PYCHOK __all__
468 from pygeodesy.basics import * # PYCHOK __all__
469 from pygeodesy.booleans import * # PYCHOK __all__
470# from pygeodesy.cartesianBase import * # PYCHOK __(_)__
471 from pygeodesy.clipy import * # PYCHOK __all__
472 from pygeodesy.constants import * # PYCHOK __all__
473 from pygeodesy.css import * # PYCHOK __all__
474 from pygeodesy.datums import * # PYCHOK __all__
475 from pygeodesy.deprecated import * # PYCHOK __all__
476 from pygeodesy.dms import * # PYCHOK __all__
477 from pygeodesy.ecef import * # PYCHOK __all__
478 from pygeodesy.elevations import * # PYCHOK __all__
479# from pygeodesy.ellipsoidalBase import * # PYCHOK __(_)__
480# from pygeodesy.ellipsoidalBaseDI import * # PYCHOK __(_)__
481# from pygeodesy.ellipsoidalExact import * # PYCHOK __(_)__
482# from pygeodesy.ellipsoidalGeodSolve import * # PYCHOK __(_)__
483# from pygeodesy.ellipsoidalKarney import * # PYCHOK __(_)__
484# from pygeodesy.ellipsoidalNvector import * # PYCHOK __(_)__
485 from pygeodesy.ellipsoidalVincenty import VincentyError # PYCHOK lazily
486 from pygeodesy.ellipsoids import * # PYCHOK __all__
487 from pygeodesy.elliptic import * # PYCHOK __all__
488 from pygeodesy.epsg import Epsg, EPSGError # PYCHOK lazily
489 from pygeodesy.etm import * # PYCHOK __all__
490 from pygeodesy.errors import * # PYCHOK __all__
491 from pygeodesy.fmath import * # PYCHOK __all__
492 from pygeodesy.formy import * # PYCHOK __all__
493 from pygeodesy.frechet import * # PYCHOK __all__
494 from pygeodesy.fstats import * # PYCHOK __all__
495 from pygeodesy.fsums import * # PYCHOK __all__
496 from pygeodesy.gars import Garef, GARSError # PYCHOK lazily
497 from pygeodesy.geodesicw import * # PYCHOK __all__
498 from pygeodesy.geodesicx import * # PYCHOK __all__
499 from pygeodesy.geodsolve import * # PYCHOK __all__
500 from pygeodesy.geohash import Geohash, GeohashError, \
501 Neighbors8Dict, Resolutions2Tuple # PYCHOK lazily
502 from pygeodesy.geoids import * # PYCHOK __all__
503 from pygeodesy.hausdorff import * # PYCHOK __all__
504 from pygeodesy.heights import * # PYCHOK __all__
505 from pygeodesy.interns import * # PYCHOK __all__
506 from pygeodesy.iters import * # PYCHOK __all__
507 from pygeodesy.karney import * # PYCHOK __all__
508 from pygeodesy.ktm import * # PYCHOK __all__
509# from pygeodesy.latlonBase import * # PYCHOK __(_)__
510 from pygeodesy.lazily import * # PYCHOK __all__
511 from pygeodesy.lcc import * # PYCHOK __all__
512 from pygeodesy.ltp import * # PYCHOK __all__
513 from pygeodesy.ltpTuples import * # PYCHOK __all__
514 from pygeodesy.mgrs import * # PYCHOK __all__
515 from pygeodesy.named import * # PYCHOK __all__
516 from pygeodesy.namedTuples import * # PYCHOK __all__
517# from pygeodesy.nvectorBase import * # PYCHOK __(_)__
518 from pygeodesy.osgr import * # PYCHOK __all__
519 from pygeodesy.points import * # PYCHOK __all__
520 from pygeodesy.props import * # PYCHOK __all__
521 from pygeodesy.resections import * # PYCHOK __all__
522 from pygeodesy.rhumbsolve import * # PYCHOK __all__
523 from pygeodesy.rhumbx import * # PYCHOK __all__
524 from pygeodesy.simplify import * # PYCHOK __all__
525# from pygeodesy.sphericalBase import * # PYCHOK __(_)__
526# from pygeodesy.sphericalNvector import * # PYCHOK __(_)__
527# from pygeodesy.sphericalTrigonometry import * # PYCHOK __(_)__
528# from pygeodesy.solveBase import * # PYCHOK __(_)__
529 from pygeodesy.streprs import * # PYCHOK __all__
530 from pygeodesy.trf import * # PYCHOK __all__
531 from pygeodesy.triaxials import * # PYCHOK __all__
532 from pygeodesy.units import * # PYCHOK __all__
533 from pygeodesy.unitsBase import * # PYCHOK __all__
534 from pygeodesy.ups import * # PYCHOK __all__
535 from pygeodesy.utily import * # PYCHOK __all__
536 from pygeodesy.utm import * # PYCHOK __all__
537 from pygeodesy.utmups import * # PYCHOK __all__
538# from pygeodesy.utmupsBase import * # PYCHOK __(_)__
539 from pygeodesy.vector2d import * # PYCHOK __all__
540 from pygeodesy.vector3d import * # PYCHOK __all__
541# from pygeodesy.vector3dBase import * # PYCHOK __(_)__
542 from pygeodesy.webmercator import * # PYCHOK __all__
543 from pygeodesy.wgrs import Georef, WGRSError # PYCHOK lazily
545 def _all(globalocals):
546 from pygeodesy.interns import NN as _NN, _attribute_, _COMMASPACE_, \
547 _DOT_, _module_, _s_ # PYCHOK expected
548 from pygeodesy.streprs import Fmt as _Fmt # PYCHOK expected
549 # collect all public module and attribute names and check
550 # that modules are imported from this package, 'pygeodesy'
551 # (but the latter only when not bundled with PyInstaller or
552 # Py2Exe, since the file-layout is different. Courtesy of
553 # GilderGeek<https://GitHub.com/mrJean1/PyGeodesy/issues/31>)
554 ns = list(lazily._ALL_INIT)
555# XXX ps = () if _isfrozen else set([_pygeodesy_] + __name__.split(_DOT_))
556 for mod, attrs in lazily._ALL_LAZY.enums():
557 if mod not in globalocals:
558 t = _DOT_(_pygeodesy_, mod)
559 raise ImportError('missing %s%s: %s' % (_module_, _NN, t))
560 ns.append(mod)
561 # check that all other public attributes do exist
562 if attrs and isinstance(attrs, tuple):
563 t = tuple(a for a in attrs if a not in globalocals)
564 if t:
565 s = _Fmt.SQUARE(_s_, len(t)) if len(t) > 1 else _NN
566 t = _COMMASPACE_.join(_DOT_(_pygeodesy_, mod, a) for a in t)
567 raise ImportError('missing %s%s: %s' % (_attribute_, s, t))
568 ns.extend(attrs)
569# XXX if ps: # check that mod is a _pygeodesy_ module
570# XXX m = globalocals[mod] # assert(m.__name__ == mod)
571# XXX f = getattr(m, '__file__', _NN)
572# XXX d = dirname(abspath(f)) if f else pygeodesy_abspath
573# XXX p = getattr(m, '__package__', _NN) or _pygeodesy_
574# XXX if p not in ps or d != pygeodesy_abspath:
575# XXX raise ImportError('foreign module: %s from %r' % (_DOT_(p, mod), f or p))
576 return tuple(set(ns)) # remove duplicates
578 __all__ = _all(globals()) # or locals()
579else:
580 __all__ = ()
581 _init__all__ = False
583from pygeodesy.interns import _DOT_ # PYCHOK import
584__version__ = '23.04.21'
585# see setup.py for similar logic
586version = _DOT_.join(map(str, map(int, __version__.split(_DOT_))))
588# XXX del ellipsoidalBase, ellipsoidalBaseDI, sphericalBase, utmupsBase # PYCHOK expected
589del abspath, basename, dirname, _DOT_, _lazy_import2, sys
591# **) MIT License
592#
593# Copyright (C) 2016-2023 -- mrJean1 at Gmail -- All Rights Reserved.
594#
595# Permission is hereby granted, free of charge, to any person obtaining a
596# copy of this software and associated documentation files (the "Software"),
597# to deal in the Software without restriction, including without limitation
598# the rights to use, copy, modify, merge, publish, distribute, sublicense,
599# and/or sell copies of the Software, and to permit persons to whom the
600# Software is furnished to do so, subject to the following conditions:
601#
602# The above copyright notice and this permission notice shall be included
603# in all copies or substantial portions of the Software.
604#
605# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
606# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
607# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
608# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
609# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
610# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
611# OTHER DEALINGS IN THE SOFTWARE.