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