ruststartracker 0.2.1__tar.gz → 0.2.2__tar.gz

{ruststartracker-0.2.1 → ruststartracker-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ruststartracker
-Version: 0.2.1
+Version: 0.2.2
 Summary: Lightweight Python Star Tracker With Rust Backend
 License: MIT
 Author: Nicolas Tobler
@@ -14,6 +14,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: numpy (>=1.26.0,<2.0.0)
 Requires-Dist: opencv-python-headless (>=4.9.0,<5.0.0)
+Project-URL: GaiaAttribution, https://www.cosmos.esa.int/gaia
+Project-URL: Homepage, https://github.com/ntobler/ruststartracker
+Project-URL: License, https://opensource.org/licenses/MIT
 Description-Content-Type: text/markdown
 
 # Lightweight Python Star Tracker With Rust Backend
@@ -35,8 +38,8 @@ Features:
 import ruststartracker
 
 # Get catalog positions
-catalog = ruststartracker.StarCatalog()
-star_catalog_vecs = catalog.normalized_positions()
+catalog = ruststartracker.StarCatalog(max_magnitude=...)
+star_catalog_vecs = catalog.normalized_positions(epoch=...)
 
 # Define opencv camera parameters, see https://docs.opencv.org/4.x/dc/dbb/tutorial_py_calibration.html
 camera_params = ruststartracker.CameraParameters(
@@ -52,6 +55,7 @@ st = ruststartracker.StarTracker(
     max_inter_star_angle=...,
     inter_star_angle_tolerance=...,
     n_minimum_matches=...,
+    timeout_secs=...,
 )
 
 # Obtain numpy array image
@@ -66,11 +70,22 @@ print(result)
 
 ## Installation
 
-- Make sure rust tool chain (`cargo`) is installed and in the `PATH` environment variable.
-- Install with `pip install git+https://github.com/ntobler/ruststartracker.git`.
+- Install with `pip install ruststartracker` (Currently only ARM/x86 Linux wheels available).
 
 ## TODOs
 
 - Improve error messages.
 - Return more diagnostic data.
 
+## Attributions
+
+### Gaia Data
+
+This project includes data from the European Space Agency (ESA) mission [**Gaia**](https://www.cosmos.esa.int/gaia), processed by the **Gaia Data Processing and Analysis Consortium (DPAC)**.
+Funding for the DPAC has been provided by national institutions, in particular the institutions participating in the Gaia Multilateral Agreement.
+
+Gaia DR3 data is © European Space Agency and is released under the [**Creative Commons Attribution 4.0 International License (CC BY 4.0)**](https://creativecommons.org/licenses/by/4.0/).
+
+> Gaia Collaboration, Vallenari et al. (2022), *A\&A* **674**, A1.
+> [DOI: 10.1051/0004-6361/202243940](https://doi.org/10.1051/0004-6361/202243940)
+

{ruststartracker-0.2.1 → ruststartracker-0.2.2}/README.md

@@ -17,8 +17,8 @@ Features:
 import ruststartracker
 
 # Get catalog positions
-catalog = ruststartracker.StarCatalog()
-star_catalog_vecs = catalog.normalized_positions()
+catalog = ruststartracker.StarCatalog(max_magnitude=...)
+star_catalog_vecs = catalog.normalized_positions(epoch=...)
 
 # Define opencv camera parameters, see https://docs.opencv.org/4.x/dc/dbb/tutorial_py_calibration.html
 camera_params = ruststartracker.CameraParameters(
@@ -34,6 +34,7 @@ st = ruststartracker.StarTracker(
     max_inter_star_angle=...,
     inter_star_angle_tolerance=...,
     n_minimum_matches=...,
+    timeout_secs=...,
 )
 
 # Obtain numpy array image
@@ -48,10 +49,21 @@ print(result)
 
 ## Installation
 
-- Make sure rust tool chain (`cargo`) is installed and in the `PATH` environment variable.
-- Install with `pip install git+https://github.com/ntobler/ruststartracker.git`.
+- Install with `pip install ruststartracker` (Currently only ARM/x86 Linux wheels available).
 
 ## TODOs
 
 - Improve error messages.
 - Return more diagnostic data.
+
+## Attributions
+
+### Gaia Data
+
+This project includes data from the European Space Agency (ESA) mission [**Gaia**](https://www.cosmos.esa.int/gaia), processed by the **Gaia Data Processing and Analysis Consortium (DPAC)**.
+Funding for the DPAC has been provided by national institutions, in particular the institutions participating in the Gaia Multilateral Agreement.
+
+Gaia DR3 data is © European Space Agency and is released under the [**Creative Commons Attribution 4.0 International License (CC BY 4.0)**](https://creativecommons.org/licenses/by/4.0/).
+
+> Gaia Collaboration, Vallenari et al. (2022), *A\&A* **674**, A1.
+> [DOI: 10.1051/0004-6361/202243940](https://doi.org/10.1051/0004-6361/202243940)

ruststartracker-0.2.2/build_script.py

@@ -0,0 +1,60 @@
+"""Build rust backend.
+
+This script is automatically run when the pyproject is installed.
+"""
+
+import pathlib
+import shutil
+import subprocess
+
+
+def download_gaia_data(output_file: pathlib.Path) -> None:
+    """Download Gaia data and save it to the specified output file.
+
+    Args:
+        output_file: Path to save the downloaded Gaia data (csv).
+    """
+    from astroquery.gaia import Gaia
+
+    Gaia.ROW_LIMIT = 10000
+
+    query = """
+    SELECT source_id, ra, dec, parallax, pmra, pmdec, phot_g_mean_mag
+    FROM gaiadr3.gaia_source
+    WHERE phot_g_mean_mag < 7
+        AND parallax > 0
+        AND astrometric_params_solved = 31
+        AND visibility_periods_used >= 8
+    """
+
+    print("Executing query on Gaia database...")
+    job = Gaia.launch_job_async(
+        query,
+        dump_to_file=True,
+        output_format="csv",
+        output_file=str(output_file.absolute()),
+        verbose=True,
+    )
+    if not job.is_finished():
+        print("Job did not finish successfully.")
+        return
+
+    print(f"Saved to: {output_file}")
+
+
+def build_script() -> None:
+    """Build rust backend and move shared library to correct folder."""
+    cwd = pathlib.Path(__file__).parent.expanduser().absolute()
+
+    gaia_file = cwd / "ruststartracker/gaia_data_j2016.csv"
+    if not gaia_file.exists():
+        download_gaia_data(gaia_file)
+
+    subprocess.check_call(["cargo", "build", "--release"], cwd=cwd)  # noqa: S603, S607
+    shutil.copy(
+        cwd / "target/release/libruststartracker.so", cwd / "ruststartracker/libruststartracker.so"
+    )
+
+
+if __name__ == "__main__":
+    build_script()

{ruststartracker-0.2.1 → ruststartracker-0.2.2}/pyproject.toml

@@ -1,15 +1,20 @@
 [tool.poetry]
 name = "ruststartracker"
-version = "0.2.1"
+version = "0.2.2"
 description = "Lightweight Python Star Tracker With Rust Backend"
 authors = ["Nicolas Tobler <nitobler@gmail.com>"]
 readme = "README.md"
 license = "MIT"
 include = [
-    { path = "ruststartracker/star_catalog.tsv", format = ["sdist", "wheel"] },
+    { path = "ruststartracker/gaia_data_j2016.csv", format = ["sdist", "wheel"] },
     { path = "ruststartracker/libruststartracker.so", format = ["wheel"] },
 ]
 
+[tool.poetry.urls]
+Homepage = "https://github.com/ntobler/ruststartracker"
+License = "https://opensource.org/licenses/MIT"
+GaiaAttribution = "https://www.cosmos.esa.int/gaia"
+
 [tool.poetry.dependencies]
 python = "^3.10"
 numpy = "^1.26.0"
@@ -27,16 +32,17 @@ mypy = "^1.13.0"
 scipy-stubs = "^1.14.1.5"
 ruff = "^0.9.3"
 bump-my-version = "^1.2.0"
+astroquery = "^0.4.10"
 
 [tool.poetry.build]
-script = "rust_build.py"
+script = "build_script.py"
 
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core", "astroquery>=0.4.10"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.bumpversion]
-current_version = "0.2.1"
+current_version = "0.2.2"
 commit = true
 tag = true
 tag_name = "v{new_version}"

{ruststartracker-0.2.1 → ruststartracker-0.2.2}/ruststartracker/catalog.py

@@ -11,7 +11,9 @@ import numpy.typing as npt
 AU: float = 149597870.693
 """Astronomical unit."""
 
-INTERNAL_CATALOG_FILE = pathlib.Path(__file__).parent.expanduser().absolute() / "star_catalog.tsv"
+INTERNAL_CATALOG_FILE = (
+    pathlib.Path(__file__).parent.expanduser().absolute() / "gaia_data_j2016.csv"
+)
 """Location of the internal star catalog file."""
 
 
@@ -26,7 +28,7 @@ def time_to_epoch(t: datetime.datetime) -> float:
 
 
 class StarCatalog:
-    """Star catalog from Hipparcos data."""
+    """Star catalog from Gaia data."""
 
     _data: npt.NDArray[np.float32]
     """Underlying data array."""
@@ -42,7 +44,7 @@ class StarCatalog:
     """Proper motion of the declination in mad."""
     magnitude: npt.NDArray[np.float32]
     """Magnitude values."""
-    epoch: float = 1992.25
+    epoch: float = 2016.0
     """Epoch of the catalog in years."""
 
     def __init__(
@@ -57,13 +59,10 @@ class StarCatalog:
         # Use locally included star catalog is no file is given
         filename = INTERNAL_CATALOG_FILE if filename is None else pathlib.Path(filename)
 
-        keep_columns = ("RArad", "DErad", "Plx", "pmRA", "pmDE", "Hpmag")
+        keep_columns = ("ra", "dec", "parallax", "pmra", "pmdec", "phot_g_mean_mag")
 
         with filename.open("r") as f:
-            it = csv.reader(f, delimiter="\t", strict=True)
-
-            # skip head
-            [next(it) for _ in range(52)]
+            it = csv.reader(f, delimiter=",", strict=True)
 
             # Get columns
             columns = next(it)
@@ -71,10 +70,7 @@ class StarCatalog:
             keep_columns_indices = tuple(columns.index(x) for x in keep_columns)
             min_length = len(keep_columns_indices)
 
-            mag_column_index = columns.index("Hpmag")
-
-            # Skip unit and horizontal bar
-            [next(it) for _ in range(2)]
+            mag_column_index = columns.index("phot_g_mean_mag")
 
             rows = [
                 [float(line[j]) for j in keep_columns_indices]
@@ -83,12 +79,12 @@ class StarCatalog:
             ]
         self._data = np.array(rows, dtype=np.float32)
 
-        self.ra = self._data[:, keep_columns.index("RArad")]
-        self.de = self._data[:, keep_columns.index("DErad")]
-        self.parallax = self._data[:, keep_columns.index("Plx")]
-        self.proper_motion_ra = self._data[:, keep_columns.index("pmRA")]
-        self.proper_motion_de = self._data[:, keep_columns.index("pmDE")]
-        self.magnitude = self._data[:, keep_columns.index("Hpmag")]
+        self.ra = self._data[:, keep_columns.index("ra")]
+        self.de = self._data[:, keep_columns.index("dec")]
+        self.parallax = self._data[:, keep_columns.index("parallax")]
+        self.proper_motion_ra = self._data[:, keep_columns.index("pmra")]
+        self.proper_motion_de = self._data[:, keep_columns.index("pmdec")]
+        self.magnitude = self._data[:, keep_columns.index("phot_g_mean_mag")]
 
         deg2rad = math.pi / 180
         arcsec2deg = 1 / 3600

{ruststartracker-0.2.1 → ruststartracker-0.2.2}/ruststartracker/test_integration.py

@@ -25,7 +25,7 @@ def prepare() -> tuple[ruststartracker.StarTracker, np.ndarray]:
     dist_coefs = np.array([-0.44120807, -0.15954202, 0.00767012, -0.00213292, -1.64788247])
 
     catalog = ruststartracker.StarCatalog()
-    star_catalog_vecs = catalog.normalized_positions()
+    star_catalog_vecs = catalog.normalized_positions(epoch=2024)
 
     camera_params = ruststartracker.CameraParameters(
         camera_matrix=camera_matrix,
@@ -36,39 +36,13 @@ def prepare() -> tuple[ruststartracker.StarTracker, np.ndarray]:
     st = ruststartracker.StarTracker(
         star_catalog_vecs,
         camera_params,
-        inter_star_angle_tolerance=np.radians(0.1).item(),
+        inter_star_angle_tolerance=np.radians(0.05).item(),
         n_minimum_matches=5,
     )
 
     return st, star_catalog_vecs
 
 
-def test_example(prepare: tuple[ruststartracker.StarTracker, np.ndarray]):
-    os.environ["RUST_BACKTRACE"] = "1"
-
-    st, _ = prepare
-
-    obs = np.array(
-        [
-            [0.11975033, -0.02227603, 0.9925541],
-            [0.03917335, 0.04533212, 0.99820361],
-            [0.05137746, -0.01717139, 0.99853167],
-            [-0.14742009, 0.00734109, 0.98904673],
-            [0.03396359, 0.05851033, 0.99770888],
-            [-0.10286126, 0.04479652, 0.99368649],
-            [-0.050927, -0.06002669, 0.9968968],
-            [0.02815389, 0.02852981, 0.99919638],
-            [-0.1390861, 0.05684676, 0.98864731],
-            [-0.14276463, -0.13402131, 0.98064089],
-        ]
-    )
-
-    result = st.process_observation_vectors(obs)
-    np.testing.assert_allclose(
-        result.quat, [0.1722, -0.4309, 0.8818, 0.08396], rtol=1e-3, atol=1e-3
-    )
-
-
 def test_star_matcher(prepare: tuple[ruststartracker.StarTracker, np.ndarray]):
     os.environ["RUST_BACKTRACE"] = "1"
 

ruststartracker-0.2.1/rust_build.py

@@ -1,21 +0,0 @@
-"""Build rust backend.
-
-This script is automatically run when the pyproject is installed.
-"""
-
-import pathlib
-import shutil
-import subprocess
-
-
-def rust_build() -> None:
-    """Build rust backend and move shared library to correct folder."""
-    cwd = pathlib.Path(__file__).parent.expanduser().absolute()
-    subprocess.check_call(["cargo", "build", "--release"], cwd=cwd)  # noqa: S603, S607
-    shutil.copy(
-        cwd / "target/release/libruststartracker.so", cwd / "ruststartracker/libruststartracker.so"
-    )
-
-
-if __name__ == "__main__":
-    rust_build()