satkit 0.2.4__tar.gz → 0.2.5__tar.gz

{satkit-0.2.4 → satkit-0.2.5}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "satkit"
-version = "0.2.4"
+version = "0.2.5"
 edition = "2021"
 description = "Satellite Toolkit"
 readme = "README.md"

{satkit-0.2.4/python/satkit.egg-info → satkit-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satkit
-Version: 0.2.4
+Version: 0.2.5
 Summary: Satellite Orbital Dynamics Toolkit
 Author-email: Steven Michael <ssmichael@gmail.com>
 Maintainer-email: Steven Michael <ssmichael@gmail.com>
@@ -19,16 +19,33 @@ Requires-Dist: numpy>=1.20.0
 
 # Satellite Toolkit with Rust
 
+An accurate, high-performance satellite orbital kinematics toolkit, written in Rust with a sensible interface.
+<br/>
+
+### Github
+
 ![Build Passing?](https://github.com/ssmichael1/satkit/actions/workflows/build.yml/badge.svg)
 ![Wheel Passing?](https://github.com/ssmichael1/satkit/actions/workflows/wheels.yml/badge.svg)
 ![GitHub License](https://img.shields.io/github/license/ssmichael1/satkit)
-<br/>
-An accurate, high-performance satellite orbital kinematics toolkit, written in Rust with a sensible interface.
+
+### Crates.io
+
+![Crates.io Version](https://img.shields.io/crates/v/satkit)
+![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/satkit)
+
+### PyPi
+
+![PyPI - Version](https://img.shields.io/pypi/v/satkit)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satkit)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/satkit)
+![PyPI - Status](https://img.shields.io/pypi/status/satkit)
 
 ## Language Bindings
 
 - **Native Rust** bindings
-- **Python bindings** for compiled rust code ... speed of Rust with convenience of Python
+- **Python bindings** for compiled rust code ... speed of Rust with convenience of Python<br/>
+  Install with `pip install satkit`<br/>
+  PyPi includes binaries for windows, macos (Intel & arm), and linux
 
 ## Features
 

{satkit-0.2.4 → satkit-0.2.5}/README.md

@@ -1,15 +1,32 @@
 # Satellite Toolkit with Rust
 
+An accurate, high-performance satellite orbital kinematics toolkit, written in Rust with a sensible interface.
+<br/>
+
+### Github
+
 ![Build Passing?](https://github.com/ssmichael1/satkit/actions/workflows/build.yml/badge.svg)
 ![Wheel Passing?](https://github.com/ssmichael1/satkit/actions/workflows/wheels.yml/badge.svg)
 ![GitHub License](https://img.shields.io/github/license/ssmichael1/satkit)
-<br/>
-An accurate, high-performance satellite orbital kinematics toolkit, written in Rust with a sensible interface.
+
+### Crates.io
+
+![Crates.io Version](https://img.shields.io/crates/v/satkit)
+![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/satkit)
+
+### PyPi
+
+![PyPI - Version](https://img.shields.io/pypi/v/satkit)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satkit)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/satkit)
+![PyPI - Status](https://img.shields.io/pypi/status/satkit)
 
 ## Language Bindings
 
 - **Native Rust** bindings
-- **Python bindings** for compiled rust code ... speed of Rust with convenience of Python
+- **Python bindings** for compiled rust code ... speed of Rust with convenience of Python<br/>
+  Install with `pip install satkit`<br/>
+  PyPi includes binaries for windows, macos (Intel & arm), and linux
 
 ## Features
 

{satkit-0.2.4 → satkit-0.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "satkit"
-version = "0.2.4"
+version = "0.2.5"
 dependencies = ["numpy>=1.20.0"]
 requires-python = ">= 3.8"
 authors = [{ name = "Steven Michael", email = "ssmichael@gmail.com" }]

{satkit-0.2.4 → satkit-0.2.5}/python/satkit/__init__.pyi

@@ -176,7 +176,7 @@ def sgp4(
     tle: satkit.TLE | list[satkit.tle],
     tm: satkit.time | list[satkit.time] | npt.ArrayLike[satkit.time],
     **kwargs,
-) -> (npt.ArrayLike[np.float64], npt.ArrayLike[np.float64]):
+) -> tuple[npt.ArrayLike[np.float64], npt.ArrayLike[np.float64]]:
     """
     Run Simplified General Perturbations (SGP)-4 propagator on
     Two-Line Element Set to
@@ -369,7 +369,7 @@ def gravity(
 
 def gravity_and_partials(
     pos: satkit.itrfcoord | npt.ArrayLike[np.float], **kwargs
-) -> (npt.ArrayLike[np.float], np.arrayLike[np.float]):
+) -> typing.Tuple[npt.ArrayLike[np.float], np.arrayLike[np.float]]:
     """
     gravity_and_partials(pos)
     --
@@ -539,6 +539,16 @@ class timescale:
 
     For details, see:
     https://stjarnhimlen.se/comp/time.html
+
+    # Options:
+
+    * Invalid: Invalid time scale
+    * UTC: Universal Time Coordinate
+    * TT: Terrestrial Time
+    * UT1: UT1
+    * TAI: International Atomic Time
+    * GPS: Global Positioning System (GPS) time
+    * TDB: Barycentric Dynamical Time    
     """
 
     @property
@@ -587,6 +597,31 @@ class time:
     the ability to convert to an from the "datetime" object.  However, a separate
     time representation is needed as the "datetime" object does not allow for
     conversion between various time epochs (GPS, TAI, UTC, UT1, etc...)
+
+    Initialization arguments:
+
+    If no arguments are passed in, the created object represents
+    the current time, i.e. the time at which the function was called
+
+
+    If 3 integers are passed in, they represent a UTC date specified
+    by the standard Gregorian year, month (1-based), and day of month
+    (1-based)
+
+    if 5 integers and a float are passed in, they represent a UTC
+    date and time.  The 1st 3 numbers represent the standard
+    Gregorian year, month, and day as above.  The last 3 represent the
+    hour of the day [0,23], the minute of the hour [0,59], and the
+    second (including fractional component) of the minute
+
+    Example 1:
+    print(satkit.time(2023, 3, 5, 11, 3,45.453))
+    2023-03-05 11:03:45.453Z
+
+    Example 2:
+    print(satkit.time(2023, 3, 5))
+    2023-03-05 00:00:00.000Z
+
     """
 
     def __init__(self, *args):
@@ -645,7 +680,7 @@ class time:
         Return a time object representing input modified Julian date and time scale
         """
 
-    def to_date(self) -> (int, int, int):
+    def to_date(self) -> typing.Tuple[int, int, int]:
         """
         Return tuple representing as UTC Gegorian date of the
         time object.  Tuple has 6 elements:
@@ -687,7 +722,7 @@ class time:
 
     def to_gregorian(
         self, scale=satkit.timescale.UTC
-    ) -> (int, int, int, int, int, float):
+    ) -> typing.Tuple[int, int, int, int, int, float]:
         """
         Return tuple representing as UTC Gegorian date and time of the
         time object.  Tuple has 6 elements:
@@ -730,16 +765,20 @@ class time:
         2023-06-03 02:19:34
         """
 
-    def to_mjd(self, scale: satkit.timescale) -> float:
+    def to_mjd(self, scale: satkit.timescale = satkit.timescale.UTC) -> float:
         """
         Represent time instance as a Modified Julian Date
         with the provided time scale
+
+        If no time scale is provided, default is satkit.timescale.UTC
         """
 
-    def to_jd(self, scale: satkit.timescale) -> float:
+    def to_jd(self, scale: satkit.timescale = satkit.timescale.UTC) -> float:
         """
         Represent time instance as Julian Date with
         the provided time scale
+
+        If no time scale is provided, default is satkit.timescale.UTC
         """
 
     def to_unixtime(self) -> float:
@@ -765,15 +804,15 @@ class time:
         Return an satkit.time object or nunpy array of satkit.time objects
         representing the input "added to" the current object
 
-        Possible inputs and corresponding outputs:
+        # Possible inputs and corresponding outputs:
 
-        1. float: return satkit.time object incremented by input number of days
-        2. satkit.duration: return satkit.time object incremented by duration
-        3. list[float]: return numpy array of satkit.time objects, representing
+        *  `float` - return satkit.time object incremented by input number of days
+        * `satkit.duration` - return satkit.time object incremented by duration
+        * `list[float]`  - return numpy array of satkit.time objects, representing
            an element-wise addition of days to the "self"
-        4. list[duration]: reuturn numpy array of satkit.time objects, with each
+        * `list[duration]` -  reuturn numpy array of satkit.time objects, with each
            object representing an element-wise addition of "duration" to the "self"
-        5. numpy.array(float): return numpy array of satkit.time objects, with each
+        * `numpy.array(float)` - return numpy array of satkit.time objects, with each
            object representing an element-wise addition of days to the "self"
         """
 
@@ -791,17 +830,17 @@ class time:
         Return an satkit.time object or numpy array of satkit.time objects
         representing the input "subtracted from" the current object
 
-        Possible inputs and corresponding outputs:
+        # Possible inputs and corresponding outputs:
 
-        1. satkit.time: output is duration representing the difference
+        * `satkit.time` - output is duration representing the difference
            between the "other" time and "self"
-        2. satkit.duration: output is satkit.time object representing time minus
+        * `satkit.duration` - output is satkit.time object representing time minus
            the input duration
-        3. list[float]: return numpy array of satkit.time objects, representing
+        * `list[float]` - return numpy array of satkit.time objects, representing
            an element-wise subtraction of days to the "self"
-        4. list[duration]: return numpy array of satkit.time objects, representing
+        * `list[duration]` - return numpy array of satkit.time objects, representing
            an element-wise subtraction of "duration" from the "self"
-        5. numpy.array(float): return numpy array of satkit.time objects, with
+        * `numpy.array(float)` - return numpy array of satkit.time objects, with
            each object representing an element-wise subtraction of days from
            the "self".
 
@@ -847,11 +886,13 @@ class duration:
         if "other" is a time, output is a time representing the input
         time plus the duration
 
-        Example 1:
+        # Example 1:
+        
         print(duration.from_hours(1) + duration.from_minutes(1))
         Duration: 1 hours, 1 minutes, 0.000 seconds
 
-        Example 2:
+        # Example 2:
+        
         print(duration.from_hours(1) + satkit.time(2023, 6, 4, 11,30,0))
         2023-06-04 13:30:00.000Z
 
@@ -936,6 +977,15 @@ class quaternion:
         have to be normalized.
         """
 
+    @staticmethod
+    def from_rotation_matrix(
+        mat: npt.ArrayLike[np.float64],
+    ) -> satkit.quaternion:
+        """
+        Return quaternion representing right-handed rotation
+        represented by input 3x3 rotation matrix
+        """
+
     @staticmethod
     def rotx(theta) -> satkit.quaternion:
         """
@@ -994,7 +1044,7 @@ class quaternion:
         Return 3x3 rotation matrix representing equivalent rotation
         """
 
-    def to_euler(self) -> (float, float, float):
+    def to_euler(self) -> typing.Tuple[float, float, float]:
         """
         Return equivalent rotation angle represented as rotation angles:
         ("roll", "pitch", "yaw") in radians:
@@ -1009,7 +1059,7 @@ class quaternion:
         Return the angle in radians of the rotation
         """
 
-    def axis(self) -> npt.ArrayLike(np.float64):
+    def axis(self) -> npt.ArrayLike[np.float64]:
         """
         Return the axis of rotation as a unit vector
         """
@@ -1196,13 +1246,13 @@ class itrfcoord:
         """
 
     @property
-    def geodetic_rad(self) -> (float, float, float):
+    def geodetic_rad(self) -> typing.Tuple[float, float, float]:
         """
         Tuple with: (latitude_rad, longitude_rad, altitude)
         """
 
     @property
-    def geodetic_deg(self) -> (float, float, float):
+    def geodetic_deg(self) -> typing.Tuple[float, float, float]:
         """
         Tuple with (latitude_deg, longitude_deg, altitude)
         """
@@ -1227,7 +1277,7 @@ class itrfcoord:
         to ITRF at this location
         """
 
-    def geodesic_distance(self, other: itrfcoord) -> (float, float, float):
+    def geodesic_distance(self, other: itrfcoord) -> typing.Tuple[float, float, float]:
         """
         Use Vincenty formula to compute geodesic distance:
         https://en.wikipedia.org/wiki/Vincenty%27s_formulae

{satkit-0.2.4 → satkit-0.2.5}/python/satkit/density/__init__.pyi

@@ -13,7 +13,7 @@ import satkit
 
 
 @typing.overload
-def nrlmsise(itrf: satkit.itrfcoord, time: satkit.time | None) -> (float, float):
+def nrlmsise(itrf: satkit.itrfcoord, time: satkit.time | None) -> typing.Tuple[float, float]:
     """
     NRL MSISE-00 Atmosphere Density Model
     
@@ -44,7 +44,7 @@ def nrlmsise(itrf: satkit.itrfcoord, time: satkit.time | None) -> (float, float)
 def nrlmsise(altitude_meters: float,
              latitude_rad: float,
              longitude_rad: float,
-             time: satkit.time | None) -> (float, float):
+             time: satkit.time | None) -> typing.Tuple[float, float]:
     """
     NRL MSISE-00 Atmosphere Density Model
     

{satkit-0.2.4 → satkit-0.2.5}/python/satkit/jplephem/__init__.pyi

@@ -60,7 +60,7 @@ def barycentric_pos(body: satkit.solarsystem, tm: satkit.time|list[satkit.time]|
     """    
 
 def geocentric_state(body: satkit.solarsystem, 
-                     tm: satkit.time|list[satkit.time]|npt.ArrayLike[satkit.time]) -> (npt.ArrayLike[np.float64], npt.ArrayLike[np.float64]):
+                     tm: satkit.time|list[satkit.time]|npt.ArrayLike[satkit.time]) -> typing.Tuple[npt.ArrayLike[np.float64], npt.ArrayLike[np.float64]]:
     """
     Return geocentric (Earth-centered) state (position and velocity) for a given solar-system body
     at the given time or times in the GCRF frame 
@@ -88,7 +88,7 @@ def geocentric_state(body: satkit.solarsystem,
     """
     
 def barycentric_state(body: satkit.solarsystem, 
-                     tm: satkit.time|list[satkit.time]|npt.ArrayLike[satkit.time]) -> (npt.ArrayLike[np.float64], npt.ArrayLike[np.float64]):
+                     tm: satkit.time|list[satkit.time]|npt.ArrayLike[satkit.time]) -> typing.Tuple[npt.ArrayLike[np.float64], npt.ArrayLike[np.float64]]:
     """
     Return barycentric position and velocity for a given solar-system body
     at the given time or times.  The barycentric coordinate system origin 

{satkit-0.2.4 → satkit-0.2.5}/python/satkit/satprop/__init__.pyi

@@ -234,8 +234,8 @@ class propsettings:
         """
 
 def propagate(
-    pos: npt.ArrayLike(np.float64),
-    vel: npt.ArrayLike(np.float64),
+    pos: npt.ArrayLike[float],
+    vel: npt.ArrayLike[float],
     start: satkit.time,
     **kwargs,
 ) -> PropResult:

{satkit-0.2.4 → satkit-0.2.5}/python/satkit/sun/__init__.pyi

@@ -125,7 +125,7 @@ def pos_mod(
 def rise_set(time: satkit.time,
              coord: satkit.itrfcoord,
              sigma: float = 90.0 + 50.0/60.0
-             ) -> (satkit.time, satkit.time):
+             ) -> typing.Tuple[satkit.time, satkit.time]:
     """
     Sunrise and sunset times on the day given by input time
     and at the given location.  

{satkit-0.2.4 → satkit-0.2.5/python/satkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satkit
-Version: 0.2.4
+Version: 0.2.5
 Summary: Satellite Orbital Dynamics Toolkit
 Author-email: Steven Michael <ssmichael@gmail.com>
 Maintainer-email: Steven Michael <ssmichael@gmail.com>
@@ -19,16 +19,33 @@ Requires-Dist: numpy>=1.20.0
 
 # Satellite Toolkit with Rust
 
+An accurate, high-performance satellite orbital kinematics toolkit, written in Rust with a sensible interface.
+<br/>
+
+### Github
+
 ![Build Passing?](https://github.com/ssmichael1/satkit/actions/workflows/build.yml/badge.svg)
 ![Wheel Passing?](https://github.com/ssmichael1/satkit/actions/workflows/wheels.yml/badge.svg)
 ![GitHub License](https://img.shields.io/github/license/ssmichael1/satkit)
-<br/>
-An accurate, high-performance satellite orbital kinematics toolkit, written in Rust with a sensible interface.
+
+### Crates.io
+
+![Crates.io Version](https://img.shields.io/crates/v/satkit)
+![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/satkit)
+
+### PyPi
+
+![PyPI - Version](https://img.shields.io/pypi/v/satkit)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satkit)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/satkit)
+![PyPI - Status](https://img.shields.io/pypi/status/satkit)
 
 ## Language Bindings
 
 - **Native Rust** bindings
-- **Python bindings** for compiled rust code ... speed of Rust with convenience of Python
+- **Python bindings** for compiled rust code ... speed of Rust with convenience of Python<br/>
+  Install with `pip install satkit`<br/>
+  PyPi includes binaries for windows, macos (Intel & arm), and linux
 
 ## Features
 

{satkit-0.2.4 → satkit-0.2.5}/python/test/test.py

@@ -11,6 +11,78 @@ testvec_dir = os.getenv(
             "SATKIT_TESTVEC_ROOT", default="." + os.path.sep + "satkit-testvecs" + os.path.sep
         )
 
+class TestTime:
+    def test_mjd(self):
+        """
+        Test MJD conversion
+        """
+        t = sk.time(2021, 1, 1, 0, 0, 0)
+        mjd = t.to_mjd(sk.timescale.UTC)
+        assert mjd == pytest.approx(59215.0)
+
+    def test_jd(self):
+        """
+        Test JD conversion
+        """
+        t = sk.time(2021, 1, 1, 0, 0, 0)
+        jd = t.to_jd(sk.timescale.UTC)
+        assert jd == pytest.approx(2459215.5)
+
+    def test_duration(self):
+        """
+        Test duration conversion
+        """
+        d = sk.duration.from_seconds(86400)
+        assert d.seconds() == 86400
+        assert d.days() == 1.0
+
+    def test_time_diff(self):
+        """
+        Test time difference
+        """
+        t1 = sk.time(2021, 1, 1, 0, 0, 0)
+        t2 = sk.time(2021, 1, 2, 0, 0, 0)
+        d = t2 - t1
+        assert d.days() == 1.0
+
+    def test_time_add(self):
+        """
+        Test time addition
+        """
+        t1 = sk.time(2021, 1, 1, 0, 0, 0)
+        d = sk.duration.from_days(1)
+        t2 = t1 + d
+        assert t2 == sk.time(2021, 1, 2, 0, 0, 0)
+
+    def test_time_sub(self):
+        """
+        Test time subtraction
+        """
+        t1 = sk.time(2021, 1, 1, 0, 0, 0)
+        d = sk.duration.from_days(1)
+        t2 = t1 - d
+        assert t2 == sk.time(2020, 12, 31, 0, 0, 0)
+
+    def test_time_str(self):
+        """
+        Test string conversion of time
+        """
+        t = sk.time(2021, 1, 1, 0, 0, 0)
+        assert str(t) == "2021-01-01 00:00:00.000Z"
+
+    def test_time_gregorian(self):
+        """
+        Test conversion to Gregorian calendar
+        """
+        t = sk.time(2021, 1, 1, 0, 0, 0)
+        (year, mon, day, hour, minute, sec) = t.to_gregorian()
+        assert year == 2021
+        assert mon == 1
+        assert day == 1
+        assert hour == 0
+        assert minute == 0
+        assert sec == 0
+
 class TestJPLEphem:
     def test_jplephem_testvecs(self):
         """
@@ -107,7 +179,6 @@ class TestJPLEphem:
                     calc = (tvel - svel)[coord - 4] / sk.consts.au * 86400.0
                     assert calc == pytest.approx(truth, rel=1e-12)
 
-
 class TestGravity:
     def test_gravity(self):
         """
@@ -341,6 +412,53 @@ class TestQuaternion:
             m.pi / 2
         ).to_rotation_matrix() @ zhat == pytest.approx(xhat, 1.0e-10)
 
+    def test_dcm2quaternion(self):
+        """
+        Test conversion of DCM to quaternion
+        """
+        xhat = np.array([1.0, 0.0, 0.0])
+        yhat = np.array([0.0, 1.0, 0.0])
+        zhat = np.array([0.0, 0.0, 1.0])
+
+        q = sk.quaternion.from_rotation_matrix(sk.quaternion.rotz(m.pi / 2).to_rotation_matrix())
+        assert q * xhat == pytest.approx(yhat, 1.0e-10)
+
+
+    def test_quaternion2dcm(self):
+        """
+        Test conversion of quaternion to DCM
+        """
+        xhat = np.array([1.0, 0.0, 0.0])
+        yhat = np.array([0.0, 1.0, 0.0])
+        zhat = np.array([0.0, 0.0, 1.0])
+        q = sk.quaternion.from_rotation_matrix(sk.quaternion.rotz(m.pi / 2).to_rotation_matrix())
+        dcm = q.to_rotation_matrix()
+        assert dcm @ xhat == pytest.approx(yhat, 1.0e-10)
+
+    def test_quaternion2euler(self):
+        """
+        Test conversion of quaternion to Euler angles
+        """
+        q = sk.quaternion.rotz(m.pi/3)
+        euler = q.to_euler()
+        assert euler[0] == pytest.approx(0.0)
+        assert euler[1] == pytest.approx(0.0)
+        assert euler[2] == pytest.approx(m.pi/3)
+
+        q = sk.quaternion.rotx(m.pi/3)
+        euler = q.to_euler()
+        assert euler[0] == pytest.approx(m.pi/3)
+        assert euler[1] == pytest.approx(0.0)
+        assert euler[2] == pytest.approx(0.0)
+
+        q = sk.quaternion.roty(m.pi/3)
+        euler = q.to_euler()
+        assert euler[0] == pytest.approx(0.0)
+        assert euler[1] == pytest.approx(m.pi/3)
+        assert euler[2] == pytest.approx(0.0)
+        
+
+
 
 class TestGeodesicDistance:
 

{satkit-0.2.4 → satkit-0.2.5}/src/astrotime.rs

@@ -91,6 +91,16 @@ const DELTAAT_OLD: [[f64; 4]; 15] = [
 
 /// Time Scales
 ///
+/// # Enum Values:
+/// 
+/// * `UTC` - Univeral Time Coordiante
+/// * `TT` - Terrestrial Time
+/// * `UT1` - UT1
+/// * `TAI` - International Atomic Time
+/// * `GPS` - Global Positioning System
+/// * `TDB` - Barycentric Dynamical Time
+/// * `INVALID` - Invalid
+///    
 #[derive(PartialEq, Debug)]
 pub enum Scale {
     /// Invalid

{satkit-0.2.4 → satkit-0.2.5}/src/earth_orientation_params.rs

@@ -173,6 +173,25 @@ pub fn update() -> SKResult<()> {
     Ok(())
 }
 
+
+///
+/// Get Earth Orientation Parameters at given Modified Julian Date (UTC)
+/// Returns None if no data is available for the given date
+/// 
+/// # Arguments:
+/// 
+/// * `mjd_utc` - Modified Julian Date (UTC)
+/// 
+/// # Returns:
+/// 
+/// * Vector [f64; 6] with following elements:
+/// * 0 : (UT1 - UTC) in seconds
+/// * 1 : X polar motion in arcsecs
+/// * 2 : Y polar motion in arcsecs
+/// * 3 : LOD: instantaneous rate of change in (UT1-UTC), msec/day
+/// * 4 : dX wrt IAU-2000 Nutation, milli-arcsecs
+/// * 5 : dY wrt IAU-2000 Nutation, milli-arcsecs
+/// 
 pub fn eop_from_mjd_utc(mjd_utc: f64) -> Option<[f64; 6]> {
     let eop = eop_params_singleton().read().unwrap();
 
@@ -207,9 +226,9 @@ pub fn eop_from_mjd_utc(mjd_utc: f64) -> Option<[f64; 6]> {
 ///
 /// * tm: Instant at which to query parameters
 ///
-/// # Return:
+/// # Returns:
 ///
-/// * Vector [f64; 4] with following elements:
+/// * Vector [f64; 6] with following elements:
 ///   * 0 : (UT1 - UTC) in seconds
 ///   * 1 : X polar motion in arcsecs
 ///   * 2 : Y polar motion in arcsecs