satkit 0.9.1__tar.gz → 0.9.2__tar.gz

satkit-0.9.2/.github/workflows/cargo-publish.yml

@@ -0,0 +1,35 @@
+name: Publish Rust crate
+
+on:
+  push:
+    tags:
+      - "rust_*"
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: crates-io
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Verify tag matches Cargo.toml
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#rust_}"
+          CARGO_VERSION=$(cargo metadata --format-version 1 --no-deps | jq -r '.packages[0].version')
+          if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
+            echo "Tag version ($TAG_VERSION) does not match Cargo.toml version ($CARGO_VERSION)."
+            exit 1
+          fi
+
+      - name: Publish to crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo publish

{satkit-0.9.1 → satkit-0.9.2}/.github/workflows/wheels.yml

@@ -32,7 +32,7 @@ jobs:
             platform: linux
             testvec_path: satkit-testvecs
             data_path: astro-data
-            activatestr: source .venv/bin/activate          
+            activatestr: source .venv/bin/activate
           - os: windows-latest
             testvec_path: satkit-testvecs
             data_path: astro-data
@@ -63,7 +63,7 @@ jobs:
           key: satkit-data-cache
 
       # Download data if it is not in the cache
-      - name: Download Satkit Data 
+      - name: Download Satkit Data
         if: steps.cache-satkit-data.outputs.cache-hit != 'true'
         run: |
           python -m venv .venv
@@ -79,11 +79,11 @@ jobs:
         with:
           path: ${{matrix.testvec_path}}
           enableCrossOsArchive: True
-          key: satkit-testvecs-cache        
+          key: satkit-testvecs-cache
 
       # Download test vectors if they are not in the cache
-      - name: Download Satkit Test Vectors 
-        if: steps.cache-satkit-testvecs.outputs.cache-hit != 'true' 
+      - name: Download Satkit Test Vectors
+        if: steps.cache-satkit-testvecs.outputs.cache-hit != 'true'
         run: |
           python -m venv .venv
           ${{matrix.activatestr}}
@@ -106,7 +106,7 @@ jobs:
           source .venv/bin/activate
           python -m pip install build
           python -m build --sdist . -o wheelhouse
-          
+
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4
@@ -135,3 +135,31 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           packages-dir: dist/
+
+  readthedocs:
+      runs-on: ubuntu-latest
+      needs: publish_wheels
+      environment: readthedocs
+      steps:
+        - name: Trigger Read the Docs builds (stable + latest)
+          env:
+            RTD_TOKEN: ${{ secrets.RTD_TOKEN }}   # store this in the 'readthedocs' Environment secrets
+            RTD_HOST: app.readthedocs.org
+            RTD_PROJECT: satellite-toolkit
+          run: |
+            set -euo pipefail
+
+            # Give PyPI a moment to propagate the new release
+            sleep 20
+
+            # Optional: sync versions/tags
+            curl -fsS -X POST "https://${RTD_HOST}/api/v3/projects/${RTD_PROJECT}/sync-versions/" \
+              -H "Authorization: Token ${RTD_TOKEN}"
+
+            # Build stable
+            curl -fsS -X POST "https://${RTD_HOST}/api/v3/projects/${RTD_PROJECT}/versions/stable/builds/" \
+              -H "Authorization: Token ${RTD_TOKEN}"
+
+            # Build latest
+            curl -fsS -X POST "https://${RTD_HOST}/api/v3/projects/${RTD_PROJECT}/versions/latest/builds/" \
+              -H "Authorization: Token ${RTD_TOKEN}"

{satkit-0.9.1 → satkit-0.9.2}/CHANGES.md

@@ -164,3 +164,6 @@
   - bugfix: handle high-precision propagation without error when duration is zero
   - Fix Rust documentation for SGP4 to accurately represent sgp4 source
   - Add a "zero" static function for duration to represent zero duration
+
+## Rust 0.9.3, Python 0.9.2
+  - bugfix: Fix (and document in python) the `to_enu` and `to_ned` functions in ITRFCoord

{satkit-0.9.1 → satkit-0.9.2}/Cargo.toml

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

{satkit-0.9.1 → satkit-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: satkit
-Version: 0.9.1
+Version: 0.9.2
 Summary: Satellite Orbital Dynamics Toolkit
 Author-email: Steven Michael <ssmichael@gmail.com>
 Maintainer-email: Steven Michael <ssmichael@gmail.com>

{satkit-0.9.1 → satkit-0.9.2}/pyproject.toml

@@ -9,7 +9,7 @@ requires-python = ">= 3.8"
 authors = [{ name = "Steven Michael", email = "ssmichael@gmail.com" }]
 maintainers = [{ name = "Steven Michael", email = "ssmichael@gmail.com" }]
 readme = "README.md"
-version = "0.9.1"
+version = "0.9.2"
 license = { file = "LICENSE" }
 description = "Satellite Orbital Dynamics Toolkit"
 keywords = [
@@ -40,6 +40,8 @@ classifiers = [
 [project.optional-dependencies]
 test = ["pytest", "xmltodict"]
 
+[tool.setuptools]
+license-files = ["LICENSE"]
 
 [tool.setuptools.packages.find]
 where = ["python"]

{satkit-0.9.1 → satkit-0.9.2}/python/requirements.txt

@@ -103,7 +103,7 @@ rfc3986-validator==0.1.1; python_version >= '2.7' and python_version not in '3.0
 rpds-py==0.22.3; python_version >= '3.9'
 rsa==4.9; python_version >= '3.6'
 satkit-data==0.8.0; python_version >= '3.8'
-satkit==0.9.1; python_version >= '3.8'
+satkit; python_version >= '3.8'
 scipy==1.16.2; python_version >= '3.10'
 send2trash==1.8.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'
 setuptools==75.8.0; python_version >= '3.9'

{satkit-0.9.1 → satkit-0.9.2}/python/satkit/_version.py

@@ -14,5 +14,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = "0.9.1"
-__version_tuple__ = version_tuple = (0, 9, 1)
+__version__ = version = "0.9.2"
+__version_tuple__ = version_tuple = (0, 9, 2)

{satkit-0.9.1 → satkit-0.9.2}/python/satkit/satkit.pyi

@@ -2066,6 +2066,34 @@ class itrfcoord:
             satkit.quaternion: Quaternion representiong rotation from East-North-Up (ENU) to ITRF at this location
         """
 
+    def to_enu(self, refcoord: itrfcoord) -> npt.NDArray[np.float64]:
+        """Return vector from reference coordinate to this coordinate in East-North-Up (ENU) frame of the reference coordinate
+
+        Args:
+            refcoord (itrfcoord): Reference ITRF coordinate representing origin of ENU frame
+
+        Returns:
+            npt.NDArray[np.float64]: 3-element numpy array representing vector from reference coordinate to this coordinate in East-North-Up (ENU) frame of reference at the reference coordinate
+
+        Note:
+            * This is equivalent to calling: refcoord.qenu2itrf.conj * (self - refcoord)
+
+        """
+
+    def to_ned(self, refcoord: itrfcoord) -> npt.NDArray[np.float64]:
+        """Return vector from reference coordinate to this coordinate in North-East-Down (NED) at the reference coordinate
+
+        Args:
+            refcoord (itrfcoord): Reference ITRF coordinate representing origin of NED frame
+
+        Returns:
+            npt.NDArray[np.float64]: 3-element numpy array representing vector from reference coordinate to this coordinate in North-East-Down (NED) frame of reference at the reference coordinate
+
+        Note:
+            * This is equivalent to calling: refcoord.qned2itrf.conj * (self - refcoord)
+
+        """
+
     def __sub__(self, other: itrfcoord) -> npt.NDArray[np.float64]:
         """Subtract another ITRF coordinate from this one
 

{satkit-0.9.1 → satkit-0.9.2}/python/satkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: satkit
-Version: 0.9.1
+Version: 0.9.2
 Summary: Satellite Orbital Dynamics Toolkit
 Author-email: Steven Michael <ssmichael@gmail.com>
 Maintainer-email: Steven Michael <ssmichael@gmail.com>

{satkit-0.9.1 → satkit-0.9.2}/python/satkit.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ README.md
 build.rs
 pyproject.toml
 .github/workflows/build.yml
+.github/workflows/cargo-publish.yml
 .github/workflows/wheels.yml
 extern/nrlmsise/DOCUMENTATION
 extern/nrlmsise/nrlmsise-00.c

{satkit-0.9.1 → satkit-0.9.2}/python/test/test.py

@@ -492,6 +492,85 @@ class TestITRFCoord:
         assert itrf.longitude_deg == pytest.approx(46.4464)
 
 
+    def test_ned_enu(self):
+
+        """
+        Test NED and ENU conversions
+        """
+        refcoord = sk.itrfcoord(
+            latitude_deg=30.0, longitude_deg=-90.0, altitude=0.0
+        )
+        testcoord = sk.itrfcoord(
+            latitude_deg=30.0, longitude_deg=-90.0, altitude=100.0
+        )
+
+        ned = testcoord.to_ned(refcoord)
+        enu = testcoord.to_enu(refcoord)
+
+        # Check NED values
+        # North component
+        assert ned[0] == pytest.approx(0, abs=1e-8)
+        # East component
+        assert ned[1] == pytest.approx(0, abs=1e-8)
+        # Down component
+        assert ned[2] == pytest.approx(-100.0, rel=1e-8)
+
+        # Check ENU values
+        # East component
+        assert enu[0] == pytest.approx(0, abs=1e-8)
+        # North component
+        assert enu[1] == pytest.approx(0, abs=1e-8)
+        # Up component
+        assert enu[2] == pytest.approx(100.0, abs=1e-8)
+
+        coord1 = sk.itrfcoord(latitude_deg=42.466, longitude_deg=-71.1516, altitude=10.0)
+
+        # Go east 10 meters and check
+        coord2 = sk.itrfcoord(coord1.vector + coord1.qenu2itrf * np.array([10.0, 0.0, 0.0]))
+        enu = coord2.to_enu(coord1)
+        assert enu[0] == pytest.approx(10.0, abs=1e-8)
+        assert enu[1] == pytest.approx(0.0, abs=1e-8)
+        assert enu[2] == pytest.approx(0.0, abs=1e-8)
+
+        # Go north 10 meters and check
+        coord2 = sk.itrfcoord(coord1.vector + coord1.qenu2itrf * np.array([0.0, 10.0, 0.0]))
+        enu = coord2.to_enu(coord1)
+        assert enu[0] == pytest.approx(0.0, abs=1e-8)
+        assert enu[1] == pytest.approx(10.0, abs=1e-8)
+        assert enu[2] == pytest.approx(0.0, abs=1e-8)
+
+        # Go up 10 meters and check
+        coord2 = sk.itrfcoord(coord1.vector + coord1.qenu2itrf * np.array([0.0, 0.0, 10.0]))
+        enu = coord2.to_enu(coord1)
+        assert enu[0] == pytest.approx(0.0, abs=1e-8)
+        assert enu[1] == pytest.approx(0.0, abs=1e-8)
+        assert enu[2] == pytest.approx(10.0, abs=1e-8)
+
+        for ix in range(50):
+            # Create random coordinates
+            lat1 = np.random.uniform(-90.0, 90.0)
+            lon1 = np.random.uniform(-180.0, 180.0)
+            alt1 = np.random.uniform(100.0, 40000.0)
+            lat2 = np.random.uniform(-90.0, 90.0)
+            lon2 = np.random.uniform(-180.0, 180.0)
+            alt2 = np.random.uniform(100.0, 40000.0)
+            coord1 = sk.itrfcoord(latitude_deg=lat1, longitude_deg=lon1, altitude=alt1)
+            coord2 = sk.itrfcoord(latitude_deg=lat2, longitude_deg=lon2, altitude=alt2)
+
+            # Check to_ned, to_enu against manually computed values
+            ned = coord2.to_ned(coord1)
+            enu = coord2.to_enu(coord1)
+            ned2 = coord1.qned2itrf.conj * (coord2-coord1)
+            enu2 = coord1.qenu2itrf.conj * (coord2-coord1)
+            assert ned[0] == pytest.approx(ned2[0], rel=1e-8)
+            assert ned[1] == pytest.approx(ned2[1], rel=1e-8)
+            assert ned[2] == pytest.approx(ned2[2], rel=1e-8)
+            assert enu[0] == pytest.approx(enu2[0], rel=1e-8)
+            assert enu[1] == pytest.approx(enu2[1], rel=1e-8)
+            assert enu[2] == pytest.approx(enu2[2], rel=1e-8)
+
+
+
 class TestMoon:
     def test_moonpos(self):
         """

{satkit-0.9.1 → satkit-0.9.2}/src/itrfcoord.rs

@@ -523,7 +523,8 @@ impl ITRFCoord {
     }
 
     /// Convert coordinate to a North-East-Down (NED)
-    /// coordinate relative to a reference coordinate
+    /// position relative to a reference coordinate
+    /// (in the NED frame of the reference coordinate)
     ///
     /// # Arguments
     ///
@@ -534,6 +535,10 @@ impl ITRFCoord {
     /// * `nalgebra::Vector3<f64>` representing NED position
     ///   relative to reference.  Units are meters
     ///
+    /// # Note:
+    ///   Equivalent to:
+    ///         `ref_coord.q_ned2itrf().conjugate() * (self.itrf - ref_coord.itrf)`
+    ///
     /// # Examples:
     /// ```
     /// use satkit::itrfcoord::ITRFCoord;
@@ -548,7 +553,7 @@ impl ITRFCoord {
     /// ```
     ///
     pub fn to_ned(&self, ref_coord: &Self) -> Vector3 {
-        self.q_ned2itrf().conjugate() * (self.itrf - ref_coord.itrf)
+        ref_coord.q_ned2itrf().conjugate() * (self.itrf - ref_coord.itrf)
     }
 
     /// Return quaternion representing rotation from the
@@ -561,7 +566,8 @@ impl ITRFCoord {
     }
 
     /// Convert coordinate to a East-North-Up (ENU)
-    /// coordinate relative to a reference coordinate
+    /// position relative to a reference coordinate
+    /// (in the ENU frame of the reference coordinate)
     ///
     /// # Arguments
     ///
@@ -572,6 +578,11 @@ impl ITRFCoord {
     /// * `nalgebra::Vector3<f64>` representing ENU position
     ///   relative to reference.  Units are meters
     ///
+    ///
+    /// # Note:
+    ///   Equivalent to:
+    ///       `ref_coord.q_enu2itrf().conjugate() * (self.itrf - ref_coord.itrf)`
+    ///
     /// # Examples:
     /// ```
     /// use satkit::itrfcoord::ITRFCoord;
@@ -585,8 +596,8 @@ impl ITRFCoord {
     /// // Should return [0.0, 0.0, -100.0]
     /// ```
     ///
-    pub fn to_enu(&self, other: &Self) -> Vector3 {
-        self.q_enu2itrf().conjugate() * (self.itrf - other.itrf)
+    pub fn to_enu(&self, ref_coord: &Self) -> Vector3 {
+        ref_coord.q_enu2itrf().conjugate() * (self.itrf - ref_coord.itrf)
     }
 }
 
@@ -667,7 +678,25 @@ mod tests {
         */
 
         let itrf1 = ITRFCoord::from_geodetic_deg(lat_deg, lon_deg, hae);
-        let itrf2 = itrf1 + itrf1.q_ned2itrf() * nalgebra::vector![0.0, 0.0, 10000.0];
-        println!("height diff = {}", itrf2.hae() - itrf1.hae());
+
+        // Go east 10 meters
+        let itrf3 = itrf1 + itrf1.q_enu2itrf() * nalgebra::vector![10.0, 0.0, 0.0];
+        let (lat3, lon3, _h3) = itrf3.to_geodetic_deg();
+        assert!(((lat3 - lat_deg) / lat_deg).abs() < 1.0e-6);
+        assert!(((lon3 - (lon_deg + 0.000129)) / lon_deg).abs() < 1.0e-6);
+
+        // Go north 10 meters
+        let itrf4 = itrf1 + itrf1.q_enu2itrf() * nalgebra::vector![0.0, 10.0, 0.0];
+        let (lat4, lon4, _h4) = itrf4.to_geodetic_deg();
+        assert!(((lat4 - (lat_deg + 0.000090)) / lat_deg).abs() < 1.0e-6);
+        assert!(((lon4 - lon_deg) / lon_deg).abs() < 1.0e-6);
+
+        // Go up 10 meters
+        let itrf5 = itrf1 + itrf1.q_enu2itrf() * nalgebra::vector![0.0, 0.0, 10.0];
+        let (lat5, lon5, h5) = itrf5.to_geodetic_deg();
+        assert!(((lat5 - lat_deg) / lat_deg).abs() < 1.0e-6);
+        assert!(((lon5 - lon_deg) / lon_deg).abs() < 1.0e-6);
+        assert!(((h5 - (hae + 10.0)) / hae).abs() < 1.0e-6);
+
     }
 }

{satkit-0.9.1 → satkit-0.9.2}/src/pybindings/pyitrfcoord.rs

@@ -26,7 +26,7 @@ use super::pyutils::*;
 ///
 /// Args:
 ///     vec (numpy.ndarray, list, or 3-element tuple of floats, optional): ITRF Cartesian location in meters
-///  
+///
 /// Keyword Args:
 ///     latitude_deg (float, optional): Latitude in degrees
 ///     longitude_deg (float, optional): Longitude in degrees
@@ -34,13 +34,13 @@ use super::pyutils::*;
 ///     longitude_rad (float, optional): Longitude in radians
 ///     altitude (float, optional): Height above ellipsoid, meters
 ///     height (float, optional): Height above ellipsoid, meters
-///     
+///
 ///
 /// Returns:
 ///     itrfcoord: New ITRF coordinate
 ///
 /// Example:
-///     * Create ITRF coord from Cartesian        
+///     * Create ITRF coord from Cartesian
 ///        >>> coord = itrfcoord([ 1523128.63570828 -4461395.28873207  4281865.94218203 ])
 ///        >>> print(coord)
 ///        ITRFCoord(lat:  42.4400 deg, lon: -71.1500 deg, hae:  0.10 km)
@@ -50,7 +50,7 @@ use super::pyutils::*;
 ///        >>> coord = itrfcoord(latitude_deg=42.44, longitude_deg=-71.15, altitude=100)
 ///        >>> print(coord)
 ///        ITRFCoord(lat:  42.4400 deg, lon: -71.1500 deg, hae:  0.10 km)
-///       
+///
 ///
 #[pyclass(name = "itrfcoord", module = "satkit")]
 #[derive(Clone)]
@@ -239,15 +239,15 @@ impl PyITRFCoord {
         self.0.q_enu2itrf().into()
     }
 
-    /// Return East-North-Up location of input coordinate relative to self
+    /// Return East-North-Up location of self relative to input reference coordinate
     ///
     /// Args:
-    ///     other (itrfcoord): ITRF coordinate for which to compute ENU location
+    ///     refcoord (itrfcoord): ITRF reference coordinate against which to compute ENU location
     ///
     /// Returns:
-    ///     numpy.ndarray: 3-element numpy array of floats representing ENU location in meters of other relative to self
-    fn to_enu(&self, other: &Self) -> Py<PyAny> {
-        let v = self.0.q_enu2itrf().conjugate() * (self.0.itrf - other.0.itrf);
+    ///     numpy.ndarray: 3-element numpy array of floats representing ENU location in meters of self relative to refcoord
+    fn to_enu(&self, refcoord: &Self) -> Py<PyAny> {
+        let v = refcoord.0.q_enu2itrf().conjugate() * (self.0.itrf - refcoord.0.itrf);
         pyo3::Python::attach(|py| -> Py<PyAny> {
             numpy::PyArray::from_slice(py, v.data.as_slice())
                 .into_py_any(py)
@@ -255,15 +255,15 @@ impl PyITRFCoord {
         })
     }
 
-    /// Return North-East-Down location of input coordinate relative to self
+    /// Return North-East-Down location of self relative to input reference coordinate
     ///
     /// Args:
-    ///     other (itrfcoord): ITRF coordinate for which to compute NED location
+    ///     refcoord (itrfcoord): ITRF reference coordinate against which to compute NED location
     ///
     /// Returns:
-    ///     numpy.ndarray: 3-element numpy array of floats representing NED location in meters of other relative to self
+    ///     numpy.ndarray: 3-element numpy array of floats representing NED location in meters of self relative to refcoord
     fn to_ned(&self, other: &Self) -> Py<PyAny> {
-        let v = self.0.q_ned2itrf().conjugate() * (self.0.itrf - other.0.itrf);
+        let v = other.0.q_ned2itrf().conjugate() * (self.0.itrf - other.0.itrf);
         pyo3::Python::attach(|py| -> Py<PyAny> {
             numpy::PyArray::from_slice(py, v.data.as_slice())
                 .into_py_any(py)