Refactoring

Modified several modules to simplify old code, handle env variables. etc. Documentation typos and other updates, mostly for consistency.
mrJean1 · Oct 23, 2024 · 5ae437c · 5ae437c
1 parent 8a49592
commit 5ae437c
Show file tree

Hide file tree

Showing 727 changed files with 56,793 additions and 135,033 deletions.
diff --git a/README.rst b/README.rst
@@ -90,12 +90,12 @@ line: ``epydoc --html --no-private --no-source --name=PyGeodesy --url=... -v pyg
 Tests
 =====
 
-The tests ran with Python 3.13.0, 3.12.7 (with geographiclib_ 2.0, numpy_ 2.1.0, scipy_ 1.14.1,
-GeodSolve_ 2.3, IntersectTool_ 2.3 and RhumbSolve_ 2.3), 3.11.5 (with geographiclib_ 2.0, numpy_
-1.24.2 and scipy_ 1.10.1), Python 3.10.8 (with geographiclib_ 2.0, numpy_ 1.23.3, scipy_ 1.9.1,
-GeoConvert_ 2.3, GeodSolve_ 2.3), Python 3.9.6 and Python 2.7.18 (with geographiclib_ 1.50, numpy_
-1.16.6, scipy_ 1.2.2, GeoConvert_ 2.3, GeodSolve_ 2.3, IntersectTool_ 2.3 and RhumbSolve_ 2.3),
-all on macOS 14.6.1 Sonoma in 64-bit.
+The tests ran with Python 3.13.0 (with geographiclib_ 2.0), 3.12.7 (with geographiclib_ 2.0, numpy_
+2.1.0, scipy_ 1.14.1, GeodSolve_ 2.3, IntersectTool_ 2.3 and RhumbSolve_ 2.3), 3.11.5 (with
+geographiclib_ 2.0, numpy_ 1.24.2 and scipy_ 1.10.1), Python 3.10.8 (with geographiclib_ 2.0, numpy_
+1.23.3, scipy_ 1.9.1, GeoConvert_ 2.3, GeodSolve_ 2.3), Python 3.9.6 and Python 2.7.18 (with
+geographiclib_ 1.50, numpy_ 1.16.6, scipy_ 1.2.2, GeoConvert_ 2.3, GeodSolve_ 2.3, IntersectTool_
+2.3 and RhumbSolve_ 2.3), all on macOS 14.6.1 Sonoma in 64-bit.
 
 All tests ran with and without ``lazy import`` for Python 3 and with command line option ``-W default``
 and env variable ``PYGEODESY_WARNINGS=on`` for all Python versions.  The results of those tests are
@@ -107,7 +107,7 @@ runs on Intel (``x86_64``) or Intel *emulation* (\"``arm64_x86_64``\", see funct
 Test coverage has been measured with coverage_ 7.6.1 using Python 3.13.0, 3.12.7, 3.11.5 and 3.10.8.  The
 complete coverage report in HTML and a PDF summary are included in the distribution files.
 
-The tests also ran with Python 3.12.7 (and geographiclib_ 2.0) on `Debian 12`_ in 64-bit only and with
+The tests also ran with Python 3.13.0 (and geographiclib_ 2.0) on `Debian 12`_ in 64-bit only and with
 Python 3.12.5 (and geographiclib_ 2.0) on `Windows 2019Server`_ in 64-bit only and with Python 2.7.18
 (and with geographiclib_ 1.52) on `Windows 10`_ in 64- and 32-bit.
 
@@ -135,7 +135,7 @@ and McCabe_ using Python 2.7.18 and with Flake8_ using Python 3.11.5, both in 64
 
 For a summary of all *Karney*-based functionality in ``pygeodesy``, see module karney_.
 
-*Last updated: Oct 10, 2024.*
+*Last updated: Oct 24, 2024.*
 
 License
 =======
@@ -226,7 +226,7 @@ DEALINGS IN THE SOFTWARE.
 .. _PyCodeStyle: https://PyPI.org/project/pycodestyle
 .. _PyFlakes: https://PyPI.org/project/pyflakes
 .. _PyGeodesy: https://PyPI.org/project/PyGeodesy
-.. _pygeodesy.machine: https://mrJean1.GitHub.io/PyGeodesy/docs/pygeodesy.interns-module.html#machine
+.. _pygeodesy.machine: https://mrJean1.GitHub.io/PyGeodesy/docs/pygeodesy.internals-module.html#machine
 .. _PyInstaller: https://PyPI.org/project/pyinstaller
 .. _PyPI: https://PyPI.org/project/PyGeodesy
 .. _PyPI Download files: https://PyPI.org/project/PyGeodesy/#files

diff --git a/dist/PyGeodesy-24.10.10-py2.py3-none-any.whl b/dist/PyGeodesy-24.10.10-py2.py3-none-any.whl
diff --git a/dist/PyGeodesy-24.10.10.tar.bz2 b/dist/PyGeodesy-24.10.10.tar.bz2
diff --git a/dist/PyGeodesy-24.10.10.tar.gz b/dist/PyGeodesy-24.10.10.tar.gz
diff --git a/dist/PyGeodesy-24.10.24-py2.py3-none-any.whl b/dist/PyGeodesy-24.10.24-py2.py3-none-any.whl
diff --git a/dist/PyGeodesy-24.10.24.tar.bz2 b/dist/PyGeodesy-24.10.24.tar.bz2
diff --git a/dist/PyGeodesy-24.10.24.tar.gz b/dist/PyGeodesy-24.10.24.tar.gz
diff --git a/dist/PyGeodesy-24.10.10.zip → dist/PyGeodesy-24.10.24.zip b/dist/PyGeodesy-24.10.10.zip → dist/PyGeodesy-24.10.24.zip
diff --git a/docs/abc.ABCMeta-class.html b/docs/abc.ABCMeta-class.html
@@ -344,7 +344,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__subclasscheck__</s
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Wed Oct  9 16:14:58 2024
+    Generated by Epydoc 3.0.1 on Tue Oct 22 17:06:19 2024
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/api-objects.txt b/docs/api-objects.txt
diff --git a/docs/class-tree.html b/docs/class-tree.html
diff --git a/docs/help.html b/docs/help.html
@@ -254,7 +254,7 @@ <h2> The Navigation Bar </h2>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Wed Oct  9 16:14:56 2024
+    Generated by Epydoc 3.0.1 on Tue Oct 22 17:06:18 2024
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/identifier-index-A.html b/docs/identifier-index-A.html
diff --git a/docs/identifier-index-B.html b/docs/identifier-index-B.html
diff --git a/docs/identifier-index-C.html b/docs/identifier-index-C.html
diff --git a/docs/identifier-index-D.html b/docs/identifier-index-D.html
diff --git a/docs/identifier-index-E.html b/docs/identifier-index-E.html
diff --git a/docs/identifier-index-F.html b/docs/identifier-index-F.html
diff --git a/docs/identifier-index-G.html b/docs/identifier-index-G.html
diff --git a/docs/identifier-index-H.html b/docs/identifier-index-H.html
diff --git a/docs/identifier-index-I.html b/docs/identifier-index-I.html
diff --git a/docs/identifier-index-J.html b/docs/identifier-index-J.html
@@ -150,7 +150,7 @@ <h1 class="epydoc">Identifier Index</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Wed Oct  9 16:14:55 2024
+    Generated by Epydoc 3.0.1 on Tue Oct 22 17:06:17 2024
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/identifier-index-K.html b/docs/identifier-index-K.html
@@ -97,58 +97,41 @@ <h1 class="epydoc">Identifier Index</h1>
 <tr>
 <td width="33%" class="link-index"><a href="pygeodesy.azimuthal.Stereographic-class.html#k0">k0</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.azimuthal.Stereographic-class.html">Stereographic</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.named._NamedEnum-class.html#keys">keys()</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.named._NamedEnum-class.html">_NamedEnum</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.ellipsoids.Ellipsoid-class.html#KsOrder">KsOrder</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.ellipsoids.Ellipsoid-class.html">Ellipsoid</a>)</span></td>
+<td width="33%" class="link-index"><a href="pygeodesy.karney-module.html">karney</a><br />
+<span class="index-where">(in&nbsp;<a href="pygeodesy-module.html">pygeodesy</a>)</span></td>
+<td width="33%" class="link-index"><a href="pygeodesy.ktm.KTMError-class.html">KTMError</a><br />
+<span class="index-where">(in&nbsp;<a href="pygeodesy.ktm-module.html">pygeodesy.ktm</a>)</span></td>
 </tr>
 <tr>
 <td width="33%" class="link-index"><a href="pygeodesy.etm.ExactTransverseMercator-class.html#k0">k0</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.etm.ExactTransverseMercator-class.html">ExactTransverseMercator</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.geoids._GeoidBase-class.html#kind">kind</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.geoids._GeoidBase-class.html">_GeoidBase</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.ktm-module.html">ktm</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy-module.html">pygeodesy</a>)</span></td>
-</tr>
-<tr>
-<td width="33%" class="link-index"><a href="pygeodesy.ktm.KTransverseMercator-class.html#k0">k0</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.ktm.KTransverseMercator-class.html">KTransverseMercator</a>)</span></td>
 <td width="33%" class="link-index"><a href="pygeodesy.utily-module.html#km2m">km2m()</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.utily-module.html">pygeodesy.utily</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.ktm.KTMError-class.html">KTMError</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.ktm-module.html">pygeodesy.ktm</a>)</span></td>
-</tr>
-<tr>
-<td width="33%" class="link-index"><a href="pygeodesy.lcc.Conic-class.html#k0">k0</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.lcc.Conic-class.html">Conic</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.heights._HeightNamed-class.html#kmin">kmin</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.heights._HeightNamed-class.html">_HeightNamed</a>)</span></td>
 <td width="33%" class="link-index"><a href="pygeodesy.ktm.KTransverseMercator-class.html">KTransverseMercator</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.ktm-module.html">pygeodesy.ktm</a>)</span></td>
 </tr>
 <tr>
-<td width="33%" class="link-index"><a href="pygeodesy.elliptic.Elliptic-class.html#k2">k2</a><br />
+<td width="33%" class="link-index"><a href="pygeodesy.ktm.KTransverseMercator-class.html#k0">k0</a><br />
+<span class="index-where">(in&nbsp;<a href="pygeodesy.ktm.KTransverseMercator-class.html">KTransverseMercator</a>)</span></td>
+<td width="33%" class="link-index"><a href="pygeodesy.elliptic.Elliptic-class.html#kp2">kp2</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.elliptic.Elliptic-class.html">Elliptic</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.geoids._GeoidBase-class.html#knots">knots</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.geoids._GeoidBase-class.html">_GeoidBase</a>)</span></td>
 <td width="33%" class="link-index"><a href="pygeodesy.frechet.Frechet-class.html#kwds">kwds</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.frechet.Frechet-class.html">Frechet</a>)</span></td>
 </tr>
 <tr>
-<td width="33%" class="link-index"><a href="pygeodesy.geodesici._IntersectBase-class.html#k2kAkB">k2kAkB()</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.geodesici._IntersectBase-class.html">_IntersectBase</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.heights._HeightIDW-class.html#knots">knots</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.heights._HeightIDW-class.html">_HeightIDW</a>)</span></td>
+<td width="33%" class="link-index"><a href="pygeodesy.lcc.Conic-class.html#k0">k0</a><br />
+<span class="index-where">(in&nbsp;<a href="pygeodesy.lcc.Conic-class.html">Conic</a>)</span></td>
+<td width="33%" class="link-index"><a href="pygeodesy.ellipsoids.Ellipsoid-class.html#KsOrder">KsOrder</a><br />
+<span class="index-where">(in&nbsp;<a href="pygeodesy.ellipsoids.Ellipsoid-class.html">Ellipsoid</a>)</span></td>
 <td width="33%" class="link-index"><a href="pygeodesy.hausdorff.Hausdorff-class.html#kwds">kwds</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.hausdorff.Hausdorff-class.html">Hausdorff</a>)</span></td>
 </tr>
 <tr>
-<td width="33%" class="link-index"><a href="pygeodesy.karney-module.html">karney</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy-module.html">pygeodesy</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.elliptic.Elliptic-class.html#kp2">kp2</a><br />
+<td width="33%" class="link-index"><a href="pygeodesy.elliptic.Elliptic-class.html#k2">k2</a><br />
 <span class="index-where">(in&nbsp;<a href="pygeodesy.elliptic.Elliptic-class.html">Elliptic</a>)</span></td>
-<td width="33%" class="link-index"><a href="pygeodesy.heights._HeightIDW-class.html#kwds">kwds</a><br />
-<span class="index-where">(in&nbsp;<a href="pygeodesy.heights._HeightIDW-class.html">_HeightIDW</a>)</span></td>
+<td width="33%" class="link-index"><a href="pygeodesy.ktm-module.html">ktm</a><br />
+<span class="index-where">(in&nbsp;<a href="pygeodesy-module.html">pygeodesy</a>)</span></td>
+<td width="33%" class="link-index">&nbsp;</td>
 </tr>
 </table>
 </td></tr>
@@ -184,7 +167,7 @@ <h1 class="epydoc">Identifier Index</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Wed Oct  9 16:14:55 2024
+    Generated by Epydoc 3.0.1 on Tue Oct 22 17:06:17 2024
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"