pygeodesy 24.6.9__py2.py3-none-any.whl → 24.6.24__py2.py3-none-any.whl

pygeodesy/points.py

@@ -62,7 +62,7 @@ from pygeodesy.utily import atan2b, degrees90, degrees180, degrees2m, \
 from math import cos, fabs, fmod as _fmod, radians, sin
 
 __all__ = _ALL_LAZY.points
-__version__ = '24.06.06'
+__version__ = '24.06.15'
 
 _ilat_  = 'ilat'
 _ilon_  = 'ilon'
@@ -391,7 +391,7 @@ class _Array2LatLon(_Basequence):  # immutable, on purpose
         # check the attr indices
         for n, (ai, i) in enumerate(ais):
             if not isint(i):
-                raise _IsnotError(int.__name__, **{ai: i})
+                raise _IsnotError(int, **{ai: i})
             i = int(i)
             if not 0 <= i < shape[1]:
                 raise _ValueError(ai, i)
@@ -959,8 +959,8 @@ def areaOf(points, adjust=True, radius=R_M, wrap=True):
                     the B{C{points}} (C{bool}).
 
        @return: Approximate area (I{square} C{meter}, same units as
-                B{C{radius}} or C{radians} I{squared} if B{C{radius}}
-                is C{None}).
+                B{C{radius}} or C{radians} I{squared} if C{B{radius}
+                is None}).
 
        @raise PointsError: Insufficient number of B{C{points}}
 
@@ -992,8 +992,8 @@ def boundsOf(points, wrap=False, LatLon=None):  # was=True
        @kwarg LatLon: Optional class to return the C{bounds}
                       corners (C{LatLon}) or C{None}.
 
-       @return: A L{Bounds2Tuple}C{(latlonSW, latlonNE)} as
-                B{C{LatLon}}s if B{C{LatLon}} is C{None} a
+       @return: A L{Bounds2Tuple}C{(latlonSW, latlonNE)}, each
+                a B{C{LatLon}} or if C{B{LatLon} is None}, a
                 L{Bounds4Tuple}C{(latS, lonW, latN, lonE)}.
 
        @raise PointsError: Insufficient number of B{C{points}}

pygeodesy/rhumb/__init__.py

@@ -9,7 +9,7 @@ u'''Package of lazily imported C{rhumb} modules L{rhumb.aux_}, L{rhumb.ekx} and
 from pygeodesy.lazily import _ALL_LAZY, _ALL_OTHER, _lazy_import_as, _unLazy0
 
 __all__ = _ALL_LAZY.rhumb
-__version__ = '24.05.24'
+__version__ = '24.06.18'
 
 if _unLazy0:  # or _isfrozen
     from pygeodesy.rhumb.aux_ import RhumbAux, RhumbLineAux

pygeodesy/rhumb/aux_.py

@@ -47,7 +47,7 @@ from pygeodesy.rhumb.bases import RhumbBase, RhumbLineBase, \
 from math import ceil as _ceil, fabs, radians
 
 __all__ = _ALL_LAZY.rhumb_aux_
-__version__ = '24.05.29'
+__version__ = '24.06.11'
 
 # DIGITS = (sizeof(real) * 8) bits
 #        = (ctypes.sizeof(ctypes.c_double(1.0)) * 8) bits
@@ -74,14 +74,14 @@ class RhumbAux(RhumbBase):
            @kwarg a_earth: This rhumb's earth model (L{Datum}, L{Ellipsoid},
                            L{Ellipsoid2}, L{a_f2Tuple}, 2-tuple C{(a, f)}) or
                            the (equatorial) radius (C{meter}, conventionally).
-           @kwarg f: The ellipsoid's flattening (C{scalar}), iff B{C{a_earth}} is
-                     C{scalar}, ignored otherwise.
+           @kwarg f: The ellipsoid's flattening (C{scalar}), required if B{C{a_earth}}
+                     is C{scalar}, ignored otherwise.
            @kwarg exact: If C{True}, use the exact expressions for the I{Auxiliary
                          Latitudes}, otherwise use the I{Fourier} series expansion
                          (C{bool}), see also property C{exact}.
            @kwarg TMorder_name: Optional C{B{name}=NN} (C{str}) and optional
-                          keyword argument C{B{TMorder}=6} for the order of
-                          the L{KTransverseMercator}, see property C{TMorder}.
+                          keyword argument C{B{TMorder}=6}, the order of the
+                          L{KTransverseMercator}, see property C{TMorder}.
 
            @raise ImportError: Package C{numpy} not found or not installed, only
                                required for area C{S12} when C{B{exact} is True}.

pygeodesy/rhumb/bases.py

@@ -52,11 +52,11 @@ from pygeodesy.vector3d import _intersect3d3, Vector3d  # in .Intersection below
 from math import cos, fabs
 
 __all__ = ()
-__version__ = '24.05.29'
+__version__ = '24.06.18'
 
 _anti_ = _Dash('anti')
 _rls   = []  # instances of C{RbumbLine...} to be updated
-_TRIPS = 65  # .Intersection, .PlumbTo, 19+
+_TRIPS =  129  # .Intersection, .PlumbTo, 19+
 
 
 class _Lat(Lat):
@@ -716,7 +716,7 @@ class RhumbLineBase(_CapsBase):
                 t = _xTMr(v.x, v.y, lon0=p.lon)  # PYCHOK Reverse4Tuple
                 d = _diff(t.lon - p.lon, t.lat)  # PYCHOK t.lat + p.lat - p.lat
                 p = _LL2T(t.lat + p.lat, t.lon)  # PYCHOK t.lon + p.lon = lon0
-                if d < tol:  # 19 trips
+                if d < tol:  # 19+ trips
                     break
             else:
                 raise ValueError(Fmt.no_convergence(d, tol))
@@ -724,7 +724,7 @@ class RhumbLineBase(_CapsBase):
             P = GDict(lat1=self.lat1, lat2=p.lat, lat0=other.lat1,
                       lon1=self.lon1, lon2=p.lon, lon0=other.lon1,
                       name=_dunder_nameof(self.Intersection, self.name))
-            r = self.Inverse( p.lat, p.lon, outmask=Caps.DISTANCE)
+            r =  self.Inverse(p.lat, p.lon, outmask=Caps.DISTANCE)
             t = other.Inverse(p.lat, p.lon, outmask=Caps.DISTANCE)
             P.set_(azi12= self.azi12, a12=r.a12, s12=r.s12,
                    azi02=other.azi12, a02=t.a12, s02=t.s12,
@@ -824,9 +824,9 @@ class RhumbLineBase(_CapsBase):
            @kwarg exact: If C{None}, use a rhumb line perpendicular to this rhumb line,
                          otherwise use an I{exact} C{Geodesic...} from the given point
                          perpendicular to this rhumb line (C{bool} or C{Geodesic...}),
-                         see method L{Ellipsoid.geodesic_}.
-           @kwarg eps: Optional tolerance for L{pygeodesy.intersection3d3} (C{EPS}),
-                       used only if C{B{exact} is None}.
+                         see method L{geodesic_<pygeodesy.Ellipsoid.geodesic_>}.
+           @kwarg eps: Optional tolerance (C{EPS}), used only if C{B{exact} is None},
+                       see function L{intersection3d3<pygeodesy.intersection3d3>}.
            @kwarg est: Optionally, an initial estimate for the distance C{s12} of the
                        intersection I{along} this rhumb line (C{meter}), used only if
                        C{B{exact} is not None}.
@@ -849,11 +849,11 @@ class RhumbLineBase(_CapsBase):
                                <https://PyPI.org/project/geographiclib>}
                                package not found or not installed.
 
-           @raise IntersectionError: No convergence for this B{C{eps}} or no
-                                     intersection for some other reason.
+           @raise IntersectionError: No convergence for this B{C{eps}} or B{C{tol}} or
+                                     no intersection for some other reason.
 
-           @see: Methods C{distance2}, C{Intersecant2} and C{Intersection}
-                 and function L{pygeodesy.intersection3d3}.
+           @see: Methods C{distance2}, C{Intersecant2} and C{Intersection} and function
+                 L{intersection3d3<pygeodesy.intersection3d3>}.
         '''
         Cs, tol = Caps, Float_(tol=tol, low=EPS, high=None)
 
@@ -899,7 +899,7 @@ class RhumbLineBase(_CapsBase):
                        lat0=lat0, lon0=lon0, iteration=i, at=r.azi2 - self.azi12,
                        name=_dunder_nameof(self.PlumbTo, self.name))
             except Exception as x:  # Fsum(NAN) Value-, ZeroDivisionError
-                raise IntersectionError(lat0, lon0, tol=tol, exact=exact,
+                raise IntersectionError(lat0=lat0, lon0=lon0, tol=tol, exact=exact,
                                         eps=eps, est=est, iteration=i, cause=x)
 
         return P
@@ -907,29 +907,28 @@ class RhumbLineBase(_CapsBase):
     def Position(self, s12, outmask=Caps.LATITUDE_LONGITUDE):
         '''Compute a point at a given distance on this rhumb line.
 
-           @arg s12: The distance along this rhumb line from its origin to
-                     the point (C{meters}), can be negative.
-           @kwarg outmask: Bit-or'ed combination of L{Caps} values specifying
-                           the quantities to be returned.
+           @arg s12: The distance along this rhumb line from its origin to the point
+                     (C{meters}), can be negative.
+           @kwarg outmask: Bit-or'ed combination of L{Caps} values specifying the
+                           quantities to be returned.
 
-           @return: L{GDict} with 4 to 8 items C{azi12, a12, s12, S12, lat2,
-                    lat1, lon2, lon1} with latitude C{lat2} and longitude
-                    C{lon2} of the point in C{degrees}, the rhumb angle C{a12}
-                    in C{degrees} from the start point of and the area C{S12}
-                    under this rhumb line in C{meter} I{squared}.
+           @return: L{GDict} with 4 to 8 items C{azi12, a12, s12, S12, lat2, lat1,
+                    lon2, lon1} with latitude C{lat2} and longitude C{lon2} of the
+                    point in C{degrees}, the rhumb angle C{a12} in C{degrees} from
+                    the start point of and the area C{S12} under this rhumb line
+                    in C{meter} I{squared}.
 
-           @raise ImportError: Package C{numpy} not found or not installed,
-                               only required for L{RhumbLineAux} area C{S12}
-                               when C{B{exact} is True}.
+           @raise ImportError: Package C{numpy} not found or not installed, required
+                               only for L{RhumbLineAux} area C{S12} when C{B{exact}
+                               is True}.
 
-           @note: If B{C{s12}} is large enough that the rhumb line crosses a
-                  pole, the longitude of the second point is indeterminate and
-                  C{NAN} is returned for C{lon2} and area C{S12}.
+           @note: If B{C{s12}} is large enough that the rhumb line crosses a pole, the
+                  longitude of the second point is indeterminate and C{NAN} is returned
+                  for C{lon2} and area C{S12}.
 
-                  If the first point is a pole, the cosine of its latitude is
-                  taken to be C{sqrt(L{EPS})}.  This position is extremely
-                  close to the actual pole and allows the calculation to be
-                  carried out in finite terms.
+                  If the first point is a pole, the cosine of its latitude is taken to
+                  be C{sqrt(L{EPS})}.  This position is extremely close to the actual
+                  pole and allows the calculation to be carried out in finite terms.
         '''
         return self._Position(self.m2degrees(s12), s12, outmask)
 

pygeodesy/rhumb/ekx.py

@@ -43,7 +43,7 @@ from pygeodesy.utily import atan1, sincos2_
 from math import asinh, atan, cos, cosh, radians, sin, sinh, sqrt, tan
 
 __all__ = _ALL_LAZY.rhumb_ekx
-__version__ = '24.05.30'
+__version__ = '24.06.11'
 
 
 class Rhumb(RhumbBase):
@@ -61,13 +61,12 @@ class Rhumb(RhumbBase):
            @kwarg a_earth: This rhumb's earth model (L{Datum}, L{Ellipsoid},
                            L{Ellipsoid2}, L{a_f2Tuple}, 2-tuple C{(a, f)}) or
                            the (equatorial) radius (C{meter}, conventionally).
-           @kwarg f: The ellipsoid's flattening (C{scalar}), iff B{C{a_earth}} is
-                     C{scalar}, ignored otherwise.
+           @kwarg f: The ellipsoid's flattening (C{scalar}), required if B{C{a_earth}}
+                     is C{scalar}, ignored otherwise.
            @kwarg exact: If C{True}, use an addition theorem for elliptic integrals
                          to compute I{Divided differences}, otherwise use the I{Krüger}
                          series expansion (C{bool} or C{None}), see also properties
                          C{exact} and C{TMorder}.
-           @kwarg name: Optional name (C{str}).
            @kwarg RA_TMorder_name: Optional C{B{name}=NN} (C{str}) and optional keyword
                      arguments B{C{RAorder}=6} and B{C{TMorder}=6} to set the respective
                      C{order}, see properties C{RAorder} and C{TMorder}.

pygeodesy/sphericalBase.py

@@ -19,7 +19,7 @@ from pygeodesy.constants import EPS, EPS0, PI, PI2, PI_2, R_M, \
                                _over, isnear0, isnon0
 from pygeodesy.datums import Datums, _earth_ellipsoid, _spherical_datum
 from pygeodesy.errors import IntersectionError, _ValueError, \
-                            _xattr, _xError
+                            _xattr, _xattrs, _xError
 from pygeodesy.fmath import favg, fdot, hypot, sqrt_a
 from pygeodesy.interns import _COMMA_, _concentric_, _datum_, _distant_, \
                               _exceed_PI_radians_, _name_, _near_, \
@@ -27,10 +27,10 @@ from pygeodesy.interns import _COMMA_, _concentric_, _datum_, _distant_, \
 from pygeodesy.latlonBase import LatLonBase,  _trilaterate5  # PYCHOK passed
 from pygeodesy.lazily import _ALL_DOCS, _ALL_LAZY, _ALL_MODS as _MODS
 # from pygeodesy.namedTuples import Bearing2Tuple  # from .cartesianBase
-from pygeodesy.nvectorBase import NvectorBase,  Fmt, _xattrs
+from pygeodesy.nvectorBase import NvectorBase,  Fmt
 from pygeodesy.props import deprecated_method, property_doc_, property_RO, \
                            _update_all
-# from pygeodesy.streprs import Fmt, _xattrs  # from .nvectorBase
+# from pygeodesy.streprs import Fmt  # from .nvectorBase
 from pygeodesy.units import Bearing, Bearing_, _isRadius, Radians_, Radius, \
                             Radius_, Scalar_, _100km
 from pygeodesy.utily import acos1, asin1, atan2b, atan2d, degrees90, \
@@ -40,7 +40,7 @@ from pygeodesy.utily import acos1, asin1, atan2b, atan2d, degrees90, \
 from math import cos, fabs, log, sin, sqrt
 
 __all__ = _ALL_LAZY.sphericalBase
-__version__ = '24.06.06'
+__version__ = '24.06.12'
 
 
 class CartesianSphericalBase(CartesianBase):
@@ -443,8 +443,8 @@ class LatLonSphericalBase(LatLonBase):
            @kwarg wrap: If C{True}, wrap or I{normalize} and unroll the
                         B{C{other}} point (C{bool}).
 
-           @return: Distance (C{meter}, the same units as B{C{radius}}
-                    or C{radians} if B{C{radius}} is C{None}).
+           @return: Distance (C{meter}, the same units as B{C{radius}} or
+                    C{radians} if C{B{radius} is None}).
 
            @raise TypeError: The B{C{other}} point is incompatible.
 
@@ -576,12 +576,11 @@ class LatLonSphericalBase(LatLonBase):
         '''Convert this point to C{Nvector} components, I{including
            height}.
 
-           @kwarg Nvector_kwds: Optional, additional B{C{Nvector}}
-                                keyword arguments, ignored if
-                                C{B{Nvector} is None}.
+           @kwarg Nvector_kwds: Optional, additional B{C{Nvector}} keyword
+                                arguments, ignored if C{B{Nvector} is None}.
 
-           @return: An B{C{Nvector}} or a L{Vector4Tuple}C{(x, y, z, h)}
-                    if B{C{Nvector}} is C{None}.
+           @return: An B{C{Nvector}} or a L{Vector4Tuple}C{(x, y, z, h)} if
+                    B{C{Nvector} is None}.
 
            @raise TypeError: Invalid B{C{Nvector}} or B{C{Nvector_kwds}}.
         '''

pygeodesy/sphericalNvector.py

@@ -61,7 +61,7 @@ from pygeodesy.utily import atan2, degrees360, fabs, sincos2, sincos2_, \
 # from math import atan2, fabs  # from utily
 
 __all__ = _ALL_LAZY.sphericalNvector
-__version__ = '24.04.07'
+__version__ = '24.06.11'
 
 _lines_ = 'lines'
 
@@ -226,7 +226,7 @@ class LatLon(LatLonNvectorBase, LatLonSphericalBase):
 
            @return: Distance between this and the B{C{other}} point
                     (C{meter}, same units as B{C{radius}} or C{radians}
-                    if B{C{radius}} is C{None}).
+                    if C{B{radius} is None}).
 
            @raise TypeError: Invalid B{C{other}} point.
         '''
@@ -303,14 +303,14 @@ class LatLon(LatLonNvectorBase, LatLonSphericalBase):
            to an other point.
 
            @arg other: The other point (L{LatLon}).
-           @kwarg wrap: If C{True}, wrap or I{normalize} and unroll
-                        the B{C{other}} point (C{bool}).
+           @kwarg wrap: If C{True}, wrap or I{normalize} and unroll the
+                        B{C{other}} point (C{bool}).
 
            @return: Initial bearing (compass C{degrees360}).
 
            @raise Crosserror: This point coincides with the B{C{other}}
-                              point or the C{NorthPole}, provided
-                              L{pygeodesy.crosserrors} is C{True}.
+                              point or the C{NorthPole} and L{crosserrors
+                              <pygeodesy.crosserrors>} is C{True}.
 
            @raise TypeError: The B{C{other}} point is not L{LatLon}.
         '''
@@ -660,8 +660,8 @@ class LatLon(LatLonNvectorBase, LatLonSphericalBase):
                     the C{closest} point (L{LatLon}), the C{distance}
                     between this and the C{closest} point in C{meter},
                     same units as B{C{radius}} or in C{radians} if
-                    B{C{radius}} is C{None} and the C{angle} from this
-                    to the C{closest} point in compass C{degrees360}.
+                    C{B{radius} is None} and the C{angle} from this to
+                    the C{closest} point in compass C{degrees360}.
 
            @raise TypeError: Some B{C{points}} are not C{LatLon}.
 
@@ -707,7 +707,7 @@ class LatLon(LatLonNvectorBase, LatLonSphericalBase):
                                     Specify C{B{Nvector}=...} to override this C{Nvector}
                                     class or use C{B{Nvector}=None}.
 
-           @return: An C{Nvector} or if B{C{Nvector}} is C{None}, a L{Vector4Tuple}C{(x, y, z, h)}.
+           @return: An C{Nvector} or if C{B{Nvector} is None}, a L{Vector4Tuple}C{(x, y, z, h)}.
 
            @raise TypeError: Invalid C{Nvector} or other B{C{Nvector_and_kwds}} item.
         '''
@@ -810,8 +810,8 @@ def areaOf(points, radius=R_M, wrap=False):
        @kwarg wrap: If C{True}, wrap or I{normalize} and unroll the
                     B{C{points}} (C{bool}).
 
-       @return: Polygon area (C{meter} I{squared} , same units as
-                B{C{radius}}, or C{radians} if B{C{radius}} is C{None}).
+       @return: Polygon area (C{meter} I{squared}, same units as
+                B{C{radius}}, or C{radians} if C{B{radius} is None}).
 
        @raise PointsError: Insufficient number of B{C{points}}.
 
@@ -1085,7 +1085,7 @@ def nearestOn3(point, points, closed=False, radius=R_M, height=None, wrap=False)
                 C{distance} and the C{angle} between the C{closest}
                 and the given B{C{point}}.  The C{distance} is in
                 C{meter}, same units as B{C{radius}} or in C{radians}
-                if B{C{radius}} is C{None}, the C{angle} is in compass
+                if C{B{radius} is None}, the C{angle} is in compass
                 C{degrees360}.
 
        @raise PointsError: Insufficient number of B{C{points}}.
@@ -1109,7 +1109,7 @@ def perimeterOf(points, closed=False, radius=R_M, wrap=False):
                     B{C{points}} (C{bool}).
 
        @return: Polygon perimeter (C{meter}, same units as B{C{radius}}
-                or C{radians} if B{C{radius}} is C{None}).
+                or C{radians} if C{B{radius} is None}).
 
        @raise PointsError: Insufficient number of B{C{points}}.