Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

 

# -*- coding: utf-8 -*- 

 

u'''A pure Python implementation of geodesy tools for various ellipsoidal and spherical 

earth models using precision trigonometric, vector-based, exact, elliptic and approximate 

methods for geodetic (lat-/longitude) and geocentric (U{ECEF<https://WikiPedia.org/wiki/ECEF>} 

cartesian) coordinates. 

 

Transcoded from U{JavaScript originals<https://GitHub.com/ChrisVeness/geodesy>} by I{Chris Veness 

(C) 2005-2019} and from several U{C++ classes<https://GeographicLib.SourceForge.io/html/annotated.html>} 

by I{Charles F.F. Karney (C) 2008-2021} and published under the same U{MIT License 

<https://OpenSource.org/licenses/MIT>}**. 

 

There are four modules for ellipsoidal earth models, C{ellipsoidalExact}, C{-Karney}, 

C{-Vincenty} and C{-Nvector} and two for spherical ones, C{sphericalTrigonometry} 

and C{-Nvector}. Each module provides a geodetic B{C{LatLon}} and a geocentric 

B{C{Cartesian}} class with methods and functions to compute distance, surface area, 

perimeter, initial and final bearing, intermediate and nearest points, circle 

intersections, path intersections, 3-point resections, trilateration (by intersection, 

by overlap and in 3d), conversions and unrolling, among other things. For more information 

and further details see the U{documentation<https://mrJean1.GitHub.io/PyGeodesy>}, the 

descriptions of U{Latitude/Longitude<https://www.Movable-Type.co.UK/scripts/latlong.html>}, 

U{Vincenty<https://www.Movable-Type.co.UK/scripts/latlong-vincenty.html>} and 

U{Vector-based<https://www.Movable-Type.co.UK/scripts/latlong-vectors.html>} geodesy, 

the original U{JavaScript source<https://GitHub.com/ChrisVeness/geodesy>} or 

U{docs<https://www.Movable-Type.co.UK/scripts/geodesy/docs>} and I{Karney}'s Python 

U{geographiclib<https://PyPI.org/project/geographiclib>} and U{C++ GeographicLib 

<https://GeographicLib.SourceForge.io/html/index.html>}. 

 

Also included are modules for conversions to and from U{Cassini-Soldner 

<https://GeographicLib.SourceForge.io/html/classGeographicLib_1_1CassiniSoldner.html>}, 

U{ECEF<https://WikiPedia.org/wiki/ECEF>} (Earth-Centered, Earth-Fixed cartesian), 

U{UPS<https://WikiPedia.org/wiki/Universal_polar_stereographic_coordinate_system>} 

(Universal Polar Stereographic), U{UTM 

<https://www.Movable-Type.co.UK/scripts/latlong-utm-mgrs.html>} (U{Exact 

<https://GeographicLib.SourceForge.io/html/classGeographicLib_1_1TransverseMercatorExact.html>} 

and Universal Transverse Mercator) and U{Web Mercator<https://WikiPedia.org/wiki/Web_Mercator>} 

(Pseudo-Mercator) coordinates, U{MGRS<https://www.Movable-Type.co.UK/scripts/latlong-utm-mgrs.html>} 

(NATO Military Grid Reference System) and U{OSGR 

<https://www.Movable-Type.co.UK/scripts/latlong-os-gridref.html>} (British Ordinance Survery 

Grid Reference) grid references, U{TRF<http://ITRF.ENSG.IGN.Fr>} (Terrestrial Reference Frames) 

and modules to encode and decode U{EPSG<https://EPSG.org>}, U{Geohashes 

<https://www.Movable-Type.co.UK/scripts/geohash.html>}, U{Georefs (WGRS) 

<https://WikiPedia.org/wiki/World_Geographic_Reference_System>} and U{Garefs (GARS) 

<https://WikiPedia.org/wiki/Global_Area_Reference_System>}. 

 

Other modules provide U{Albers equal-area<https://GeographicLib.SourceForge.io/ 

html/classGeographicLib_1_1AlbersEqualArea.html>} projections, U{equidistant 

<https://GeographicLib.SourceForge.io/html/classGeographicLib_1_1AzimuthalEquidistant.html>} 

and other I{azimuthal} projections, Lambert I{conformal conic} projections and 

positions, functions to clip a path or polygon of C{LatLon} points using the 

U{Cohen-Sutherland<https://WikiPedia.org/wiki/Cohen-Sutherland_algorithm>}, the 

U{Liang-Barsky<https://www.CS.Helsinki.FI/group/goa/viewing/leikkaus/intro.html>} 

and the U{Sutherland-Hodgman<https://WikiPedia.org/wiki/Sutherland-Hodgman_algorithm>} 

methods, functions to U{simplify<https://Bost.Ocks.org/mike/simplify>} or linearize a 

path of C{LatLon} points (or a U{NumPy array <https://docs.SciPy.org/doc/numpy/ 

reference/generated/numpy.array.html>}), including implementations of the 

U{Ramer-Douglas-Peucker<https://WikiPedia.org/wiki/Ramer-Douglas-Peucker_algorithm>} 

the U{Visvalingam-Whyatt<https://hydra.Hull.ac.UK/resources/hull:8338>} and the 

U{Reumann-Witkam<https://psimpl.SourceForge.net/reumann-witkam.html>} algorithms 

and modified versions of the former. Other classes U{interpolate 

<https://docs.SciPy.org/doc/scipy/reference/interpolate.html>} the L{height<pygeodesy.heights>} 

of C{LatLon} points and L{Geoid<pygeodesy.geoids>} models or compute various U{Fréchet 

<https://WikiPedia.org/wiki/Frechet_distance>} or U{Hausdorff 

<https://WikiPedia.org/wiki/Hausdorff_distance>} distances. 

 

Installation 

============ 

 

To install PyGeodesy, type C{pip install PyGeodesy} or C{easy_install PyGeodesy} in a terminal 

or command window. 

 

Alternatively, download C{PyGeodesy-yy.m.d.zip} from U{PyPI<https://PyPI.org/project/PyGeodesy>} 

or U{GitHub<https://GitHub.com/mrJean1/PyGeodesy>}, C{unzip} the downloaded file, C{cd} to 

directory C{Pygeodesy-yy.m.d} and type C{python[3] setup.py install}. 

 

To run all PyGeodesy tests, type C{python[3] setup.py test} or type C{python[3] 

test/run.py} or type C{python[3] test/unitTestSuite.py} before or after installation. 

 

Dependencies 

============ 

 

Installation of I{Karney}'s Python package U{geographiclib<https://PyPI.org/project/geographiclib>} 

is optional, but required to use modules L{ellipsoidalKarney} and L{css}, L{azimuthal} classes 

L{EquidistantKarney} and L{GnomonicKarney} and the L{HeightIDWkarney} interpolator. 

 

Both U{numpy<https://PyPI.org/project/numpy>} and U{scipy<https://PyPI.org/project/scipy>} must be 

installed for most L{Geoid...<pygeodesy.geoids>} and L{Height...<pygeodesy.heights>} interpolators, 

except L{GeoidKarney} and the L{HeightIDW...<pygeodesy.heights>} ones. 

 

Functions and C{LatLon} methods L{circin6}, L{circum3}, L{circum4_}, L{soddy4}, L{trilaterate3d2} 

and C{trilaterate5} require U{numpy<https://PyPI.org/project/numpy>}. 

 

Modules L{ellipsoidalGeodSolve} and L{geodsolve} and L{azimuthal} classes L{EquidistantGeodSolve} 

and L{GnomonicGeodSolve} depend on I{Karney}'s C++ utility U{GeodSolve 

<https://GeographicLib.SourceForge.io/html/GeodSolve.1.html>} to be executable. 

 

Documentation 

============= 

 

In addition to the C{pygeodesy} package, the U{PyGeodesy<https://PyPI.org/project/PyGeodesy>} 

U{distribution files<https://GitHub.com/mrJean1/PyGeodesy/tree/master/dist>} contain the tests, 

the test results (on macOS only) and the complete U{documentation<https://mrJean1.GitHub.io/PyGeodesy>} 

(generated by U{Epydoc<https://PyPI.org/project/epydoc>} using command line: C{epydoc --html 

--no-private --no-source --name=PyGeodesy --url=... -v pygeodesy}). 

 

Tests 

===== 

 

The tests have been run with Python 3.10.4 (with U{geographiclib<https://PyPI.org/project/geographiclib>} 

2.0), Python 3.9.6 (with U{numpy<https://PyPI.org/project/numpy>} 1.21.2), Python 3.8.10 (with U{geographiclib 

<https://PyPI.org/project/geographiclib>} 1.52, U{GeodSolve<https://GeographicLib.SourceForge.io/html/GeodSolve.1.html>} 

1.51, U{numpy<https://PyPI.org/project/numpy>} 1.19.2 and U{scipy<https://PyPI.org/project/scipy>} 1.5.2) and Python 

2.7.18 (with U{GeodSolve<https://GeographicLib.SourceForge.io/html/GeodSolve.1.html>} 1.51, all on macOS 12.3.1 

Monterey and in 64-bit only. The tests are run with and without C{lazy import} for Python 3 and with command line 

option C{-W always} and env var C{PYGEODESY_WARNINGS=on} for all Python versions. The results of only those tests 

are included in the distribution files. 

 

Python 3.10.4 and 3.9.6 run on Apple Silicon (C{arm64} I{natively}), all other Python versions run on Intel 

(C{x86_64}) or Intel I{emulation} (C{"arm64_x86_64"}, see function L{pygeodesy.machine}). 

 

Test coverage has been measured with U{coverage<https://PyPI.org/project/coverage>} 4.5.4 using Python 3.10.4 (with 

U{geographiclib<https://PyPI.org/project/geographiclib>} 2.0), Python 3.9.6 (with U{numpy<https://PyPI.org/project/numpy>} 

1.21.2), Python 3.8.10 (with U{geographiclib<https://PyPI.org/project/geographiclib>} 1.52, U{numpy 

<https://PyPI.org/project/numpy>} 1.19.2 and U{scipy<https://PyPI.org/project/scipy>} 1.5.2) and Python 2.7.18 

(U{GeodSolve<https://GeographicLib.SourceForge.io/html/GeodSolve.1.html>}). The complete coverage report in HTML and 

a PDF summary are included in the distribution files. 

 

The tests also ran with Python 3.10.4 or 3.9.9 (and U{geographiclib<https://PyPI.org/project/geographiclib>} 

1.52) on U{Debian 11<https://Cirrus-CI.com/github/mrJean1/PyGeodesy/master>} in 64-bit only and with Python 

3.9.6, 3.8.0 and 2.7.17 (all with U{geographiclib<https://PyPI.org/project/geographiclib>} 1.52) on 

U{Windows Server 2012R2<https://CI.AppVeyor.com/project/mrJean1/pygeodesy>} in 64- and/or 32-bit. 

 

A single-File and single-Directory application with C{pygeodesy} has been bundled using U{PyInstaller 

<https://PyPI.org/project/pyinstaller>} 3.4 and 64-bit Python 3.7.3 on macOS 10.13.6 High Sierra. 

 

Previously, the tests were run with Python 3.10.1-3, 3.9.1, 3.8.7, 3.7.1, 2.7.15, U{PyPy<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 

<https://PyPI.org/project/geographiclib>} 1.52 and U{numpy<https://PyPI.org/project/numpy>} 1.16.3, 

1.16.4, 1.16.6, 1.19.0, 1.19.4 or 1.19.5) 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, 3.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, 1.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<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) and U{Intel-Python 

<https://software.Intel.com/en-us/distribution-for-python>} 3.5.3 (and U{numpy 

<https://PyPI.org/project/numpy>} 1.11.3) on macOS 12.1-2.1 Monterey, 11.0-5.2-6.1 Big Sur (aka 10.16), 

10.15.3, 10.15.5-7 Catalina, macOS 10.14 Mojave, macOS 10.13.6 High Sierra, macOS 10.12 Sierra, MacOS 

X 10.11 El Capitan and/or MacOS X 10.10 Yosemite, with U{Pythonista3.2<https://OMZ-Software.com/pythonista>} 

(with geographiclib 1.50 or 1.49 and numpy 1.8.0) on iOS 14.4.2, 11.4.1, 12.0-3 on iPad4, iPhone6 and/or 

iPhone10, with U{Pythonista 3.1<https://OMZ-Software.com/pythonista>} on iOS 10.3.3, 11.0.3, 11.1.2 

and 11.3 on iPad4, all in 64-bit only and with 32-bit Python 2.7.14 on Windows 10 Pro and with 32-bit 

Python 2.6.6 on Windows XP SP3. 

 

Notes 

===== 

 

All Python source code has been statically U{checked 

<https://GitHub.com/ActiveState/code/tree/master/recipes/Python/546532_PyChecker_postprocessor>} 

with U{PyChecker<https://PyPI.org/project/pychecker>}, U{PyFlakes<https://PyPI.org/project/pyflakes>}, 

U{PyCodeStyle<https://PyPI.org/project/pycodestyle>} (formerly Pep8) and U{McCabe 

<https://PyPI.org/project/mccabe>} using Python 2.7.18 and with U{Flake8<https://PyPI.org/project/flake8>} 

using Python 3.10.4, both in 64-bit on macOS 12.3.1 Monterey. 

 

For a summary of all I{Karney}-based functionality in C{pygeodesy}, see module U{karney 

<https://mrJean1.GitHub.io/PyGeodesy/docs/pygeodesy.karney-module.html>}. 

 

In 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 

characters and if so, I{not} C{unicode}. 

 

Some function and method names differ from the JavaScript version. In such cases documentation tag 

B{JS name:} shows the original JavaScript name. 

 

Env vars 

======== 

 

The following environment variables are observed by C{PyGeodesy}: 

 

- C{PYGEODESY_EXCEPTION_CHAINING} - see module L{pygeodesy.errors}. 

- C{PYGEODESY_GEODSOLVE} - see module L{pygeodesy.geodsolve}. 

- C{PYGEODESY_LAZY_IMPORT} - see module L{pygeodesy.lazily} and variable L{pygeodesy.isLazy}. 

- C{PYGEODESY_NOTIMPLEMENTED} - __special__ methods return C{NotImplemented} if set to "std". 

 

- C{PYGEODESY_BEARING_STD_REPR} - see method L{pygeodesy.Bearing}C{.__repr__}. 

- C{PYGEODESY_BOOL_STD_REPR} - see method L{pygeodesy.Bool}C{.__repr__}. 

- C{PYGEODESY_DEGREES_STD_REPR} - see method L{pygeodesy.Degrees}C{.__repr__}. 

- C{PYGEODESY_FLOAT_STD_REPR} - see method L{pygeodesy.Float}C{.__repr__}. 

- C{PYGEODESY_INT_STD_REPR} - see method L{pygeodesy.Int}C{.__repr__}. 

- C{PYGEODESY_METER_STD_REPR} - see method L{pygeodesy.Meter}C{.__repr__}. 

- C{PYGEODESY_STR_STD_REPR} - see method L{pygeodesy.Str}C{.__repr__}. 

 

plus during development: 

 

- C{PYGEODESY_FOR_DOCS} - for extended documentation by C{epydoc}. 

- C{PYGEODESY_FSUM_RESIDUAL} - see module L{pygeodesy.fsums} and class L{pygeodesy.Fsum}. 

- C{PYGEODESY_GEOGRAPHICLIB} - see module L{pygeodesy.karney}. 

- C{PYGEODESY_WARNINGS} - see module L{pygeodesy.props} and function L{pygeodesy.DeprecationWarnings}. 

- C{PYTHONDEVMODE} - see modules L{pygeodesy.errors} and L{pygeodesy.props}. 

 

License 

======= 

 

**) U{Copyright (C) 2016-2022 -- mrJean1 at Gmail -- All Rights Reserved. 

<https://OpenSource.org/licenses/MIT>} 

 

C{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:} 

 

C{The above copyright notice and this permission notice shall be included 

in all copies or substantial portions of the Software.} 

 

C{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.} 

 

@newfield example: Example, Examples 

@newfield JSname: JS name, JS names 

 

@var EPS: System's M{epsilon} ≈ 2.22044604925e-16 (C{float}). 

@var EPS0: M{EPS**2} ≈ 4.9e-32 for near-zero comparison 

@var EPS02: M{EPS**4} ≈ 2.4e-63 for near-zero squared comparison 

@var EPS1: M{1 - EPS} ≈ 0.9999999999999998 (C{float}). 

@var EPS1_2: M{1 - EPS_2} DEPRECATED, do not use. 

@var EPS2: M{EPS * 2} ≈ 4.440892098501e-16 (C{float}). 

@var EPS_2: M{EPS / 2} ≈ 1.110223024625e-16 (C{float}). 

@var EPS4: M{EPS * 4} ≈ 8.881784197001e-16 (C{float}). 

 

@var F_D: Format degrees as unsigned "deg°" with symbol, plus compass point suffix C{N, S, E} or C{W} (C{str}). 

@var F_DM: Format degrees as unsigned "deg°min′" with symbols, plus suffix (C{str}). 

@var F_DMS: Format degrees as unsigned "deg°min′sec″" with symbols, plus suffix (C{str}). 

@var F_DEG: Format degrees as unsigned "[D]DD" I{without} symbol, plus suffix (C{str}). 

@var F_MIN: Format degrees as unsigned "[D]DDMM" I{without} symbols, plus suffix (C{str}). 

@var F_SEC: Format degrees as unsigned "[D]DDMMSS" I{without} symbols, plus suffix (C{str}). 

@var F_D60: Format degrees as unsigned "[D]DD.MMSS" C{sexagecimal} I{without} symbols, plus suffix (C{str}). 

@var F__E: Format degrees as unsigned "%E" I{without} symbols, plus suffix (C{str}). 

@var F__F: Format degrees as unsigned "%F" I{without} symbols, plus suffix (C{str}). 

@var F__G: Format degrees as unsigned "%G" I{without} symbols, plus suffix (C{str}). 

@var F_RAD: Convert degrees to radians and format as unsigned "RR" with symbol, plus suffix (C{str}). 

 

@var F_D_: Format degrees as signed "-/deg°" with symbol, I{without} suffix (C{str}). 

@var F_DM_: Format degrees as signed "-/deg°min′" with symbols, I{without} suffix (C{str}). 

@var F_DMS_: Format degrees as signed "-/deg°min′sec″" with symbols, I{without} suffix (C{str}). 

@var F_DEG_: Format degrees as signed "-/[D]DD" I{without} symbol, I{without} suffix (C{str}). 

@var F_MIN_: Format degrees as signed "-/[D]DDMM" I{without} symbols, I{without} suffix (C{str}). 

@var F_SEC_: Format degrees as signed "-/[D]DDMMSS" I{without} symbols, I{without} suffix (C{str}). 

@var F_D60_: Format degrees as signed "-/[D]DD.MMSS" C{sexagecimal} I{without} symbols, I{without} suffix (C{str}). 

@var F__E_: Format degrees as signed "-/%E" I{without} symbols, I{without} suffix (C{str}). 

@var F__F_: Format degrees as signed "-/%F" I{without} symbols, I{without} suffix (C{str}). 

@var F__G_: Format degrees as signed "-/%G" I{without} symbols, I{without} suffix (C{str}). 

@var F_RAD_: Convert degrees to radians and format as signed "-/RR" I{without} symbol, I{without} suffix (C{str}). 

 

@var F_D__: Format degrees as signed "-/+deg°" with symbol, I{without} suffix (C{str}). 

@var F_DM__: Format degrees as signed "-/+deg°min′" with symbols, I{without} suffix (C{str}). 

@var F_DMS__: Format degrees as signed "-/+deg°min′sec″" with symbols, I{without} suffix (C{str}). 

@var F_DEG__: Format degrees as signed "-/+[D]DD" I{without} symbol, I{without} suffix (C{str}). 

@var F_MIN__: Format degrees as signed "-/+[D]DDMM" I{without} symbols, without suffix (C{str}). 

@var F_SEC__: Format degrees as signed "-/+[D]DDMMSS" I{without} symbols, I{without} suffix (C{str}). 

@var F_D60__: Format degrees as signed "-/+[D]DD.MMSS" C{sexagecimal} I{without} symbols, I{without} suffix (C{str}). 

@var F__E__: Format degrees as signed "-/+%E" I{without} symbols, I{without} suffix (C{str}). 

@var F__F__: Format degrees as signed "-/+%F" I{without} symbols, I{without} suffix (C{str}). 

@var F__G__: Format degrees as signed "-/+%G" I{without} symbols, I{without} suffix (C{str}). 

@var F_RAD__: Convert degrees to radians and format as signed "-/+RR" I{without} symbol, I{without} suffix (C{str}). 

 

@var DIG: System's M{float decimal digits} = 15 (C{int}). 

@var INF: Infinity (C{float}), see L{NINF} and functions L{pygeodesy.isinf}, L{pygeodesy.isfinite}. 

@var INT0: C{int(0)}, missing Z-components, C{if z is B{INT0}}, see functions L{pygeodesy.isint0}, L{pygeodesy.meeus2} 

@var MANT_DIG: System's M{float mantissa bits} = 53 (C{int}). 

@var MANTIS: DEPRECATED, use C{MANT_DIG}. 

@var MAX: System's M{float max} ≈ 1.798e+308 (C{float}). 

@var MIN: System's M{float min} ≈ 2.225e-308 (C{float}). 

@var NAN: Not-A-Number (C{float}), see function L{pygeodesy.isnan}. 

@var NEG0: Negative 0.0 (C{float}), see function L{pygeodesy.isneg0}. 

@var NINF: Negative infinity (C{float}), see L{INF}. 

@var NN: Empty (C{str}), U{I{Nomen Nescio}<https://Wiktionary.org/wiki/N.N.>}. 

@var OK: DEPRECATED, do not use. 

 

@var PI: Constant M{math.pi} (C{float}). 

@var PI2: Two PI, M{PI * 2}, aka I{Tau} (C{float}). 

@var PI_2: Half PI, M{PI / 2} (C{float}). 

@var PI3: Three PI, M{PI * 3} (C{float}). 

@var PI3_2: One and a half PI, M{PI * 3 / 2} (C{float}). 

@var PI4: Four PI, M{PI * 4} (C{float}). 

@var PI_4: Quarter PI, M{PI / 4} (C{float}). 

 

@var R_M: Mean (spherical) earth radius (C{meter}). 

@var R_MA: Equatorial earth radius (C{meter}), WGS84, EPSG:3785. 

@var R_MB: Polar earth radius (C{meter}), WGS84, EPSG:3785. 

@var R_KM: Mean (spherical) earth radius (C{km}, kilometer). 

@var R_NM: Mean (spherical) earth radius (C{NM}, nautical miles). 

@var R_SM: Mean (spherical) earth radius (C{SM}, statute miles). 

@var R_FM: Former FAI-Sphere earth radius (C{meter}). 

@var R_GM: Average earth radius, distance to geoid surface (C{meter}) 

@var R_VM: Aviation/Navigation earth radius (C{meter}). 

 

@var S_DEG: Degrees symbol, default C{"°"} 

@var S_MIN: Minutes symbol, default C{"′"} aka I{PRIME} 

@var S_SEC: Seconds symbol, default C{"″"} aka I{DOUBLE_PRIME} 

@var S_RAD: Radians symbol, default C{""} aka C{NN} 

@var S_SEP: Separator between C{deg°|min′|sec″|suffix}, default C{""} aka C{NN} 

 

@var Conics: Registered, predefined conics (C{enum-like}). 

@var Datums: Registered, predefined datums (C{enum-like}). 

@var Ellipsoids: Registered, predefined ellipsoids (C{enum-like}). 

@var RefFrames: Registered, predefined reference frames (C{enum-like}). 

@var Transforms: Registered, predefined transforms (C{enum-like}). 

 

@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. 

 

@var pygeodesy_abspath: Fully qualified C{pygeodesy} directory name (C{str}). 

 

@var version: Normalized C{PyGeodesy} version (C{str}). 

''' 

 

from os.path import abspath, basename, dirname 

import sys 

 

# <https://PyInstaller.ReadTheDocs.io/en/stable/runtime-information.html> 

_isfrozen = getattr(sys, 'frozen', False) 

pygeodesy_abspath = dirname(abspath(__file__)) # sys._MEIPASS + '/pygeodesy' 

_pygeodesy_ = __package__ or basename(pygeodesy_abspath) 

 

if _isfrozen: # avoid lazy import 

_lazy_import2 = None 

else: 

# setting __path__ should ... 

__path__ = [pygeodesy_abspath] 

try: # ... make this import work, ... 

import pygeodesy.lazily as _ 

except ImportError: # ... if it doesn't, extend 

# sys.path to include this very directory such 

# that all public and private sub-modules can 

# be imported (and checked by PyChecker, etc.) 

sys.path.insert(0, pygeodesy_abspath) # XXX __path__[0] 

 

try: 

# lazily requires Python 3.7+, see lazily.__doc__ 

from pygeodesy.lazily import LazyImportError, _lazy_import2 # PYCHOK expected 

_, __getattr__ = _lazy_import2(_pygeodesy_) # PYCHOK expected 

 

except (ImportError, LazyImportError, NotImplementedError): 

_lazy_import2 = None 

 

if not _lazy_import2: # import and set __all__ 

 

# import all public modules and export as such 

import pygeodesy.albers as albers # PYCHOK exported 

import pygeodesy.azimuthal as azimuthal # PYCHOK exported 

import pygeodesy.deprecated.bases as bases # PYCHOK DEPRECATED 

import pygeodesy.basics as basics # PYCHOK exported 

import pygeodesy.cartesianBase as cartesianBase # PYCHOK exported 

import pygeodesy.clipy as clipy # PYCHOK exported 

import pygeodesy.css as css # PYCHOK exported 

import pygeodesy.deprecated.datum as datum # PYCHOK DEPRECATED 

import pygeodesy.datums as datums # PYCHOK exported 

import pygeodesy.deprecated as deprecated # PYCHOK exported 

import pygeodesy.dms as dms # PYCHOK exported 

import pygeodesy.ecef as ecef # PYCHOK exported 

import pygeodesy.elevations as elevations # PYCHOK exported 

import pygeodesy.ellipsoidalBase as ellipsoidalBase # PYCHOK exported 

import pygeodesy.ellipsoidalBaseDI as ellipsoidalBaseDI # PYCHOK exported 

import pygeodesy.ellipsoidalExact as ellipsoidalExact # PYCHOK exported 

import pygeodesy.ellipsoidalGeodSolve as ellipsoidalGeodSolve # PYCHOK exported 

import pygeodesy.ellipsoidalKarney as ellipsoidalKarney # PYCHOK exported 

import pygeodesy.ellipsoidalNvector as ellipsoidalNvector # PYCHOK exported 

import pygeodesy.ellipsoidalVincenty as ellipsoidalVincenty # PYCHOK exported 

import pygeodesy.ellipsoids as ellipsoids # PYCHOK exported 

import pygeodesy.elliptic as elliptic # PYCHOK exported 

import pygeodesy.epsg as epsg # PYCHOK exported 

import pygeodesy.etm as etm # PYCHOK exported 

import pygeodesy.errors as errors # PYCHOK exported 

import pygeodesy.fmath as fmath # PYCHOK exported 

import pygeodesy.formy as formy # PYCHOK exported 

import pygeodesy.frechet as frechet # PYCHOK exported 

import pygeodesy.fstats as fstats # PYCHOK exported 

import pygeodesy.fsums as fsums # PYCHOK exported 

import pygeodesy.gars as gars # PYCHOK exported 

import pygeodesy.geodesicx as geodesicx # PYCHOK exported 

import pygeodesy.geodsolve as geodsolve # PYCHOK exported 

import pygeodesy.geohash as geohash # PYCHOK exported 

import pygeodesy.geoids as geoids # PYCHOK exported 

import pygeodesy.hausdorff as hausdorff # PYCHOK exported 

import pygeodesy.heights as heights # PYCHOK exported 

import pygeodesy.interns as interns # PYCHOK exported 

import pygeodesy.iters as iters # PYCHOK exported 

import pygeodesy.karney as karney # PYCHOK exported 

import pygeodesy.latlonBase as latlonBase # PYCHOK exported 

import pygeodesy.lazily as lazily # PYCHOK exported 

import pygeodesy.lcc as lcc # PYCHOK exported 

import pygeodesy.ltp as ltp # PYCHOK exported 

import pygeodesy.ltpTuples as ltpTuples # PYCHOK exported 

import pygeodesy.mgrs as mgrs # PYCHOK exported 

import pygeodesy.named as named # PYCHOK exported 

import pygeodesy.namedTuples as namedTuples # PYCHOK exported 

import pygeodesy.nvectorBase as nvectorBase # PYCHOK exported 

import pygeodesy.deprecated.nvector as nvector # PYCHOK DEPRECATED 

import pygeodesy.osgr as osgr # PYCHOK exported 

import pygeodesy.points as points # PYCHOK exported 

import pygeodesy.props as props # PYCHOK exported 

import pygeodesy.resections as resections # PYCHOK exported 

import pygeodesy.simplify as simplify # PYCHOK exported 

import pygeodesy.sphericalBase as sphericalBase # PYCHOK exported 

import pygeodesy.sphericalNvector as sphericalNvector # PYCHOK exported 

import pygeodesy.sphericalTrigonometry as sphericalTrigonometry # PYCHOK exported 

import pygeodesy.streprs as streprs # PYCHOK exported 

import pygeodesy.trf as trf # PYCHOK exported 

import pygeodesy.units as units # PYCHOK exported 

import pygeodesy.ups as ups # PYCHOK exported 

import pygeodesy.utily as utily # PYCHOK exported 

import pygeodesy.utm as utm # PYCHOK exported 

import pygeodesy.utmups as utmups # PYCHOK exported 

import pygeodesy.utmupsBase as utmupsBase # PYCHOK exported 

import pygeodesy.vector2d as vector2d # PYCHOK exported 

import pygeodesy.vector3d as vector3d # PYCHOK exported 

import pygeodesy.vector3dBase as vector3dBase # PYCHOK exported 

import pygeodesy.webmercator as webmercator # PYCHOK exported 

import pygeodesy.wgrs as wgrs # PYCHOK exported 

 

# lift all public classes, constants, functions, etc. but ONLY 

# from the following modules ... (see also David Beazley's 

# talk <https://DaBeaz.com/modulepackage/index.html>) ... BUT 

# NOT modules ellipsoidal*, epsg, gars, geohash, spherical*, 

# vector and wgrs ... in order keep those as modules ONLY 

from pygeodesy.albers import * # PYCHOK __all__ 

from pygeodesy.azimuthal import * # PYCHOK __all__ 

from pygeodesy.basics import * # PYCHOK __all__ 

# from pygeodesy.cartesianBase import * # PYCHOK __(_)__ 

from pygeodesy.clipy import * # PYCHOK __all__ 

from pygeodesy.css import * # PYCHOK __all__ 

from pygeodesy.datums import * # PYCHOK __all__ 

from pygeodesy.deprecated import * # PYCHOK __all__ 

from pygeodesy.dms import * # PYCHOK __all__ 

from pygeodesy.ecef import * # PYCHOK __all__ 

from pygeodesy.elevations import * # PYCHOK __all__ 

# from pygeodesy.ellipsoidalBase import * # PYCHOK __(_)__ 

# from pygeodesy.ellipsoidalBaseDI import * # PYCHOK __(_)__ 

# from pygeodesy.ellipsoidalExact import * # PYCHOK __(_)__ 

# from pygeodesy.ellipsoidalGeodSolve import * # PYCHOK __(_)__ 

# from pygeodesy.ellipsoidalKarney import * # PYCHOK __(_)__ 

# from pygeodesy.ellipsoidalNvector import * # PYCHOK __(_)__ 

from pygeodesy.ellipsoidalVincenty import VincentyError # PYCHOK lazily 

from pygeodesy.ellipsoids import * # PYCHOK __all__ 

from pygeodesy.elliptic import * # PYCHOK __all__ 

from pygeodesy.epsg import Epsg, EPSGError # PYCHOK lazily 

from pygeodesy.etm import * # PYCHOK __all__ 

from pygeodesy.errors import * # PYCHOK __all__ 

from pygeodesy.fmath import * # PYCHOK __all__ 

from pygeodesy.formy import * # PYCHOK __all__ 

from pygeodesy.frechet import * # PYCHOK __all__ 

from pygeodesy.fstats import * # PYCHOK __all__ 

from pygeodesy.fsums import * # PYCHOK __all__ 

from pygeodesy.gars import Garef, GARSError # PYCHOK lazily 

from pygeodesy.geodesicx import * # PYCHOK __all__ 

from pygeodesy.geodsolve import * # PYCHOK __all__ 

from pygeodesy.geohash import Geohash, GeohashError, \ 

Neighbors8Dict, Resolutions2Tuple # PYCHOK lazily 

from pygeodesy.geoids import * # PYCHOK __all__ 

from pygeodesy.hausdorff import * # PYCHOK __all__ 

from pygeodesy.heights import * # PYCHOK __all__ 

from pygeodesy.interns import * # PYCHOK __all__ 

from pygeodesy.iters import * # PYCHOK __all__ 

from pygeodesy.karney import * # PYCHOK __all__ 

# from pygeodesy.latlonBase import * # PYCHOK __(_)__ 

from pygeodesy.lazily import * # PYCHOK __all__ 

from pygeodesy.lcc import * # PYCHOK __all__ 

from pygeodesy.ltp import * # PYCHOK __all__ 

from pygeodesy.ltpTuples import * # PYCHOK __all__ 

from pygeodesy.mgrs import * # PYCHOK __all__ 

from pygeodesy.named import * # PYCHOK __all__ 

from pygeodesy.namedTuples import * # PYCHOK __all__ 

# from pygeodesy.nvectorBase import * # PYCHOK __(_)__ 

from pygeodesy.osgr import * # PYCHOK __all__ 

from pygeodesy.points import * # PYCHOK __all__ 

from pygeodesy.props import * # PYCHOK __all__ 

from pygeodesy.resections import * # PYCHOK __all__ 

from pygeodesy.simplify import * # PYCHOK __all__ 

# from pygeodesy.sphericalBase import * # PYCHOK __(_)__ 

# from pygeodesy.sphericalNvector import * # PYCHOK __(_)__ 

# from pygeodesy.sphericalTrigonometry import * # PYCHOK __(_)__ 

from pygeodesy.streprs import * # PYCHOK __all__ 

from pygeodesy.trf import * # PYCHOK __all__ 

from pygeodesy.units import * # PYCHOK __all__ 

from pygeodesy.ups import * # PYCHOK __all__ 

from pygeodesy.utily import * # PYCHOK __all__ 

from pygeodesy.utm import * # PYCHOK __all__ 

from pygeodesy.utmups import * # PYCHOK __all__ 

# from pygeodesy.utmupsBase import * # PYCHOK __(_)__ 

from pygeodesy.vector2d import * # PYCHOK __all__ 

from pygeodesy.vector3d import * # PYCHOK __all__ 

# from pygeodesy.vector3dBase import * # PYCHOK __(_)__ 

from pygeodesy.webmercator import * # PYCHOK __all__ 

from pygeodesy.wgrs import Georef, WGRSError # PYCHOK lazily 

 

def _all(globalocals): 

from pygeodesy.interns import NN as _NN, _attribute_, _COMMASPACE_, \ 

_DOT_, _module_, _s_ # PYCHOK expected 

from pygeodesy.streprs import Fmt as _Fmt # PYCHOK expected 

# collect all public module and attribute names and check 

# that modules are imported from this package, 'pygeodesy' 

# (but the latter only when not bundled with PyInstaller or 

# Py2Exe, since the file-layout is different. Courtesy of 

# GilderGeek<https://GitHub.com/mrJean1/PyGeodesy/issues/31>) 

ns = list(lazily._ALL_INIT) 

# XXX ps = () if _isfrozen else set([_pygeodesy_] + __name__.split(_DOT_)) 

for mod, attrs in lazily._ALL_LAZY.enums(): 

if mod not in globalocals: 

t = _DOT_(_pygeodesy_, mod) 

raise ImportError('missing %s%s: %s' % (_module_, _NN, t)) 

ns.append(mod) 

# check that all other public attributes do exist 

if attrs and isinstance(attrs, tuple): 

t = tuple(a for a in attrs if a not in globalocals) 

if t: 

s = _Fmt.SQUARE(_s_, len(t)) if len(t) > 1 else _NN 

t = _COMMASPACE_.join(_DOT_(_pygeodesy_, mod, a) for a in t) 

raise ImportError('missing %s%s: %s' % (_attribute_, s, t)) 

ns.extend(attrs) 

# XXX if ps: # check that mod is a _pygeodesy_ module 

# XXX m = globalocals[mod] # assert(m.__name__ == mod) 

# XXX f = getattr(m, '__file__', _NN) 

# XXX d = dirname(abspath(f)) if f else pygeodesy_abspath 

# XXX p = getattr(m, '__package__', _NN) or _pygeodesy_ 

# XXX if p not in ps or d != pygeodesy_abspath: 

# XXX raise ImportError('foreign module: %s from %r' % (_DOT_(p, mod), f or p)) 

return tuple(set(ns)) # remove duplicates 

 

__all__ = _all(globals()) # or locals() 

 

from pygeodesy.interns import _DOT_ # PYCHOK import 

__version__ = '22.05.05' 

# see setup.py for similar logic 

version = _DOT_.join(map(str, map(int, __version__.split(_DOT_)))) 

 

# XXX del ellipsoidalBase, ellipsoidalBaseDI, sphericalBase, utmupsBase # PYCHOK expected 

del abspath, basename, dirname, _DOT_, _lazy_import2, sys 

 

# **) MIT License 

# 

# Copyright (C) 2016-2022 -- 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.