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

pygeodesy/azimuthal.py

@@ -70,7 +70,7 @@ from pygeodesy.utily import asin1, atan1, atan2b, atan2d, sincos2, \
 from math import acos, atan2, degrees, fabs, sin, sqrt
 
 __all__ = _ALL_LAZY.azimuthal
-__version__ = '24.05.24'
+__version__ = '24.06.11'
 
 _EPS_K         = _EPStol * _0_1  # Karney's eps_ or _EPSmin * _0_1?
 _over_horizon_ = 'over horizon'
@@ -364,8 +364,8 @@ class Equidistant(_AzimuthalBase):
 
            @raise AzimuthalError: Invalid B{C{lat}} or B{C{lon}}.
 
-           @note: The C{scale} will be C{-1} if B{C{(lat, lon)}} is antipodal to
-                  the projection center C{(lat0, lon0)}.
+           @note: The C{scale} will be C{-1} if B{C{(lat, lon)}} is antipodal to the
+                  projection center C{(lat0, lon0)}.
         '''
         def _k_t(c):
             k = _N_1_0 if c < 0 else _1_0
@@ -389,7 +389,7 @@ class Equidistant(_AzimuthalBase):
                               optional, additional B{C{LatLon}} keyword arguments,
                               ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @note: The C{lat} will be in the range C{[-90..90] degrees} and C{lon}
@@ -509,7 +509,7 @@ class _EquidistantBase(_AzimuthalGeodesic):
                               optional, additional B{C{LatLon}} keyword arguments,
                               ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @note: The C{lat} will be in the range C{[-90..90] degrees} and C{lon}
@@ -680,7 +680,7 @@ class Gnomonic(_AzimuthalBase):
                               optional, additional B{C{LatLon}} keyword arguments,
                               ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @note: The C{lat} will be in the range C{[-90..90] degrees} and C{lon}
@@ -791,7 +791,7 @@ class _GnomonicBase(_AzimuthalGeodesic):
                               optional, additional B{C{LatLon}} keyword arguments,
                               ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @raise AzimuthalError: No convergence.
@@ -984,7 +984,7 @@ class LambertEqualArea(_AzimuthalBase):
                               and optional, additional B{C{LatLon}} keyword
                               arguments, ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @note: The C{lat} will be in the range C{[-90..90] degrees} and C{lon}
@@ -1038,7 +1038,7 @@ class Orthographic(_AzimuthalBase):
                               optional, additional B{C{LatLon}} keyword arguments,
                               ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @note: The C{lat} will be in the range C{[-90..90] degrees} and C{lon}
@@ -1111,7 +1111,7 @@ class Stereographic(_AzimuthalBase):
                               optional, additional B{C{LatLon}} keyword arguments,
                               ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic (C{LatLon}) or if B{C{LatLon}} is C{None} an
+           @return: The geodetic (C{LatLon}) or if C{B{LatLon} is None} an
                     L{Azimuthal7Tuple}C{(x, y, lat, lon, azimuth, scale, datum)}.
 
            @note: The C{lat} will be in range C{[-90..90] degrees}, C{lon} in range

pygeodesy/basics.py

@@ -30,13 +30,14 @@ from pygeodesy.lazily import _ALL_LAZY, _ALL_MODS as _MODS, _FOR_DOCS, _getenv,
 # from pygeodesy.nvectorBase import NvectorBase  # _MODS
 # from pygeodesy.props import _update_all  # _MODS
 # from pygeodesy.streprs import Fmt  # _MODS
+# from pygeodesy.unitsBase import _NamedUnit, Str  # _MODS
 
 from copy import copy as _copy, deepcopy as _deepcopy
 from math import copysign as _copysign
 import inspect as _inspect
 
 __all__ = _ALL_LAZY.basics
-__version__ = '24.05.29'
+__version__ = '24.07.06'
 
 _below_               = 'below'
 _list_tuple_types     = (list, tuple)
@@ -159,19 +160,23 @@ def _args_kwds_names(func, splast=False):
     return tuple(args_kwds)
 
 
-def clips(sb, limit=50, white=NN):
+def clips(sb, limit=50, white=NN, length=False):
     '''Clip a string to the given length limit.
 
        @arg sb: String (C{str} or C{bytes}).
        @kwarg limit: Length limit (C{int}).
        @kwarg white: Optionally, replace all whitespace (C{str}).
+       @kwarg len: IF C{True} append the original I{[length]} (C{bool}).
 
        @return: The clipped or unclipped B{C{sb}}.
     '''
-    T = type(sb)
-    if len(sb) > limit > 8:
+    T, n = type(sb), len(sb)
+    if n > limit > 8:
         h  = limit // 2
         sb = T(_ELLIPSIS4_).join((sb[:h], sb[-h:]))
+        if length:
+            n  = _MODS.streprs.Fmt.SQUARE(n)
+            sb =  T(NN).join((sb, n))
     if white:  # replace whitespace
         sb = T(white).join(sb.split())
     return sb
@@ -194,6 +199,13 @@ def copytype(x, y):
     return type(y)(x if x else _0_0)
 
 
+def _enumereverse(iterable):
+    '''(INTERNAL) Reversed C{enumberate}.
+    '''
+    for j in _reverange(len(iterable)):
+        yield j, iterable[j]
+
+
 def halfs2(str2):
     '''Split a string in 2 halfs.
 

pygeodesy/booleans.py

@@ -43,7 +43,7 @@ from pygeodesy.utily import fabs, _unrollon, _Wrap
 # from math import fabs  # from .utily
 
 __all__ = _ALL_LAZY.booleans
-__version__ = '24.06.06'
+__version__ = '24.06.15'
 
 _0_EPS =  EPS  # near-zero, positive
 _EPS_0 = -EPS  # near-zero, negative
@@ -131,8 +131,8 @@ class _LatLonBool(_Named):
 
            @arg lat_ll: Latitude (C{scalar}) or a lat-/longitude (C{LatLon[FHP|GH]},
                         C{Clip[FHP|GH]4Tuple} or some other C{LatLon}).
-           @kwarg lon: Longitude (C{scalar}), iff B{C{lat_ll}} is scalar, ignored
-                       otherwise.
+           @kwarg lon: Longitude (C{scalar}), required B{C{lat_ll}} is scalar,
+                       ignored otherwise.
            @kwarg height: Height (C{scalar}), conventionally C{meter}.
            @kwarg clipid: Clip identifier (C{int}).
            @kwarg wrap: If C{True}, wrap or I{normalize} B{C{lat}} and B{C{lon}} (C{bool}).
@@ -1961,7 +1961,7 @@ def _other(this, other):
     C = this.__class__
     if isinstance(other, C):
         return other
-    raise _IsnotError(C.__name__, other=other)
+    raise _IsnotError(C, other=other)
 
 
 def _outside(x1, x2, lo, hi):

pygeodesy/cartesianBase.py

@@ -43,7 +43,7 @@ from pygeodesy.vector3d import Vector3d, _xyzhdlln4
 # from math import atan2, degrees, fabs, radians, sqrt  # from .fmath, .utily
 
 __all__ = _ALL_LAZY.cartesianBase
-__version__ = '24.06.10'
+__version__ = '24.06.11'
 
 _r_     = 'r'
 _theta_ = 'theta'
@@ -62,8 +62,7 @@ class CartesianBase(Vector3d):
                        L{Ecef9Tuple}, L{Vector3Tuple} or L{Vector4Tuple}.
            @kwarg y: Cartesian Y coordinate (C{scalar}), ignored if B{C{x_xyz}}
                      is not C{scalar}, otherwise same units as B{C{x_xyz}}.
-           @kwarg z: Cartesian Z coordinate (C{scalar}), ignored if B{C{x_xyz}}
-                     is not C{scalar}, otherwise same units as B{C{x_xyz}}.
+           @kwarg z: Cartesian Z coordinate (C{scalar}), like B{C{y}}.
            @kwarg datum: Optional datum (L{Datum}, L{Ellipsoid}, L{Ellipsoid2}
                          or L{a_f2Tuple}).
            @kwarg ll_name: Optional C{B{name}=NN} (C{str}) and optional, original
@@ -711,15 +710,15 @@ class CartesianBase(Vector3d):
            @kwarg datum: Optional datum (L{Datum}, L{Ellipsoid}, L{Ellipsoid2}
                          or L{a_f2Tuple}).
            @kwarg height: Optional height, overriding the converted height
-                          (C{meter}), iff B{C{LatLon}} is not C{None}.
+                          (C{meter}), only if C{B{LatLon} is not None}.
            @kwarg LatLon: Optional class to return the geodetic point
                           (C{LatLon}) or C{None}.
            @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword
                                arguments, ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic point (B{C{LatLon}}) or if B{C{LatLon}}
-                    is C{None}, an L{Ecef9Tuple}C{(x, y, z, lat, lon,
-                    height, C, M, datum)} with C{C} and C{M} if available.
+           @return: The geodetic point (B{C{LatLon}}) or if C{B{LatLon}
+                    is None}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height,
+                    C, M, datum)} with C{C} and C{M} if available.
 
            @raise TypeError: Invalid B{C{datum}} or B{C{LatLon_kwds}}.
         '''
@@ -775,7 +774,7 @@ class CartesianBase(Vector3d):
                        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}.
+                    C{B{Nvector} is None}.
 
            @raise TypeError: Invalid B{C{Nvector}}, B{C{datum}} or
                              B{C{name_Nvector_kwds}} item.
@@ -851,7 +850,7 @@ class CartesianBase(Vector3d):
                                arguments, ignored if C{B{Vector} is None}.
 
            @return: A B{C{Vector}} or a L{Vector3Tuple}C{(x, y, z)} if
-                    B{C{Vector}} is C{None}.
+                    C{B{Vector} is None}.
 
            @raise TypeError: Invalid B{C{Vector}} or B{C{Vector_kwds}}.
         '''
@@ -923,8 +922,7 @@ def rtp2xyz(r_rtp, theta=0, phi=0, **name_Cartesian_and_kwds):
 
        @arg theta: Inclination B{C{theta}} (C{degrees} with respect to the positive z-axis),
                    required if C{B{r_rtp}} is C{scalar}, ignored otherwise.
-       @arg phi: Azimuthal angle B{C{phi}} (C{degrees}), required if C{B{r_rtp}} is C{scalar},
-                 ignored otherwise.
+       @arg phi: Azimuthal angle B{C{phi}} (C{degrees}), like B{C{theta}}.
 
        @see: Function L{rtp2xyz_} for further details.
     '''
@@ -942,8 +940,7 @@ def rtp2xyz_(r_rtp, theta=0, phi=0, **name_Cartesian_and_kwds):
                    L{RadiusThetaPhi3Tuple} instance.
        @arg theta: Inclination B{C{theta}} (C{radians} with respect to the positive z-axis),
                    required if C{B{r_rtp}} is C{scalar}, ignored otherwise.
-       @arg phi: Azimuthal angle B{C{phi}} (C{radians}), required if C{B{r_rtp}} is C{scalar},
-                 ignored otherwise.
+       @arg phi: Azimuthal angle B{C{phi}} (C{radians}), like B{C{theta}}.
        @kwarg name_Cartesian_and_kwds: Optional C{B{name}=NN} (C{str}), a C{B{Cartesian}=None}
                    class to return the coordinates and optional, additional C{B{Cartesian}}
                    keyword arguments.
@@ -1017,7 +1014,7 @@ def xyz2rtp_(x_xyz, y=0, z=0, **name):
                    C{Nvector}, L{Vector3d}, L{Vector3Tuple}, L{Vector4Tuple} or a C{tuple} or
                    C{list} of 3+ C{scalar} items) if no C{y_z} specified.
        @arg y: Y component (C{scalar}), required if C{B{x_xyz}} is C{scalar}, ignored otherwise.
-       @arg z: Z component (C{scalar}), required if C{B{x_xyz}} is C{scalar}, ignored otherwise.
+       @arg z: Z component (C{scalar}), like B{C{y}}.
        @kwarg name: Optional C{B{name}=NN} (C{str}).
 
        @return: L{RadiusThetaPhi3Tuple}C{(r, theta, phi)} with radial distance C{r} (C{meter},

pygeodesy/css.py

@@ -33,7 +33,7 @@ from pygeodesy.units import Bearing, Degrees, Easting, Height, _heigHt, \
 # from math import fabs  # from .karney
 
 __all__ = _ALL_LAZY.css
-__version__ = '24.05.24'
+__version__ = '24.06.11'
 
 
 def _CS0(cs0):
@@ -312,7 +312,7 @@ class CassiniSoldner(_NamedBase):
         s, c = _sincos2d(m.lat1)  # == self.lat0 == self.LatitudeOrigin()
         self._sb0, self._cb0 = _norm2(s * g.f1, c)
 
-    def reverse(self, easting, northing, LatLon=None, **LatLon_kwds_name):
+    def reverse(self, easting, northing, LatLon=None, **name_LatLon_kwds):
         '''Convert a Cassini-Soldner location to (ellipsoidal) geodetic
            lat- and longitude.
 
@@ -320,12 +320,11 @@ class CassiniSoldner(_NamedBase):
            @arg northing: Northing of the location (C{meter}).
            @kwarg LatLon: Optional, ellipsoidal class to return the geodetic
                           location as (C{LatLon}) or C{None}.
-           @kwarg LatLon_kwds_name: Optional (C{LatLon}) keyword arguments,
-                              ignored if C{B{LatLon} is None} and optional
-                              C{B{name}=NN} inlieu of this this projection's
-                              name (C{str}).
+           @kwarg name_LatLon_kwds: Optional name C{B{name}=NN} (C{str}) and
+                       optional, additional B{C{LatLon}} keyword arguments,
+                       ignored if C{B{LatLon} is None}.
 
-           @return: Geodetic location B{C{LatLon}} or if B{C{LatLon}} is C{None},
+           @return: Geodetic location B{C{LatLon}} or if C{B{LatLon} is None},
                     a L{LatLon2Tuple}C{(lat, lon)}.
 
            @raise CSSError: Ellipsoidal mismatch of B{C{LatLon}} and this projection.
@@ -335,7 +334,7 @@ class CassiniSoldner(_NamedBase):
            @see: Method L{CassiniSoldner.reverse4}, L{CassiniSoldner.forward}.
                  L{CassiniSoldner.forward4} and L{CassiniSoldner.forward6}.
         '''
-        n, kwds = _name2__(LatLon_kwds_name, _or_nameof=self)
+        n, kwds = _name2__(name_LatLon_kwds, _or_nameof=self)
         r = self.reverse4(easting, northing, name=n)
         if LatLon is None:
             r = LatLon2Tuple(r.lat, r.lon, name=r.name)  # PYCHOK expected
@@ -520,9 +519,8 @@ class Css(_NamedBase):
            @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword
                                arguments, ignored if C{B{LatLon} is None}.
 
-           @return: The geodetic point (B{C{LatLon}}) or if B{C{LatLon}}
-                    is C{None}, a L{LatLon4Tuple}C{(lat, lon, height,
-                    datum)}.
+           @return: The geodetic point (B{C{LatLon}}) or if C{B{LatLon} is
+                    None}, a L{LatLon4Tuple}C{(lat, lon, height, datum)}.
 
            @raise TypeError: If B{C{LatLon}} or B{C{datum}} is not
                              ellipsoidal or invalid B{C{height}} or
@@ -610,15 +608,13 @@ def toCss(latlon, cs0=None, height=None, Css=Css, **name):
        @arg latlon: Ellipsoidal point (C{LatLon} or L{LatLon4Tuple}).
        @kwarg cs0: Optional, the Cassini-Soldner projection to use
                    (L{CassiniSoldner}).
-       @kwarg height: Optional height for the point, overriding the
-                      default height (C{meter}).
-       @kwarg Css: Optional class to return the location (L{Css}) or
-                   C{None}.
+       @kwarg height: Optional height for the point, overriding the default
+                      height (C{meter}).
+       @kwarg Css: Optional class to return the location (L{Css}) or C{None}.
        @kwarg name: Optional B{C{Css}} C{B{name}=NN} (C{str}).
 
-       @return: The Cassini-Soldner location (B{C{Css}}) or an
-                L{EasNor3Tuple}C{(easting, northing, height)}
-                if B{C{Css}} is C{None}.
+       @return: The Cassini-Soldner location (B{C{Css}}) or if C{B{Css} is
+                None}, an L{EasNor3Tuple}C{(easting, northing, height)}.
 
        @raise CSSError: Ellipsoidal mismatch of B{C{latlon}} and B{C{cs0}}.
 

pygeodesy/datums.py

@@ -94,7 +94,7 @@ from pygeodesy.units import _isRadius, Radius_,  radians
 # import operator as _operator  # from .fmath
 
 __all__ = _ALL_LAZY.datums
-__version__ = '24.05.21'
+__version__ = '24.06.24'
 
 _a_ellipsoid_ = _UNDER_(_a_, _ellipsoid_)
 _BD72_        = 'BD72'
@@ -248,18 +248,18 @@ class Transform(_NamedEnumItem):
         self.s  = s = (s1 - _1_0) / _S1_S
         return s
 
-    def toStr(self, prec=5, fmt=Fmt.g, **name):  # PYCHOK expected
+    def toStr(self, prec=5, fmt=Fmt.g, **sep_name):  # PYCHOK expected
         '''Return this transform as a string.
 
            @kwarg prec: Number of (decimal) digits, unstripped (C{int}).
            @kwarg fmt: Optional C{float} format (C{letter}).
-           @kwarg name: Optional, override C{B{name}=NN} (C{str}) or
-                        C{None} to exclude this transform's name.
+           @kwarg sep_name: Optional C{B{name}=NN} (C{str}) or C{None}
+                      to exclude this transform's name and separater
+                      C{B{sep}=", "} to join the items (C{str}).
 
            @return: Transform attributes (C{str}).
         '''
-        name, _ = _name2__(**name)  # name=None
-        return self._instr(name, prec, *_Names11, fmt=fmt)
+        return self._instr(*_Names11, fmt=fmt, prec=prec, **sep_name)
 
     def transform(self, x, y, z, inverse=False, **Vector_and_kwds):
         '''Transform a (cartesian) position, forward or inverse.

pygeodesy/deprecated/__init__.py

@@ -27,7 +27,7 @@ __all__ = (_ALL_DEPRECATED.deprecated_bases +
            _ALL_DEPRECATED.deprecated_classes +
            _ALL_DEPRECATED.deprecated_consterns +
            _ALL_DEPRECATED.deprecated_functions)
-__version__ = '24.04.17'
+__version__ = '24.07.02'
 
 if _unLazy0:
     from pygeodesy.deprecated import bases, datum, nvector, rhumbBase, \

pygeodesy/deprecated/classes.py

@@ -9,20 +9,20 @@ from pygeodesy.constants import NAN, _float
 from pygeodesy.interns import NN, _a12_, _area_, _band_, _convergence_, \
                              _distance_, _gamma_, _i_, _lat_, _lon_, _ltp_
 from pygeodesy.deprecated.consterns import _Deprecated_Str
-from pygeodesy.karney import _GTuple, Rhumb8Tuple as _Rhumb8Tuple
+from pygeodesy.karney import _GTuple, Rhumb8Tuple as _Rhumb8Tuple,  ADict
 from pygeodesy.lazily import _ALL_DEPRECATED, _ALL_DOCS, _ALL_MODS as _MODS
 from pygeodesy.ltpTuples import Ned4Tuple as _Ned4Tuple
-# from pygeodesy.named import _NamedTuple  # from .namedTuples
+# from pygeodesy.named import ADict, _NamedTuple  # from .karney, .namedTuples
 from pygeodesy.namedTuples import Forward4Tuple as _Forward4Tuple, \
                                   Reverse4Tuple as _Reverse4Tuple, \
                                   UtmUps5Tuple  as _UtmUps5Tuple,  _NamedTuple
 from pygeodesy.props import deprecated_class, deprecated_method
 from pygeodesy.resections import TriAngle5Tuple as _TriAngle5Tuple
 from pygeodesy.trf import TRFXform7Tuple as _TRFXform7Tuple
-from pygeodesy.units import Bearing, Int, Lat, Lon, Meter
+from pygeodesy.units import Bearing, Int, Lamd, Lat, Lon, Meter, Phid
 
 __all__ = _ALL_DEPRECATED.deprecated_classes
-__version__ = '24.04.17'
+__version__ = '24.07.02'
 
 
 class _Deprecated_NamedTuple(_NamedTuple):
@@ -151,6 +151,13 @@ def HeightIDW3(knots, **kwds):  # PYCHOK no cover
     return HeightIDW3(knots, **kwds)
 
 
+class Lam_(Lamd):
+    '''DEPRECATED on 2024.06.15, use class L{Lamd}.'''
+    def __init__(self, *args, **kwds):  # PYCHOK signature
+        deprecated_class(self.__class__)
+        Lamd.__init__(self, *args, **kwds)
+
+
 class LatLonExact4Tuple(_Deprecated_NamedTuple):
     '''DEPRECATED, use class L{Reverse4Tuple}, item C{gamma} for C{convergence}.'''
     _Names_ = _reNames(_Reverse4Tuple._Names_, _gamma_, _convergence_)
@@ -163,6 +170,13 @@ class NearestOn4Tuple(_Deprecated_NamedTuple):  # PYCHOK no cover
     _Units_ = ( Lat,   Lon,   Meter,      Bearing)
 
 
+class Phi_(Phid):
+    '''DEPRECATED on 2024.06.15, use class L{Phid}.'''
+    def __init__(self, *args, **kwds):  # PYCHOK signature
+        deprecated_class(self.__class__)
+        Phid.__init__(self, *args, **kwds)
+
+
 class Ned3Tuple(_Deprecated_NamedTuple):  # was in .ellipsoidalNvector
     '''DEPRECATED, use class L{Ned4Tuple}, ignoring item C{ltp}.'''
     assert _Ned4Tuple._Names_.index(_ltp_) == 3
@@ -250,6 +264,13 @@ class UtmUps4Tuple(_Deprecated_NamedTuple):  # PYCHOK no cover
     _Units_ = (_Deprecated_Str,) + _UtmUps5Tuple._Units_[1:4]
 
 
+class XDist(ADict):
+    '''DEPRECATED on 2024.07.02, use class L{XDict}.'''
+    def __init__(self, *args, **kwds):  # PYCHOK signature
+        deprecated_class(self.__class__)
+        ADict.__init__(self, *args, **kwds)
+
+
 __all__ += _ALL_DOCS(_Deprecated_NamedTuple)
 
 # **) MIT License

pygeodesy/deprecated/datum.py

@@ -5,17 +5,17 @@ u'''DEPRECATED on 2022.09.12, use module L{pygeodesy.datums} or L{pygeodesy.elli
 '''
 
 # XXX only the items previously public
-from pygeodesy.constants import R_M, R_MA, R_MB, R_KM, R_NM, R_SM, R_FM, R_VM
+from pygeodesy.constants import R_FM, R_KM, R_M, R_MA, R_MB, R_NM, R_SM, R_VM
 from pygeodesy.datums import Datum, Datums, Transform, Transforms
 from pygeodesy.ellipsoids import Ellipsoid, Ellipsoids, Curvature2Tuple
 from pygeodesy.lazily import _ALL_DEPRECATED, _ALL_OTHER
 
 __all__ = _ALL_DEPRECATED.deprecated_datum
-__version__ = '23.11.26'
+__version__ = '24.06.15'
 
 assert _ALL_OTHER(Curvature2Tuple, Datum,  Ellipsoid,  Transform) + \
             tuple(_.name for _ in (Datums, Ellipsoids, Transforms,
-                    R_M, R_MA, R_MB, R_KM, R_NM, R_SM, R_FM, R_VM)) == __all__
+                    R_FM, R_KM, R_M, R_MA, R_MB, R_NM, R_SM, R_VM)) == __all__
 
 # **) MIT License
 #

pygeodesy/deprecated/functions.py

@@ -14,7 +14,7 @@ from pygeodesy.props import deprecated_function
 from pygeodesy.units import Number_, Scalar_
 
 __all__ = _ALL_DEPRECATED.deprecated_functions
-__version__ = '24.05.25'
+__version__ = '24.06.11'
 
 _WGS84 = _UTM = object()
 
@@ -41,9 +41,8 @@ def atand(x):
 def bounds(points, wrap=True, LatLon=None):  # PYCHOK no cover
     '''DEPRECATED, use function L{pygeodesy.boundsOf}.
 
-       @return: 2-Tuple C{(latlonSW, latlonNE)} as B{C{LatLon}}
-                or 4-Tuple C{(latS, lonW, latN, lonE)} if
-                B{C{LatLon}} is C{None}.
+       @return: 2-Tuple C{(latlonSW, latlonNE)}, each a B{C{LatLon}} or
+                4-Tuple C{(latS, lonW, latN, lonE)} if C{B{LatLon} is None}.
     '''
     return tuple(_MODS.points.boundsOf(points, wrap=wrap, LatLon=LatLon))
 
@@ -253,7 +252,7 @@ def parseUTM(strUTM, datum=_WGS84, Utm=_UTM, name=NN):  # PYCHOK no cover
     '''DEPRECATED, use function L{parseUTM5}.
 
        @return: The UTM coordinate (B{L{Utm}}) or 4-tuple C{(zone,
-                hemisphere, easting, northing)} if B{C{Utm}} is C{None}.
+                hemisphere, easting, northing)} if C{B{Utm} is None}.
     '''
     d = _MODS.datums.Datums.WGS84 if datum is _WGS84 else datum  # PYCHOK shadows?
     U = _MODS.utm.Utm if Utm is _UTM else Utm
@@ -305,9 +304,8 @@ def tienstra(pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds):
 def toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name=NN):  # PYCHOK no cover
     '''DEPRECATED, use function L{pygeodesy.toUtm8}.
 
-       @return: The UTM coordinate (B{C{Utm}}) or a 6-tuple C{(zone,
-                easting, northing, band, convergence, scale)} if
-                B{C{Utm}} is C{None} or B{C{cmoff}} is C{False}.
+       @return: The UTM coordinate (B{C{Utm}}) or a 6-tuple C{(zone, easting, northing,
+                band, convergence, scale)} if C{B{Utm} is None} or C{B{cmoff} is False}.
     '''
     U = _MODS.utm.Utm if Utm is _UTM else Utm
     r = _MODS.utm.toUtm8(latlon, lon=lon, datum=datum, Utm=U, name=name, falsed=cmoff)

pygeodesy/dms.py

@@ -85,7 +85,7 @@ except ImportError:  # Python 3+
     from string import ascii_letters as _LETTERS
 
 __all__ = _ALL_LAZY.dms
-__version__ = '24.05.18'
+__version__ = '24.06.11'
 
 _beyond_      = 'beyond'
 _DDDMMSS_     = 'DDDMMSS'
@@ -293,8 +293,8 @@ def clipDegrees(deg, limit):
 
        @return: Clipped value (C{degrees}).
 
-       @raise RangeError: If B{C{deg}} outside the valid C{-/+B{limit}}
-                          range and L{pygeodesy.rangerrors} set to C{True}.
+       @raise RangeError: If B{C{deg}} outside the valid C{-/+B{limit}} range
+                          and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
     '''
     return _clip(deg, limit, _degrees_) if limit and limit > 0 else deg
 
@@ -307,8 +307,8 @@ def clipRadians(rad, limit):
 
        @return: Clipped value (C{radians}).
 
-       @raise RangeError: If B{C{rad}} outside the valid C{-/+B{limit}}
-                          range and  L{pygeodesy.rangerrors} set to C{True}.
+       @raise RangeError: If B{C{rad}} outside the valid C{-/+B{limit}} range
+                          and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
     '''
     return _clip(rad, limit, _radians_) if limit and limit > 0 else rad
 
@@ -456,17 +456,14 @@ def latlonDMS(lls, **m_form_prec_sep_s_D_M_S):
                 C{LatLon.toStr} and functions L{pygeodesy.latDMS} and
                 L{pygeodesy.lonDMS} for more details.
 
-       @return: A C{tuple} of C{str}s if B{C{lls}} is a list, sequence,
-                tuple, etc. of C{LatLon} instances or a single C{str}
-                if B{C{lls}} is a single C{LatLon}.
+       @return: A C{tuple} of C{str}s if B{C{lls}} is a list, sequence, tuple, etc.
+                of C{LatLon}s or a single C{str} if B{C{lls}} is a single C{LatLon}.
 
-       @see: Functions L{pygeodesy.latlonDMS_}, L{pygeodesy.latDMS},
-             L{pygeodesy.lonDMS} and L{pygeodesy.toDMS} and method
-             C{LatLon.toStr}.
+       @see: Functions L{pygeodesy.latlonDMS_}, L{pygeodesy.latDMS}, L{pygeodesy.lonDMS}
+             and L{pygeodesy.toDMS} and method C{LatLon.toStr}.
 
-       @note: Keyword argument C{B{sep}=None} to join a C{str}ing
-              from the returned C{tuple} has been I{DEPRECATED},
-              use C{B{sep}.join(B{latlonDMS_}(...))} instead.
+       @note: Keyword argument C{B{sep}=None} to join a C{str}ing from the returned C{tuple}
+              has been I{DEPRECATED}, use C{B{sep}.join(B{latlonDMS_}(...))} instead.
     '''
     sep, kwds = _latlonDMS_sep2(latlonDMS, **m_form_prec_sep_s_D_M_S)
     if isLatLon(lls):
@@ -610,7 +607,7 @@ def parseDDDMMSS(strDDDMMSS, suffix=_NSEW_, sep=S_SEP, clip=0, sexagecimal=False
                           B{C{suffix}} compass point.
 
        @raise RangeError: Value of B{C{strDDDMMSS}} outside the valid C{-/+B{clip}}
-                          range and L{pygeodesy.rangerrors} set to C{True}.
+                          range and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
 
        @note: Type C{str} values "[D]DD", "[D]DDMM", "[D]DDMMSS" and "[D]DD.MMSS"
               for B{C{strDDDMMSS}} are parsed properly only if I{either} unsigned
@@ -746,14 +743,13 @@ def parseDMS(strDMS, suffix=_NSEW_, sep=S_SEP, clip=0, **s_D_M_S):  # MCCABE 14
 
        @raise ParseError: Invalid B{C{strDMS}} or B{C{clip}}.
 
-       @raise RangeError: Value of B{C{strDMS}} outside the valid C{-/+B{clip}}
-                          range and L{pygeodesy.rangerrors} set to C{True}.
+       @raise RangeError: Value of B{C{strDMS}} outside the valid C{-/+B{clip}} range
+                          and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
 
-       @note: Unlike function L{parseDDDMMSS}, type C{float}, C{int} and other
-              non-C{str} B{C{strDMS}} values are considered decimal (and not
-              sexagecimal) degrees.  For example, C{int(1230)} is returned
-              as 1230.0 I{and not as 12.5} degrees and C{float(345)} as 345.0
-              I{and not as 3.75} degrees!
+       @note: Unlike function L{parseDDDMMSS}, type C{float}, C{int} and other non-C{str}
+              B{C{strDMS}} values are considered decimal (and not sexagecimal) degrees.
+              For example, C{int(1230)} is returned as 1230.0 I{and not as 12.5} degrees
+              and C{float(345)} as 345.0 I{and not as 3.75} degrees!
 
        @see: Functions L{pygeodesy.parseDDDMMSS}, L{pygeodesy.parseDMS2},
              L{pygeodesy.parse3llh} and L{pygeodesy.toDMS}.
@@ -780,7 +776,7 @@ def parseDMS2(strLat, strLon, sep=S_SEP, clipLat=90, clipLon=180, wrap=False, **
 
        @raise RangeError: Value of B{C{strLat}} or B{C{strLon}} outside the
                           valid C{-/+B{clipLat}} or C{-/+B{clipLon}} range
-                          and L{pygeodesy.rangerrors} set to C{True}.
+                          and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
 
        @note: See the B{Notes} at function L{parseDMS}.
 
@@ -829,9 +825,9 @@ def parse3llh(strllh, height=0, sep=_COMMA_, clipLat=90, clipLon=180, wrap=False
        @return: A L{LatLon3Tuple}C{(lat, lon, height)} in C{degrees},
                 C{degrees} and C{float}.
 
-       @raise RangeError: Lat- or longitude value of B{C{strllh}} outside
-                          the valid C{-/+B{clipLat}} or C{-/+B{clipLon}}
-                          range and L{pygeodesy.rangerrors} set to C{True}.
+       @raise RangeError: Lat- or longitude value of B{C{strllh}} outside the
+                          valid C{-/+B{clipLat}} or C{-/+B{clipLon}} range
+                          and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
 
        @raise ValueError: Invalid B{C{strllh}} or B{C{height}}.
 
@@ -870,7 +866,7 @@ def parseRad(strRad, suffix=_NSEW_, clip=0):
        @raise ParseError: Invalid B{C{strRad}} or B{C{clip}}.
 
        @raise RangeError: Value of B{C{strRad}} outside the valid C{-/+B{clip}}
-                          range and L{pygeodesy.rangerrors} set to C{True}.
+                          range and L{rangerrors<pygeodesy.rangerrors>} is C{True}.
     '''
     def _Rad(strRad, suffix, clip):
         try:

pygeodesy/ecef.py

@@ -86,7 +86,7 @@ from pygeodesy.utily import atan1, atan1d, atan2d, degrees90, degrees180, \
 from math import atan2, cos, degrees, fabs, radians, sqrt
 
 __all__ = _ALL_LAZY.ecef
-__version__ = '24.06.09'
+__version__ = '24.06.11'
 
 _Ecef_    = 'Ecef'
 _prolate_ = 'prolate'
@@ -949,7 +949,7 @@ class EcefMatrix(_NamedTuple):
 
            @return: The matrix product (L{EcefMatrix}).
 
-           @raise TypeError: If B{C{other}} is not L{EcefMatrix}.
+           @raise TypeError: If B{C{other}} is not an L{EcefMatrix}.
         '''
         _xinstanceof(EcefMatrix, other=other)
         # like LocalCartesian.MatrixMultiply, C{self.matrixTransposed3 X other.matrix3}
@@ -1185,7 +1185,7 @@ class Ecef9Tuple(_NamedTuple):
                                B{C{LatLon}} keyword arguments.
 
            @return: An instance of C{B{LatLon}(lat, lon, **B{LatLon_kwds})}
-                    or if B{C{LatLon}} is C{None}, a L{LatLon3Tuple}C{(lat, lon,
+                    or if C{B{LatLon} is None}, a L{LatLon3Tuple}C{(lat, lon,
                     height)} respectively L{LatLon4Tuple}C{(lat, lon, height,
                     datum)} depending on whether C{datum} is un-/specified.
 
@@ -1233,7 +1233,7 @@ class Ecef9Tuple(_NamedTuple):
                                arguments, ignored if C{B{Vector} is None}.
 
            @return: A C{Vector}C{(x, y, z, **Vector_kwds)} instance or a
-                    L{Vector3Tuple}C{(x, y, z)} if B{C{Vector}} is C{None}.
+                    L{Vector3Tuple}C{(x, y, z)} if C{B{Vector} is None}.
 
            @see: Propertes C{xyz} and C{xyzh}
         '''