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

imap_processing/tests/swe/lut/checker-board-indices.csv

@@ -0,0 +1,24 @@
+0,371,12,383,24,395,36,407,48,419,60,431,72,443,84,455,96,467,108,479,120,491,132,503,144,515,156,527,168,539
+180,551,192,563,204,575,216,587,228,599,240,611,252,623,264,635,276,647,288,659,300,671,312,683,324,695,336,707,348,719
+360,11,372,23,384,35,396,47,408,59,420,71,432,83,444,95,456,107,468,119,480,131,492,143,504,155,516,167,528,179
+540,191,552,203,564,215,576,227,588,239,600,251,612,263,624,275,636,287,648,299,660,311,672,323,684,335,696,347,708,359
+1,370,13,382,25,394,37,406,49,418,61,430,73,442,85,454,97,466,109,478,121,490,133,502,145,514,157,526,169,538
+181,550,193,562,205,574,217,586,229,598,241,610,253,622,265,634,277,646,289,658,301,670,313,682,325,694,337,706,349,718
+361,10,373,22,385,34,397,46,409,58,421,70,433,82,445,94,457,106,469,118,481,130,493,142,505,154,517,166,529,178
+541,190,553,202,565,214,577,226,589,238,601,250,613,262,625,274,637,286,649,298,661,310,673,322,685,334,697,346,709,358
+2,369,14,381,26,393,38,405,50,417,62,429,74,441,86,453,98,465,110,477,122,489,134,501,146,513,158,525,170,537
+182,549,194,561,206,573,218,585,230,597,242,609,254,621,266,633,278,645,290,657,302,669,314,681,326,693,338,705,350,717
+362,9,374,21,386,33,398,45,410,57,422,69,434,81,446,93,458,105,470,117,482,129,494,141,506,153,518,165,530,177
+542,189,554,201,566,213,578,225,590,237,602,249,614,261,626,273,638,285,650,297,662,309,674,321,686,333,698,345,710,357
+3,368,15,380,27,392,39,404,51,416,63,428,75,440,87,452,99,464,111,476,123,488,135,500,147,512,159,524,171,536
+183,548,195,560,207,572,219,584,231,596,243,608,255,620,267,632,279,644,291,656,303,668,315,680,327,692,339,704,351,716
+363,8,375,20,387,32,399,44,411,56,423,68,435,80,447,92,459,104,471,116,483,128,495,140,507,152,519,164,531,176
+543,188,555,200,567,212,579,224,591,236,603,248,615,260,627,272,639,284,651,296,663,308,675,320,687,332,699,344,711,356
+4,367,16,379,28,391,40,403,52,415,64,427,76,439,88,451,100,463,112,475,124,487,136,499,148,511,160,523,172,535
+184,547,196,559,208,571,220,583,232,595,244,607,256,619,268,631,280,643,292,655,304,667,316,679,328,691,340,703,352,715
+364,7,376,19,388,31,400,43,412,55,424,67,436,79,448,91,460,103,472,115,484,127,496,139,508,151,520,163,532,175
+544,187,556,199,568,211,580,223,592,235,604,247,616,259,628,271,640,283,652,295,664,307,676,319,688,331,700,343,712,355
+5,366,17,378,29,390,41,402,53,414,65,426,77,438,89,450,101,462,113,474,125,486,137,498,149,510,161,522,173,534
+185,546,197,558,209,570,221,582,233,594,245,606,257,618,269,630,281,642,293,654,305,666,317,678,329,690,341,702,353,714
+365,6,377,18,389,30,401,42,413,54,425,66,437,78,449,90,461,102,473,114,485,126,497,138,509,150,521,162,533,174
+545,186,557,198,569,210,581,222,593,234,605,246,617,258,629,270,641,282,653,294,665,306,677,318,689,330,701,342,713,354

imap_processing/tests/swe/lut/imap_swe_esa-lut_20250301_v000.csv

@@ -0,0 +1,385 @@
+table_idx,esa_step,esa_v,v_index,ialirt
+0,0,0.56,1,0
+0,1,2.1,5,0
+0,2,7.85,9,0
+0,3,29.39,13,1
+0,4,110.03,17,1
+0,5,411.93,21,0
+0,6,797.03,23,0
+0,7,212.89,19,1
+0,8,56.87,15,1
+0,9,15.19,11,0
+0,10,4.06,7,0
+0,11,1.08,3,0
+0,180,0.78,2,0
+0,181,2.92,6,0
+0,182,10.92,10,0
+0,183,40.88,14,1
+0,184,153.05,18,1
+0,185,572.99,22,0
+0,186,1108.66,24,0
+0,187,296.14,20,0
+0,188,79.1,16,1
+0,189,21.13,12,1
+0,190,5.64,8,0
+0,191,1.51,4,0
+0,360,1.08,3,0
+0,361,4.06,7,0
+0,362,15.19,11,0
+0,363,56.87,15,1
+0,364,212.89,19,1
+0,365,797.03,23,0
+0,366,411.93,21,0
+0,367,110.03,17,1
+0,368,29.39,13,1
+0,369,7.85,9,0
+0,370,2.1,5,0
+0,371,0.56,1,0
+0,540,1.51,4,0
+0,541,5.64,8,0
+0,542,21.13,12,1
+0,543,79.1,16,1
+0,544,296.14,20,0
+0,545,1108.66,24,0
+0,546,572.99,22,0
+0,547,153.05,18,1
+0,548,40.88,14,1
+0,549,10.92,10,0
+0,550,2.92,6,0
+0,551,0.78,2,0
+1,0,5.64,8,0
+1,1,5.64,8,0
+1,2,5.64,8,0
+1,3,5.64,8,0
+1,4,5.64,8,0
+1,5,5.64,8,0
+1,6,5.64,8,0
+1,7,5.64,8,0
+1,8,5.64,8,0
+1,9,5.64,8,0
+1,10,5.64,8,0
+1,11,5.64,8,0
+1,180,5.64,8,0
+1,181,5.64,8,0
+1,182,5.64,8,0
+1,183,5.64,8,0
+1,184,5.64,8,0
+1,185,5.64,8,0
+1,186,5.64,8,0
+1,187,5.64,8,0
+1,188,5.64,8,0
+1,189,5.64,8,0
+1,190,5.64,8,0
+1,191,5.64,8,0
+1,360,5.64,8,0
+1,361,5.64,8,0
+1,362,5.64,8,0
+1,363,5.64,8,0
+1,364,5.64,8,0
+1,365,5.64,8,0
+1,366,5.64,8,0
+1,367,5.64,8,0
+1,368,5.64,8,0
+1,369,5.64,8,0
+1,370,5.64,8,0
+1,371,5.64,8,0
+1,540,5.64,8,0
+1,541,5.64,8,0
+1,542,5.64,8,0
+1,543,5.64,8,0
+1,544,5.64,8,0
+1,545,5.64,8,0
+1,546,5.64,8,0
+1,547,5.64,8,0
+1,548,5.64,8,0
+1,549,5.64,8,0
+1,550,5.64,8,0
+1,551,5.64,8,0
+2,0,0.56,1,0
+2,1,0.78,2,0
+2,2,1.08,3,0
+2,3,1.51,4,0
+2,4,2.1,5,0
+2,5,2.92,6,0
+2,6,2.92,6,0
+2,7,2.1,5,0
+2,8,1.51,4,0
+2,9,1.08,3,0
+2,10,0.78,2,0
+2,11,0.56,1,0
+2,180,4.06,7,0
+2,181,5.64,8,0
+2,182,7.85,9,0
+2,183,10.92,10,0
+2,184,15.19,11,0
+2,185,21.13,12,0
+2,186,21.13,12,0
+2,187,15.19,11,0
+2,188,10.92,10,0
+2,189,7.85,9,0
+2,190,5.64,8,0
+2,191,4.06,7,0
+2,360,29.39,13,0
+2,361,40.88,14,0
+2,362,56.87,15,0
+2,363,79.1,16,0
+2,364,110.03,17,0
+2,365,153.05,18,0
+2,366,153.05,18,0
+2,367,110.03,17,0
+2,368,79.1,16,0
+2,369,56.87,15,0
+2,370,40.88,14,0
+2,371,29.39,13,0
+2,540,212.89,19,0
+2,541,296.14,20,0
+2,542,411.93,21,0
+2,543,572.99,22,0
+2,544,797.03,23,0
+2,545,1108.66,24,0
+2,546,1108.66,24,0
+2,547,797.03,23,0
+2,548,572.99,22,0
+2,549,411.93,21,0
+2,550,296.14,20,0
+2,551,212.89,19,0
+3,0,10.92,10,0
+3,1,21.13,12,0
+3,2,40.88,14,0
+3,3,79.1,16,0
+3,4,153.05,18,0
+3,5,296.14,20,0
+3,6,411.93,21,0
+3,7,212.89,19,0
+3,8,110.03,17,0
+3,9,56.87,15,0
+3,10,29.39,13,0
+3,11,15.19,11,0
+3,180,15.19,11,0
+3,181,29.39,13,0
+3,182,56.87,15,0
+3,183,110.03,17,0
+3,184,212.89,19,0
+3,185,411.93,21,0
+3,186,296.14,20,0
+3,187,153.05,18,0
+3,188,79.1,16,0
+3,189,40.88,14,0
+3,190,21.13,12,0
+3,191,10.92,10,0
+3,360,10.92,10,0
+3,361,21.13,12,0
+3,362,40.88,14,0
+3,363,79.1,16,0
+3,364,153.05,18,0
+3,365,296.14,20,0
+3,366,411.93,21,0
+3,367,212.89,19,0
+3,368,110.03,17,0
+3,369,56.87,15,0
+3,370,29.39,13,0
+3,371,15.19,11,0
+3,540,15.19,11,0
+3,541,29.39,13,0
+3,542,56.87,15,0
+3,543,110.03,17,0
+3,544,212.89,19,0
+3,545,411.93,21,0
+3,546,296.14,20,0
+3,547,153.05,18,0
+3,548,79.1,16,0
+3,549,40.88,14,0
+3,550,21.13,12,0
+3,551,10.92,10,0
+4,0,0.56,1,0
+4,1,1.08,3,0
+4,2,2.1,5,0
+4,3,4.06,7,0
+4,4,7.85,9,0
+4,5,15.19,11,0
+4,6,21.13,12,0
+4,7,10.92,10,0
+4,8,5.64,8,0
+4,9,2.92,6,0
+4,10,1.51,4,0
+4,11,0.78,2,0
+4,180,0.78,2,0
+4,181,1.51,4,0
+4,182,2.92,6,0
+4,183,5.64,8,0
+4,184,10.92,10,0
+4,185,21.13,12,0
+4,186,15.19,11,0
+4,187,7.85,9,0
+4,188,4.06,7,0
+4,189,2.1,5,0
+4,190,1.08,3,0
+4,191,0.56,1,0
+4,360,29.39,13,0
+4,361,56.87,15,0
+4,362,110.03,17,0
+4,363,212.89,19,0
+4,364,411.93,21,0
+4,365,797.03,23,0
+4,366,1108.66,24,0
+4,367,572.99,22,0
+4,368,296.14,20,0
+4,369,153.05,18,0
+4,370,79.1,16,0
+4,371,40.88,14,0
+4,540,40.88,14,0
+4,541,79.1,16,0
+4,542,153.05,18,0
+4,543,296.14,20,0
+4,544,572.99,22,0
+4,545,1108.66,24,0
+4,546,797.03,23,0
+4,547,411.93,21,0
+4,548,212.89,19,0
+4,549,110.03,17,0
+4,550,56.87,15,0
+4,551,29.39,13,0
+5,0,0.56,1,0
+5,1,0.56,1,0
+5,2,0.56,1,0
+5,3,0.56,1,0
+5,4,0.56,1,0
+5,5,0.56,1,0
+5,6,0.56,1,0
+5,7,0.56,1,0
+5,8,0.56,1,0
+5,9,0.56,1,0
+5,10,0.56,1,0
+5,11,0.56,1,0
+5,180,0.56,1,0
+5,181,0.56,1,0
+5,182,0.56,1,0
+5,183,0.56,1,0
+5,184,0.56,1,0
+5,185,0.56,1,0
+5,186,0.56,1,0
+5,187,0.56,1,0
+5,188,0.56,1,0
+5,189,0.56,1,0
+5,190,0.56,1,0
+5,191,0.56,1,0
+5,360,0.56,1,0
+5,361,0.56,1,0
+5,362,0.56,1,0
+5,363,0.56,1,0
+5,364,0.56,1,0
+5,365,0.56,1,0
+5,366,0.56,1,0
+5,367,0.56,1,0
+5,368,0.56,1,0
+5,369,0.56,1,0
+5,370,0.56,1,0
+5,371,0.56,1,0
+5,540,0.56,1,0
+5,541,0.56,1,0
+5,542,0.56,1,0
+5,543,0.56,1,0
+5,544,0.56,1,0
+5,545,0.56,1,0
+5,546,0.56,1,0
+5,547,0.56,1,0
+5,548,0.56,1,0
+5,549,0.56,1,0
+5,550,0.56,1,0
+5,551,0.56,1,0
+6,0,0.56,1,0
+6,1,0.56,1,0
+6,2,0.56,1,0
+6,3,0.56,1,0
+6,4,0.56,1,0
+6,5,0.56,1,0
+6,6,0.56,1,0
+6,7,0.56,1,0
+6,8,0.56,1,0
+6,9,0.56,1,0
+6,10,0.56,1,0
+6,11,0.56,1,0
+6,180,0.56,1,0
+6,181,0.56,1,0
+6,182,0.56,1,0
+6,183,0.56,1,0
+6,184,0.56,1,0
+6,185,0.56,1,0
+6,186,0.56,1,0
+6,187,0.56,1,0
+6,188,0.56,1,0
+6,189,0.56,1,0
+6,190,0.56,1,0
+6,191,0.56,1,0
+6,360,0.56,1,0
+6,361,0.56,1,0
+6,362,0.56,1,0
+6,363,0.56,1,0
+6,364,0.56,1,0
+6,365,0.56,1,0
+6,366,0.56,1,0
+6,367,0.56,1,0
+6,368,0.56,1,0
+6,369,0.56,1,0
+6,370,0.56,1,0
+6,371,0.56,1,0
+6,540,0.56,1,0
+6,541,0.56,1,0
+6,542,0.56,1,0
+6,543,0.56,1,0
+6,544,0.56,1,0
+6,545,0.56,1,0
+6,546,0.56,1,0
+6,547,0.56,1,0
+6,548,0.56,1,0
+6,549,0.56,1,0
+6,550,0.56,1,0
+6,551,0.56,1,0
+7,0,0.56,1,0
+7,1,0.56,1,0
+7,2,0.56,1,0
+7,3,0.56,1,0
+7,4,0.56,1,0
+7,5,0.56,1,0
+7,6,0.56,1,0
+7,7,0.56,1,0
+7,8,0.56,1,0
+7,9,0.56,1,0
+7,10,0.56,1,0
+7,11,0.56,1,0
+7,180,0.56,1,0
+7,181,0.56,1,0
+7,182,0.56,1,0
+7,183,0.56,1,0
+7,184,0.56,1,0
+7,185,0.56,1,0
+7,186,0.56,1,0
+7,187,0.56,1,0
+7,188,0.56,1,0
+7,189,0.56,1,0
+7,190,0.56,1,0
+7,191,0.56,1,0
+7,360,0.56,1,0
+7,361,0.56,1,0
+7,362,0.56,1,0
+7,363,0.56,1,0
+7,364,0.56,1,0
+7,365,0.56,1,0
+7,366,0.56,1,0
+7,367,0.56,1,0
+7,368,0.56,1,0
+7,369,0.56,1,0
+7,370,0.56,1,0
+7,371,0.56,1,0
+7,540,0.56,1,0
+7,541,0.56,1,0
+7,542,0.56,1,0
+7,543,0.56,1,0
+7,544,0.56,1,0
+7,545,0.56,1,0
+7,546,0.56,1,0
+7,547,0.56,1,0
+7,548,0.56,1,0
+7,549,0.56,1,0
+7,550,0.56,1,0
+7,551,0.56,1,0

imap_processing/tests/swe/lut/imap_swe_l1b-in-flight-cal_20240510_20260716_v000.csv

@@ -0,0 +1,3 @@
+met_time,cem1,cem2,cem3,cem4,cem5,cem6,cem7
+453050308,1,1,1,1,1,1,1
+1782864000,1,1,1,1,1,1,1

imap_processing/tests/swe/test_swe_l1a.py

@@ -5,8 +5,26 @@ from imap_processing.swe.l1a.swe_l1a import swe_l1a
 
 def test_cdf_creation():
     test_data_path = "tests/swe/l0_data/2024051010_SWE_SCIENCE_packet.bin"
-    processed_data = swe_l1a(imap_module_directory / test_data_path, "001")
+    processed_data = swe_l1a(imap_module_directory / test_data_path)
 
     cem_raw_cdf_filepath = write_cdf(processed_data[0])
 
-    assert cem_raw_cdf_filepath.name == "imap_swe_l1a_sci_20240510_v001.cdf"
+    assert cem_raw_cdf_filepath.name == "imap_swe_l1a_sci_20240510_v999.cdf"
+
+
+def test_cdf_creation_hk():
+    test_data_path = "tests/swe/l0_data/2024051010_SWE_HK_packet.bin"
+    processed_data = swe_l1a(imap_module_directory / test_data_path)
+
+    hk_cdf_filepath = write_cdf(processed_data[0])
+
+    assert hk_cdf_filepath.name == "imap_swe_l1a_hk_20240510_v999.cdf"
+
+
+def test_cdf_creation_cem_raw():
+    test_data_path = "tests/swe/l0_data/2024051011_SWE_CEM_RAW_packet.bin"
+    processed_data = swe_l1a(imap_module_directory / test_data_path)
+
+    cem_raw_cdf_filepath = write_cdf(processed_data[0])
+
+    assert cem_raw_cdf_filepath.name == "imap_swe_l1a_cem-raw_20240510_v999.cdf"

imap_processing/tests/swe/test_swe_l1a_cem_raw.py

@@ -0,0 +1,52 @@
+from dataclasses import fields
+
+import pandas as pd
+import pytest
+
+from imap_processing import imap_module_directory
+from imap_processing.ccsds.ccsds_data import CcsdsData
+from imap_processing.swe.utils.swe_utils import SWEAPID
+from imap_processing.utils import packet_file_to_datasets
+
+
+@pytest.fixture(scope="session")
+def decom_raw_cem_data():
+    """Read test data from file"""
+    test_folder_path = imap_module_directory / "tests/swe/l0_data"
+    packet_file = test_folder_path / "2024051011_SWE_CEM_RAW_packet.bin"
+    xtce_document = (
+        imap_module_directory / "swe/packet_definitions/swe_packet_definition.xml"
+    )
+    datasets_by_apid = packet_file_to_datasets(
+        packet_file, xtce_document, use_derived_value=False
+    )
+    return datasets_by_apid[SWEAPID.SWE_CEM_RAW]
+
+
+def test_number_of_packets(decom_raw_cem_data):
+    """This test and validate number of packets."""
+    expected_number_of_packets = 25
+    assert len(decom_raw_cem_data) == expected_number_of_packets
+
+
+def test_swe_raw_cem_data(decom_raw_cem_data):
+    """This test and validate raw data of SWE raw CEM data."""
+    # read validation data
+    test_data_path = imap_module_directory / "tests/swe/l0_validation_data"
+    raw_validation_data = pd.read_csv(
+        test_data_path / "idle_export_eu.SWE_CEM_RAW_20240510_092742.csv",
+        index_col="SHCOARSE",
+    )
+
+    first_data = decom_raw_cem_data.isel(epoch=0)
+    validation_data = raw_validation_data.loc[first_data["shcoarse"].values]
+
+    ccsds_header_keys = [field.name for field in fields(CcsdsData)]
+    ccsds_header_keys += ["SHCOARSE"]
+
+    # compare unpacked data to validation data
+    for key in first_data.keys():
+        if key.upper() in ccsds_header_keys:
+            continue
+        # check if the data is the same.
+        assert first_data[key] == validation_data[key.upper()]

imap_processing/tests/swe/test_swe_l1a_hk.py

@@ -0,0 +1,68 @@
+from dataclasses import fields
+
+import numpy as np
+import pandas as pd
+import pytest
+
+from imap_processing import imap_module_directory
+from imap_processing.ccsds.ccsds_data import CcsdsData
+from imap_processing.swe.utils.swe_utils import SWEAPID
+from imap_processing.utils import packet_file_to_datasets
+
+
+@pytest.fixture(scope="session")
+def decom_hk_data():
+    """Read test data from file"""
+    test_folder_path = imap_module_directory / "tests/swe/l0_data"
+    packet_file = test_folder_path / "2024051010_SWE_HK_packet.bin"
+    xtce_document = (
+        imap_module_directory / "swe/packet_definitions/swe_packet_definition.xml"
+    )
+    datasets_by_apid = packet_file_to_datasets(
+        packet_file,
+        xtce_document,
+        use_derived_value=True,
+    )
+    return datasets_by_apid[SWEAPID.SWE_APP_HK]
+
+
+def test_swe_hk_data(decom_hk_data):
+    """This test and validate raw data of SWAPI raw housekeeping data."""
+    # read validation data
+    test_data_path = imap_module_directory / "tests/swe/l0_validation_data"
+
+    raw_validation_data = pd.read_csv(
+        test_data_path / "idle_export_eu.SWE_APP_HK_20240510_092742.csv",
+        index_col="SHCOARSE",
+    )
+
+    first_data = decom_hk_data.isel(epoch=0)
+    validation_data = raw_validation_data.loc[first_data["shcoarse"].values]
+
+    # TODO: check with SWE team
+    mismatched_keys = [
+        "HVPS_ESA_DAC",
+    ]
+
+    ccsds_header_keys = [field.name for field in fields(CcsdsData)]
+    ccsds_header_keys += ["SHCOARSE"]
+    # compare raw values of validation data
+    for key in first_data.keys():
+        data_key = key.upper()
+        if data_key in ccsds_header_keys:
+            continue
+
+        if data_key in mismatched_keys:
+            continue
+
+        # Compare derived string values to validation data
+        if str(first_data[key].dtype).startswith("<U"):
+            assert first_data[key].values == validation_data[data_key]
+        # Compare derived float values to validation data
+        elif first_data[key].dtype == "float64":
+            np.testing.assert_almost_equal(
+                first_data[key].values, validation_data[data_key], decimal=6
+            )
+        # Compare derived integer values to validation data
+        else:
+            assert first_data[key].values == validation_data[data_key]

imap_processing/tests/swe/test_swe_l1a_science.py

@@ -75,7 +75,7 @@ def test_data_order(decom_test_data):
     )
 
     # Get unpacked science data
-    processed_data = swe_science(decom_test_data, "001")
+    processed_data = swe_science(decom_test_data)
 
     quarter_cycle = processed_data["quarter_cycle"].isel(epoch=slice(0, 4))
     np.testing.assert_array_equal(quarter_cycle, [0, 1, 2, 3])
@@ -84,7 +84,7 @@ def test_data_order(decom_test_data):
 def test_swe_science_algorithm(decom_test_data):
     """Test general shape of return dataset from swe_science."""
     # Get unpacked science data
-    processed_data = swe_science(decom_test_data, "001")
+    processed_data = swe_science(decom_test_data)
 
     # science data should have this shape, 15x12x7.
     science_data = processed_data["science_data"].data[0]
@@ -101,7 +101,7 @@ def test_decompress_counts(decom_test_data, l1a_validation_df):
     raw_counts = l1a_validation_df.iloc[:, 1:8]
     decompressed_counts = l1a_validation_df.iloc[:, 8:15]
 
-    l1a_dataset = swe_science(decom_test_data, "001")
+    l1a_dataset = swe_science(decom_test_data)
 
     # compare raw counts
     assert np.all(