imap-processing 0.11.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

imap_processing/tests/spice/test_repoint.py

@@ -0,0 +1,121 @@
+"""Test coverage for imap_processing.spice.repoint.py"""
+
+import numpy as np
+import pandas as pd
+import pytest
+
+from imap_processing.spice.repoint import get_repoint_data, interpolate_repoint_data
+
+
+@pytest.fixture
+def fake_repoint_data(monkeypatch, spice_test_data_path):
+    """Generate fake spin dataframe for testing"""
+    fake_repoint_path = spice_test_data_path / "fake_repoint_data.csv"
+    monkeypatch.setenv("REPOINT_DATA_FILEPATH", str(fake_repoint_path))
+    return fake_repoint_path
+
+
+def test_get_repoint_data(fake_repoint_data):
+    """Test coverage for get_repoint_data function."""
+    repoint_df = get_repoint_data()
+    assert isinstance(repoint_df, pd.DataFrame)
+    assert set(repoint_df.columns) == {
+        "repoint_start_sec_sclk",
+        "repoint_start_subsec_sclk",
+        "repoint_start_met",
+        "repoint_start_utc",
+        "repoint_end_sec_sclk",
+        "repoint_end_subsec_sclk",
+        "repoint_end_met",
+        "repoint_end_utc",
+        "repoint_id",
+    }
+
+
+def test_spin_data_no_table():
+    """Test coverage for get_repoint_data function when the env var is not set."""
+    with pytest.raises(
+        ValueError, match="REPOINT_DATA_FILEPATH environment variable is not set."
+    ):
+        get_repoint_data()
+
+
+def test_interpolate_repoint_data(fake_repoint_data):
+    """Test coverage for get_repoint_data function."""
+    query_times = np.array([0.1, 6, 32])
+    expected_vals = {
+        "repoint_start_sec_sclk": np.array([0, 0, 25]),
+        "repoint_start_subsec_sclk": np.array([100000, 100000, 300000]),
+        "repoint_start_met": np.array([0.1, 0.1, 25.3]),
+        "repoint_end_sec_sclk": np.array([5, 5, 30]),
+        "repoint_end_subsec_sclk": np.array([100000, 100000, 300000]),
+        "repoint_end_met": np.array([5.1, 5.1, 30.3]),
+        "repoint_id": np.array([0, 0, 2]),
+        "repoint_in_progress": np.array([True, False, False]),
+    }
+    repoint_df = interpolate_repoint_data(query_times)
+
+    for key, expected_array in expected_vals.items():
+        np.testing.assert_array_equal(repoint_df[key].values, expected_array)
+
+
+@pytest.mark.parametrize(
+    "query_times, match_str",
+    [
+        (
+            np.array([-1, 9]),
+            "1 query times are before",
+        ),  # Query times before start of table
+        (
+            np.array([1, 24 * 60 * 60 + 26]),
+            "1 query times are after",
+        ),  # Query times after end of valid range
+    ],
+)
+def test_interpolate_repoint_data_exceptions(query_times, match_str, fake_repoint_data):
+    # Test when query time is
+    # Test raising a ValueError when the query time is in between an end and the
+    # next start time.
+    with pytest.raises(ValueError, match=match_str):
+        _ = interpolate_repoint_data(query_times)
+
+
+def test_interpolate_repoint_data_with_use_fake_fixture(use_fake_repoint_data_for_time):
+    """Test coverage for using use_fake_repoint_data_for_time fixutre."""
+    repoint_period = 24 * 60 * 60
+    repoint_start_times = np.arange(1000, 1000 + 10 * repoint_period, repoint_period)
+    _ = use_fake_repoint_data_for_time(repoint_start_times, repoint_id_start=10)
+    # Query times are all start times concatenated with 16 minutes after each start time
+    query_times = np.concat([repoint_start_times, repoint_start_times + 16 * 60])
+    repoint_df = interpolate_repoint_data(query_times)
+
+    # Expected repoint_start_times are the seeded start times array repeated twice
+    np.testing.assert_array_equal(
+        repoint_df["repoint_start_met"].values,
+        np.concat([repoint_start_times, repoint_start_times]),
+    )
+    # Expected repoint_end_times are the seeded start times + 15 minutes
+    np.testing.assert_array_equal(
+        repoint_df["repoint_end_met"].values,
+        np.concat([repoint_start_times + 15 * 60, repoint_start_times + 15 * 60]),
+    )
+    # Expected repoint_id
+    np.testing.assert_array_equal(
+        repoint_df["repoint_id"].values,
+        np.concat(
+            [
+                np.arange(repoint_start_times.size) + 10,
+                np.arange(repoint_start_times.size) + 10,
+            ]
+        ),
+    )
+    # Expected repoint_in_progress
+    np.testing.assert_array_equal(
+        repoint_df["repoint_in_progress"].values,
+        np.concat(
+            [
+                np.full(repoint_start_times.size, True),
+                np.full(repoint_start_times.size, False),
+            ]
+        ),
+    )

imap_processing/tests/spice/test_spin.py

@@ -14,7 +14,7 @@ from imap_processing.spice.spin import (
 )
 
 
-@pytest.fixture()
+@pytest.fixture
 def fake_spin_data(monkeypatch, spice_test_data_path):
     """Generate fake spin dataframe for testing"""
     fake_spin_path = spice_test_data_path / "fake_spin_data.csv"
@@ -27,13 +27,51 @@ def fake_spin_data(monkeypatch, spice_test_data_path):
     [
         (
             15,
-            [[1, 15, 0, 15.0, 1, 1, 0, 0, 15.0, 0.0]],
+            [
+                [
+                    1,
+                    15,
+                    0,
+                    "2024-04-11 00:00:15.000000",
+                    15.0,
+                    True,
+                    1,
+                    0,
+                    False,
+                    15.0,
+                    0.0,
+                ]
+            ],
         ),  # Scalar test at spin start time
         (
             np.array([15.1, 30.2]),
             [
-                [1, 15, 0, 15.0, 1, 1, 0, 0, 15.0, 0.1 / 15],
-                [2, 30, 0, 15.0, 1, 1, 0, 0, 30.0, 0.2 / 15],
+                [
+                    1,
+                    15,
+                    0,
+                    "2024-04-11 00:00:15.000000",
+                    15.0,
+                    True,
+                    1,
+                    0,
+                    False,
+                    15.0,
+                    0.1 / 15,
+                ],
+                [
+                    2,
+                    30,
+                    0,
+                    "2024-04-11 00:00:30.000000",
+                    15.0,
+                    True,
+                    1,
+                    0,
+                    False,
+                    30.0,
+                    0.2 / 15,
+                ],
             ],
         ),  # Array test
     ],
@@ -45,7 +83,9 @@ def test_interpolate_spin_data(query_met_times, expected, fake_spin_data):
 
     # Test the value
     for i_row, row in enumerate(expected):
-        np.testing.assert_array_almost_equal(spin_df.iloc[i_row].tolist(), row)
+        pd.testing.assert_series_equal(
+            spin_df.iloc[i_row], pd.Series(row), check_index=False, check_names=False
+        )
 
 
 @pytest.mark.parametrize(
@@ -144,21 +184,22 @@ def test_get_spin_data(use_fake_spin_data_for_time):
 
     assert set(spin_data.columns) == {
         "spin_number",
-        "spin_start_sec",
-        "spin_start_subsec",
+        "spin_start_sec_sclk",
+        "spin_start_subsec_sclk",
+        "spin_start_utc",
         "spin_period_sec",
         "spin_period_valid",
         "spin_phase_valid",
         "spin_period_source",
         "thruster_firing",
-        "spin_start_time",
+        "spin_start_met",
     }, "Spin data must have the specified fields."
 
 
 @pytest.mark.parametrize(
     "instrument",
     [
-        SpiceFrame.IMAP_LO,
+        SpiceFrame.IMAP_LO_BASE,
         SpiceFrame.IMAP_HI_45,
         SpiceFrame.IMAP_HI_90,
         SpiceFrame.IMAP_ULTRA_45,

imap_processing/tests/spice/test_time.py

@@ -7,6 +7,7 @@ import spiceypy
 from imap_processing.spice import IMAP_SC_ID
 from imap_processing.spice.time import (
     TICK_DURATION,
+    epoch_to_doy,
     et_to_utc,
     met_to_datetime64,
     met_to_sclkticks,
@@ -202,3 +203,16 @@ def test_et_to_utc(furnish_time_kernels):
     )
     actual_utc_array = et_to_utc(array_of_et)
     assert np.array_equal(expected_utc_array, actual_utc_array)
+
+
+def test_epoch_to_doy():
+    """Tests that epoch_to_doy() produces expected doys."""
+    epoch = 756196488384840064
+    et = epoch * 1e-9
+    # Extract DOY from output date string
+    expected_doy = int(et_to_utc(et, "D").split("//")[0].split("-")[1])
+    example_epoch = np.full(10, epoch)
+    doy = epoch_to_doy(example_epoch)
+
+    # Assert that every calculated DOY is equal to the DOY extracted from the string.
+    assert np.all(doy == expected_doy)

imap_processing/tests/swapi/lut/imap_swapi_esa-unit-conversion_20250211_v000.csv

@@ -0,0 +1,73 @@
+timestamp,ESA Step #,K factor,Voltage,Energy,Sweep #,ESA Index Number,LUT version number
+2/11/25 0:00,0,1.88,619,"1,163",0,544,4
+2/11/25 0:00,1,1.88,619,"1,163",0,544,4
+2/11/25 0:00,2,1.88,619,"1,163",0,544,4
+2/11/25 0:00,3,1.88,619,"1,163",0,544,4
+2/11/25 0:00,4,1.88,619,"1,163",0,544,4
+2/11/25 0:00,5,1.88,619,"1,163",0,544,4
+2/11/25 0:00,6,1.88,619,"1,163",0,544,4
+2/11/25 0:00,7,1.88,619,"1,163",0,544,4
+2/11/25 0:00,8,1.88,619,"1,163",0,544,4
+2/11/25 0:00,9,1.88,619,"1,163",0,544,4
+2/11/25 0:00,10,1.88,619,"1,163",0,544,4
+2/11/25 0:00,11,1.88,619,"1,163",0,544,4
+2/11/25 0:00,12,1.88,619,"1,163",0,544,4
+2/11/25 0:00,13,1.88,619,"1,163",0,544,4
+2/11/25 0:00,14,1.88,619,"1,163",0,544,4
+2/11/25 0:00,15,1.88,619,"1,163",0,544,4
+2/11/25 0:00,16,1.88,619,"1,163",0,544,4
+2/11/25 0:00,17,1.88,619,"1,163",0,544,4
+2/11/25 0:00,18,1.88,619,"1,163",0,544,4
+2/11/25 0:00,19,1.88,619,"1,163",0,544,4
+2/11/25 0:00,20,1.88,619,"1,163",0,544,4
+2/11/25 0:00,21,1.88,619,"1,163",0,544,4
+2/11/25 0:00,22,1.88,619,"1,163",0,544,4
+2/11/25 0:00,23,1.88,619,"1,163",0,544,4
+2/11/25 0:00,24,1.88,619,"1,163",0,544,4
+2/11/25 0:00,25,1.88,619,"1,163",0,544,4
+2/11/25 0:00,26,1.88,619,"1,163",0,544,4
+2/11/25 0:00,27,1.88,619,"1,163",0,544,4
+2/11/25 0:00,28,1.88,619,"1,163",0,544,4
+2/11/25 0:00,29,1.88,619,"1,163",0,544,4
+2/11/25 0:00,30,1.88,619,"1,163",0,544,4
+2/11/25 0:00,31,1.88,619,"1,163",0,544,4
+2/11/25 0:00,32,1.88,619,"1,163",0,544,4
+2/11/25 0:00,33,1.88,619,"1,163",0,544,4
+2/11/25 0:00,34,1.88,619,"1,163",0,544,4
+2/11/25 0:00,35,1.88,568,"1,068",0,560,4
+2/11/25 0:00,36,1.88,522,981,0,576,4
+2/11/25 0:00,37,1.88,479,901,0,592,4
+2/11/25 0:00,38,1.88,440,828,0,608,4
+2/11/25 0:00,39,1.88,404,760,0,624,4
+2/11/25 0:00,40,1.88,371,698,0,640,4
+2/11/25 0:00,41,1.88,341,641,0,656,4
+2/11/25 0:00,42,1.88,313,589,0,672,4
+2/11/25 0:00,43,1.88,289,544,0,688,4
+2/11/25 0:00,44,1.88,264,497,0,704,4
+2/11/25 0:00,45,1.88,244,459,0,720,4
+2/11/25 0:00,46,1.88,224,421,0,736,4
+2/11/25 0:00,47,1.88,207,389,0,752,4
+2/11/25 0:00,48,1.88,189,355,0,768,4
+2/11/25 0:00,49,1.88,174,326,0,784,4
+2/11/25 0:00,50,1.88,159,298,0,800,4
+2/11/25 0:00,51,1.88,146,275,0,816,4
+2/11/25 0:00,52,1.88,134,252,0,832,4
+2/11/25 0:00,53,1.88,124,234,0,848,4
+2/11/25 0:00,54,1.88,114,214,0,864,4
+2/11/25 0:00,55,1.88,104,195,0,880,4
+2/11/25 0:00,56,1.88,96,181,0,896,4
+2/11/25 0:00,57,1.88,89,167,0,912,4
+2/11/25 0:00,58,1.88,82,153,0,928,4
+2/11/25 0:00,59,1.88,74,139,0,944,4
+2/11/25 0:00,60,1.88,69,129,0,960,4
+2/11/25 0:00,61,1.88,64,120,0,976,4
+2/11/25 0:00,62,1.88,57,107,0,992,4
+2/11/25 0:00,63,1.88,Solve,Solve,0,-16,4
+2/11/25 0:00,64,1.88,Solve,Solve,0,-12,4
+2/11/25 0:00,65,1.88,Solve,Solve,0,-8,4
+2/11/25 0:00,66,1.88,Solve,Solve,0,-4,4
+2/11/25 0:00,67,1.88,Solve,Solve,0,0,4
+2/11/25 0:00,68,1.88,Solve,Solve,0,4,4
+2/11/25 0:00,69,1.88,Solve,Solve,0,8,4
+2/11/25 0:00,70,1.88,Solve,Solve,0,12,4
+2/11/25 0:00,71,1.88,Solve,Solve,0,16,4