imap-processing 0.7.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

imap_processing/__init__.py

@@ -25,7 +25,7 @@ PROCESSING_LEVELS = {
     "glows": ["l0", "l1a", "l1b", "l2"],
     "hi": ["l0", "l1a", "l1b", "l1c", "l2"],
     "hit": ["l0", "l1a", "l1b", "l2"],
-    "idex": ["l0", "l1a", "l1b", "l2"],
+    "idex": ["l0", "l1a", "l1b", "l2a", "l2b"],
     "lo": ["l0", "l1a", "l1b", "l1c", "l2"],
     "mag": ["l0", "l1a", "l1b", "l1c", "l2pre", "l2"],
     "swapi": ["l0", "l1", "l2", "l3a", "l3b"],

imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "0.7.0"
-__version_tuple__ = (0, 7, 0)
+__version__ = "0.9.0"
+__version_tuple__ = (0, 9, 0)

imap_processing/ccsds/excel_to_xtce.py

@@ -78,6 +78,7 @@ class XTCEGenerator:
     """
 
     def __init__(self, path_to_excel_file: Path):
+        self.source_file = path_to_excel_file.name
         # Read in all sheets from the excel file
         self.sheets = pd.read_excel(path_to_excel_file, sheet_name=None)
         # Set up the packet mapping from packetName to Apid
@@ -123,6 +124,7 @@ class XTCEGenerator:
             ].values[0]
         )
         header.attrib["author"] = "IMAP SDC"
+        header.attrib["source_file"] = self.source_file
 
         # Create the TelemetryMetaData element
         self._telemetry_metadata = Et.SubElement(root, "xtce:TelemetryMetaData")
@@ -391,8 +393,40 @@ class XTCEGenerator:
         ]
         for _, state_row in state_sheet.iterrows():
             enumeration = Et.SubElement(enumeration_list, "xtce:Enumeration")
-            enumeration.attrib["value"] = str(state_row["value"])
-            enumeration.attrib["label"] = str(state_row["state"])
+            valid_state = self._ensure_state_value_is_int(state_row)
+            enumeration.attrib["value"] = str(valid_state["value"])
+            enumeration.attrib["label"] = str(valid_state["state"])
+
+    def _ensure_state_value_is_int(self, state: dict) -> dict:
+        """
+        Ensure the telemetry state value is an integer.
+
+        Some telemetry state values are documented as a hex string,
+        which space packet parser cannot handle. If the value of a
+        state is a hex string rather than an int, convert it to an integer.
+        If the value is neither a hex string or an integer, raise an error.
+
+        Parameters
+        ----------
+        state : dict
+            Dictionary with telemetry state and value.
+
+        Returns
+        -------
+        dict
+            The dictionary for the state.
+        """
+        value = state["value"]
+        # return if already an int
+        if isinstance(value, int):
+            return state
+        # convert hex string to int
+        elif isinstance(value, str) and value.startswith("0x"):
+            state["value"] = int(value, 16)
+            return state
+        # raise error if value is neither a hex string or integer
+        else:
+            raise ValueError(f"Invalid value of {value} for state {state['state']}")
 
     def to_xml(self, output_xml_path: Path) -> None:
         """

imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml

@@ -66,7 +66,7 @@ imap_codice_l1a_lo-counters-aggregated:
 imap_codice_l1a_lo-counters-singles:
     <<: *instrument_base
     Data_level: 1A
-    Data_type: L1A_lo-counters-aggregated->Level-1A Lo Single Instrument Counts Data
+    Data_type: L1A_lo-counters-singles->Level-1A Lo Single Instrument Counts Data
     Logical_source: imap_codice_l1a_lo-counters-singles
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Single Instrument Counts Data.
 

imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml

@@ -4,6 +4,7 @@
 #       https://github.com/IMAP-Science-Operations-Center/imap_processing/pull/711#discussion_r1690212527
 
 # TODO: Add any missing CATDESCs
+# TODO: Make sure housekeeping attributes are consistent with latest telemetry definition
 
 # <=== Defaults ===>
 default_attrs: &default
@@ -751,7 +752,7 @@ spin_bin_index:
     FIELDNAM: Spin Bin Index
     VAR_TYPE: support_data
 
-optics_hv_cmd_err_cnt:
+optc_hv_cmd_err_cnt:
     <<: *default
     LABLAXIS: OPTICS_HV_CMD_ERR_CNT
     FIELDNAM: Optics HV - Number of command errors
@@ -763,27 +764,25 @@ spare_1:
     FIELDNAM: Spare for alignment
     VAR_TYPE: support_data
 
-optics_hv_arm_err_cnt:
+optc_hv_arm_err_cnt:
     <<: *default
     LABLAXIS: OPTICS_HV_ARM_ERR_CNT
     FIELDNAM: Optics HV - Number of arm errors
     VAR_TYPE: support_data
 
-optics_hv_master_enable:
+optc_hv_master_en:
     <<: *default
     LABLAXIS: OPTICS_HV_MASTER_ENABLE
     FIELDNAM: Optics HV - Master Enable
     VAR_TYPE: support_data
 
-optics_hv_n15kv_enable:
-    <<: *default
-    LABLAXIS: OPTICS_HV_N15KV_ENABLE
-    FIELDNAM: Optics HV - p15KV Enable
+iobulk_en:
+    LABLAXIS: OPTICS_HV_P15KV_ENABLE
+    FIELDNAM: Optics HV - P15KV Enable
     VAR_TYPE: support_data
 
-optics_hv_esa_b_enable:
-    <<: *default
-    LABLAXIS: OPTICS_HV_ESA_B_ENABLE
+esab_en:
+    LABLAXIS: OPTICS_HV_ESAB_ENABLE
     FIELDNAM: Optics HV - ESA B Enable
     VAR_TYPE: support_data
 
@@ -793,9 +792,8 @@ spare_2:
     FIELDNAM: Spare (was Optics HV - ESA B Range)
     VAR_TYPE: support_data
 
-optics_hv_esa_a_enable:
-    <<: *default
-    LABLAXIS: OPTICS_HV_ESA_A_ENABLE
+esaa_en:
+    LABLAXIS: OPTICS_HV_ESAA_ENABLE
     FIELDNAM: Optics HV - ESA A Enable
     VAR_TYPE: support_data
 
@@ -805,43 +803,43 @@ spare_3:
     FIELDNAM: Spare (was Optics HV - ESA A Range)
     VAR_TYPE: support_data
 
-sensor_hv_cmd_err_cnt:
+snsr_hv_cmd_err_cnt:
     <<: *default
     LABLAXIS: SENSOR_HV_CMD_ERR_CNT
     FIELDNAM: Sensor HV -  Number of command errors
     VAR_TYPE: support_data
 
-sensor_hv_arm_err_cnt:
+snsr_hv_arm_err_cnt:
     <<: *default
     LABLAXIS: SENSOR_HV_ARM_ERR_CNT
     FIELDNAM: Sensor HV - Number of Arm errors
     VAR_TYPE: support_data
 
-sensor_hv_master_enable:
+snsr_hv_master_en:
     <<: *default
     LABLAXIS: SENSOR_HV_MASTER_ENABLE
     FIELDNAM: Sensor HV - Master Enable
     VAR_TYPE: support_data
 
-sensor_hv_apd_bias_enable:
+apdb_en:
     <<: *default
     LABLAXIS: SENSOR_HV_APD_BIAS_ENABLE
     FIELDNAM: Sensor HV - APD Bias Enable
     VAR_TYPE: support_data
 
-sensor_hv_p6kv_enable:
+sbulk_en:
     <<: *default
     LABLAXIS: SENSOR_HV_P6KV_ENABLE
     FIELDNAM: Sensor HV - p6KV Enable
     VAR_TYPE: support_data
 
-sensor_hv_stop_mcp_enable:
+stpmcp_en:
     <<: *default
     LABLAXIS: SENSOR_HV_STOP_MCP_ENABLE
     FIELDNAM: Sensor HV - Stop MCP Enable
     VAR_TYPE: support_data
 
-sensor_hv_start_mcp_enable:
+strmcp_en:
     <<: *default
     LABLAXIS: SENSOR_HV_START_MCP_ENABLE
     FIELDNAM: Sensor HV - Start MCP Enable
@@ -853,61 +851,61 @@ spare_4:
     FIELDNAM: Spare for alignment
     VAR_TYPE: support_data
 
-optics_hv_dac_esa_a:
+esaa_dac:
     <<: *default
     LABLAXIS: OPTICS_HV_DAC_ESA_A
     FIELDNAM: Optics HV - ESA A DAC
     VAR_TYPE: support_data
 
-optics_hv_dac_esa_b:
+esab_dac:
     <<: *default
     LABLAXIS: OPTICS_HV_DAC_ESA_B
     FIELDNAM: Optics HV -  ESA B DAC
     VAR_TYPE: support_data
 
-optics_hv_dac_ionbulk:
+iobulk_dac:
     <<: *default
     LABLAXIS: OPTICS_HV_DAC_IONBULK
     FIELDNAM: Optics HV - Ion Bulk DAC
     VAR_TYPE: support_data
 
-sensor_hv_dac_ssdo:
+ssdo_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_SSDO
     FIELDNAM: Sensor HV - SSDO Enable
     VAR_TYPE: support_data
 
-sensor_hv_dac_ssdb:
+ssdb_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_SSDB
     FIELDNAM: Sensor HV - SSD Bias Enable
     VAR_TYPE: support_data
 
-sensor_hv_dac_apdb:
+apdb_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_APDB
     FIELDNAM: Sensor HV - ADP Bias Enable
     VAR_TYPE: support_data
 
-sensor_hv_dac_apdb2:
+apdb2_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_APDB2
     FIELDNAM: Sensor HV - ADP Bias 2 Enable
     VAR_TYPE: support_data
 
-sensor_hv_dac_start_mcp:
+strmcp_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_START_MCP
     FIELDNAM: Sensor HV - Start MCP DAC
     VAR_TYPE: support_data
 
-sensor_hv_dac_stop_mcp:
+stpmcp_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_STOP_MCP
     FIELDNAM: Sensor HV - Stop MCP DAC
     VAR_TYPE: support_data
 
-sensor_hv_dac_stop_optics_grid:
+stpog_dac:
     <<: *default
     LABLAXIS: SENSOR_HV_DAC_STOP_OPTICS_GRID
     FIELDNAM: Sensor HV - Stop Optics Grid DAC
@@ -1312,6 +1310,13 @@ heater_output_state:
     CATDESC: Indicates the current state of the physical heater output
     VAR_TYPE: support_data
 
+heater_output_state_2:
+    <<: *default
+    LABLAXIS: HEATER_OUTPUT_STATE_2
+    FIELDNAM: State of the heater output 2
+    CATDESC: Indicates the current state of the physical heater output
+    VAR_TYPE: support_data
+
 spare_5:
     <<: *default
     LABLAXIS: SPARE_5
@@ -1319,6 +1324,13 @@ spare_5:
     CATDESC: Spare for alignment
     VAR_TYPE: support_data
 
+cpu_idle:
+    <<: *default
+    LABLAXIS: CPU_IDLE
+    FIELDNAM: CPU Idle Percent
+    CATDESC: CPU Idle Percent
+    VAR_TYPE: support_data
+
 cdh_processor_t:
     <<: *default
     LABLAXIS: CDH_PROCESSOR_T
@@ -1349,9 +1361,112 @@ snsr_hvps_t:
     FIELDNAM: CoDICE – Sensor HVPS Temp monitor
     VAR_TYPE: support_data
 
+fee_apd_3p3_digital_v:
+    <<: *default
+    LABLAXIS: FEE_APD_3P3_DIGITAL_V
+    FIELDNAM: FEE; APD Side +3.3V Digital
+    VAR_TYPE: support_data
+
+fee_apd_5p0_analog_v:
+    <<: *default
+    LABLAXIS: FEE_APD_5P0_ANALOG_V
+    FIELDNAM: FEE; APD Side +5.0V Analog
+    VAR_TYPE: support_data
+
+fee_apd_t:
+    <<: *default
+    LABLAXIS: FEE_APD_T
+    FIELDNAM: FEE; APD Side Temperature
+    VAR_TYPE: support_data
+
+fee_apd_12p0_analog_v:
+    <<: *default
+    LABLAXIS: FEE_APD_12P0_ANALOG_V
+    FIELDNAM: FEE; APD Side +12.0V Analog
+    VAR_TYPE: support_data
+
+fee_apd_eb_temp_1_t:
+    <<: *default
+    LABLAXIS: FEE_APD_EB_TEMP_1_T
+    FIELDNAM: FEE; AEB Temp Sensor 1
+    VAR_TYPE: support_data
+
+fee_apd_eb_temp_2_t:
+    <<: *default
+    LABLAXIS: FEE_APD_EB_TEMP_2_T
+    FIELDNAM: FEE; AEB Temp Sensor 2
+    VAR_TYPE: support_data
+
+fee_apd_eb_temp_3_t:
+    <<: *default
+    LABLAXIS: FEE_APD_EB_TEMP_3_T
+    FIELDNAM: FEE; AEB Temp Sensor 3
+    VAR_TYPE: support_data
+
+fee_apd_eb_temp_4_t:
+    <<: *default
+    LABLAXIS: FEE_APD_EB_TEMP_4_T
+    FIELDNAM: FEE; AEB Temp Sensor 4
+    VAR_TYPE: support_data
+
+fee_ssd_3p3_digital_v:
+    <<: *default
+    LABLAXIS: FEE_SSD_3P3_DIGITAL_V
+    FIELDNAM: FEE; SSD Side +3.3V Digital
+    VAR_TYPE: support_data
+
+fee_ssd_5p0_analog_v:
+    <<: *default
+    LABLAXIS: FEE_SSD_5P0_ANALOG_V
+    FIELDNAM: FEE; SSD Side +5.0V Analog
+    VAR_TYPE: support_data
+
+fee_ssd_t:
+    <<: *default
+    LABLAXIS: FEE_SSD_T
+    FIELDNAM: FEE; SSD Side Temperature
+    VAR_TYPE: support_data
+
+fee_ssd_12p0_analog_v:
+    <<: *default
+    LABLAXIS: FEE_SSD_12P0_ANALOG_V
+    FIELDNAM: FEE; SSD Side +12.0V Analog
+    VAR_TYPE: support_data
+
+fee_ssd_eb_temp_1_t:
+    <<: *default
+    LABLAXIS: FEE_SSD_EB_TEMP_1_T
+    FIELDNAM: FEE; SEB Temp Sensor 1
+    VAR_TYPE: support_data
+
+fee_ssd_eb_temp_2_t:
+    <<: *default
+    LABLAXIS: FEE_SSD_EB_TEMP_2_T
+    FIELDNAM: FEE; SEB Temp Sensor 2
+    VAR_TYPE: support_data
+
+fee_ssd_eb_temp_3_t:
+    <<: *default
+    LABLAXIS: FEE_SSD_EB_TEMP_3_T
+    FIELDNAM: FEE; SEB Temp Sensor 3
+    VAR_TYPE: support_data
+
+fee_ssd_eb_temp_4_t:
+    <<: *default
+    LABLAXIS: FEE_SSD_EB_TEMP_4_T
+    FIELDNAM: FEE; SEB Temp Sensor 4
+    VAR_TYPE: support_data
+
 spare_6:
     <<: *default
     LABLAXIS: SPARE_6
     FIELDNAM: Spare for alignment
     CATDESC: Spare for alignment
     VAR_TYPE: support_data
+
+chksum:
+    <<: *default
+    LABLAXIS: CHKSUM
+    FIELDNAM: Packet Checksum
+    CATDESC: Packet Checksum
+    VAR_TYPE: support_data

imap_processing/cdf/config/imap_glows_l1b_variable_attrs.yaml

@@ -251,13 +251,13 @@ filter_temperature_average:
   LABLAXIS: Avgd Temperature
   VALIDMAX: 255
 
-filter_temperature_variance:
+filter_temperature_std_dev:
   <<: *support_data_defaults
-  CATDESC: spin-block-averaged variance of filter temperature
-  FIELDNAM: Variance of filter temperature
+  CATDESC: spin-block-averaged std_dev of filter temperature
+  FIELDNAM: std_dev of filter temperature
   FILLVAL: *max_uint32
   FORMAT: I6
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
   VALIDMAX: *max_uint16
 
 hv_voltage_average:
@@ -269,12 +269,12 @@ hv_voltage_average:
   LABLAXIS: Avg voltage
   VALIDMAX: *max_uint16
 
-hv_voltage_variance:
+hv_voltage_std_dev:
   <<: *support_data_defaults
-  CATDESC: variance of  HV voltage on the CEM, uint encoded
-  FIELDNAM: HV voltage variance
+  CATDESC: std_dev of  HV voltage on the CEM, uint encoded
+  FIELDNAM: HV voltage std_dev
   FILLVAL: *int_fillval
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
   VALIDMAX: *max_uint32
 
 spin_period_average:
@@ -291,13 +291,13 @@ spin_period_average:
   VALIDMIN: 45000 # TBC 14.63 s where 20.9712 s = 65535, rounded down
   VAR_TYPE: support_data
 
-spin_period_variance:
+spin_period_std_dev:
   <<: *support_data_defaults
-  CATDESC: spin-block-averaged variance of spin period
-  FIELDNAM: variance of spin period
+  CATDESC: spin-block-averaged std_dev of spin period
+  FIELDNAM: std_dev of spin period
   FILLVAL: *int_fillval
   FORMAT: I10
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
   VALIDMAX: *max_uint32
 
 # TODO review these
@@ -315,13 +315,13 @@ spin_period_ground_average:
   VALIDMIN: 45000 # TBC 14.63 s where 20.9712 s = 65535, rounded down
   VAR_TYPE: support_data
 
-spin_period_ground_variance:
+spin_period_ground_std_dev:
   <<: *support_data_defaults
-  CATDESC: spin-block-averaged variance of spin period on ground
-  FIELDNAM: ground variance of spin period
+  CATDESC: spin-block-averaged std_dev of spin period on ground
+  FIELDNAM: ground std_dev of spin period
   FILLVAL: *int_fillval
   FORMAT: I10
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
   VALIDMAX: *max_uint32
 
 pulse_length_average:
@@ -333,13 +333,13 @@ pulse_length_average:
   LABLAXIS: Avg pulse len
   VALIDMAX: 255
 
-pulse_length_variance:
+pulse_length_std_dev:
   <<: *support_data_defaults
-  CATDESC: spin-block-averaged variance of pulse length
-  FIELDNAM: Variance of pulse length
+  CATDESC: spin-block-averaged std_dev of pulse length
+  FIELDNAM: std_dev of pulse length
   FILLVAL: *max_uint32
   FORMAT: I10
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
   VALIDMAX: *max_uint16
 
 position_angle_offset_average:
@@ -350,21 +350,21 @@ position_angle_offset_average:
   FORMAT: I4
   LABLAXIS: Avg pos angle
 
-position_angle_offset_variance:
+position_angle_offset_std_dev:
   <<: *support_data_defaults
-  CATDESC: spin-block averaged variance of position angle offset
-  FIELDNAM: Variance of position angle offset
+  CATDESC: spin-block averaged std_dev of position angle offset
+  FIELDNAM: std_dev of position angle offset
   FILLVAL: *max_uint16
   FORMAT: I4
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
 
-spin_axis_orientation_variance:
+spin_axis_orientation_std_dev:
   <<: *support_data_defaults
-  CATDESC: spin-block averaged variance of spin axis orientation
-  FIELDNAM: Variance of spin axis orientation
+  CATDESC: spin-block averaged std_dev of spin axis orientation
+  FIELDNAM: std_dev of spin axis orientation
   FILLVAL: *max_uint16
   FORMAT: I4
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
 
 spin_axis_orientation_average:
   <<: *support_data_defaults
@@ -383,14 +383,14 @@ spacecraft_location_average:
   FORMAT: I4
   LABLAXIS: Avg spacecraft location
 
-spacecraft_location_variance:
+spacecraft_location_std_dev:
   <<: *support_data_defaults
   DEPEND_1: ecliptic
-  CATDESC: spin-block averaged variance of spacecraft location
-  FIELDNAM: Variance of spacecraft location
+  CATDESC: spin-block averaged std_dev of spacecraft location
+  FIELDNAM: std_dev of spacecraft location
   FILLVAL: *max_uint16
   FORMAT: I4
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
 
 spacecraft_velocity_average:
   <<: *support_data_defaults
@@ -401,14 +401,14 @@ spacecraft_velocity_average:
   FORMAT: I4
   LABLAXIS: Avg spacecraft velocity
 
-spacecraft_velocity_variance:
+spacecraft_velocity_std_dev:
   <<: *support_data_defaults
   DEPEND_1: ecliptic
-  CATDESC: spin-block averaged variance of spacecraft velocity
-  FIELDNAM: Variance of spacecraft velocity
+  CATDESC: spin-block averaged std_dev of spacecraft velocity
+  FIELDNAM: std_dev of spacecraft velocity
   FILLVAL: *max_uint16
   FORMAT: I4
-  LABLAXIS: Variance
+  LABLAXIS: std_dev
 
 # End of not-in--dicts in generate_de_dataset