imap-processing 0.4.0__tar.gz → 0.6.0__tar.gz

{imap_processing-0.4.0 → imap_processing-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imap-processing
-Version: 0.4.0
+Version: 0.6.0
 Summary: IMAP Science Operations Center Processing
 License: MIT
 Keywords: IMAP,SDC,SOC,Science Operations
@@ -28,16 +28,17 @@ Provides-Extra: test
 Provides-Extra: tools
 Requires-Dist: cdflib (==1.2.6)
 Requires-Dist: imap-data-access (>=0.5.0)
-Requires-Dist: mypy (>=1.10.1,<2.0.0) ; extra == "dev"
-Requires-Dist: numpy (>=1.26.4,<2.0.0)
+Requires-Dist: mypy (==1.10.1) ; extra == "dev"
+Requires-Dist: numpy (<=3)
 Requires-Dist: numpydoc (>=1.5.0,<2.0.0) ; extra == "doc"
-Requires-Dist: openpyxl (>=3.0.7) ; extra == "tools"
+Requires-Dist: openpyxl (>=3.0.7) ; extra == "test" or extra == "tools"
 Requires-Dist: pandas (>=2.0.0) ; extra == "tools"
 Requires-Dist: pre-commit (>=3.3.3,<4.0.0) ; extra == "dev"
 Requires-Dist: pydata-sphinx-theme ; extra == "doc"
 Requires-Dist: pytest (>=6.2.5) ; extra == "test"
 Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "test"
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "test"
 Requires-Dist: ruff (==0.2.1) ; extra == "dev"
 Requires-Dist: space_packet_parser (>=4.2.0)
 Requires-Dist: sphinx ; extra == "doc"

{imap_processing-0.4.0 → imap_processing-0.6.0}/imap_processing/__init__.py

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

{imap_processing-0.4.0 → imap_processing-0.6.0}/imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "0.4.0"
-__version_tuple__ = (0, 4, 0)
+__version__ = "0.6.0"
+__version_tuple__ = (0, 6, 0)

{imap_processing-0.4.0 → imap_processing-0.6.0}/imap_processing/ccsds/excel_to_xtce.py

@@ -226,7 +226,9 @@ class XTCEGenerator:
                 if pd.isna(row.get("packetName")):
                     # This is a poorly formatted row, skip it
                     continue
-                name = f"{row['packetName']}_{row['mnemonic']}"
+                # separate the packet name and mnemonic with a period
+                # a hyphen is sometimes in the packet name or mnemonic already
+                name = f"{row['packetName']}.{row['mnemonic']}"
                 parameter_ref_entry = Et.SubElement(
                     packet_entry_list, "xtce:ParameterRefEntry"
                 )
@@ -247,9 +249,8 @@ class XTCEGenerator:
         """
         parameter = Et.SubElement(self._parameter_set, "xtce:Parameter")
         # Combine the packet name and mnemonic to create a unique parameter name
-        name = f"{row['packetName']}_{row['mnemonic']}"
+        name = f"{row['packetName']}.{row['mnemonic']}"
         parameter.attrib["name"] = name
-        # UINT8, ...
         parameter.attrib["parameterTypeRef"] = name
 
         # Add descriptions if they exist
@@ -262,7 +263,7 @@ class XTCEGenerator:
         length_in_bits = int(row["lengthInBits"])
 
         # Add the parameterTypeRef for this row
-        if "UINT" in row["dataType"]:
+        if "UINT" in row["dataType"] or "FILL" in row["dataType"]:
             parameter_type = Et.SubElement(
                 self._parameter_type_set, "xtce:IntegerParameterType"
             )
@@ -283,6 +284,15 @@ class XTCEGenerator:
             encoding.attrib["sizeInBits"] = str(length_in_bits)
             encoding.attrib["encoding"] = "signed"
 
+        elif "FLOAT" in row["dataType"]:
+            parameter_type = Et.SubElement(
+                self._parameter_type_set, "xtce:FloatParameterType"
+            )
+            parameter_type.attrib["name"] = name
+            encoding = Et.SubElement(parameter_type, "xtce:FloatDataEncoding")
+            encoding.attrib["sizeInBits"] = str(length_in_bits)
+            encoding.attrib["encoding"] = "IEEE-754"
+
         elif "BYTE" in row["dataType"]:
             parameter_type = Et.SubElement(
                 self._parameter_type_set, "xtce:BinaryParameterType"
@@ -311,11 +321,17 @@ class XTCEGenerator:
             # TODO: Do we want to allow fixed length values?
             # fixed_value = Et.SubElement(size_in_bits, "xtce:FixedValue")
             # fixed_value.text = str(row["lengthInBits"])
+        else:
+            raise ValueError(f"Unknown data type for {name}: {row['dataType']}")
 
         if row["convertAs"] == "ANALOG":
             # Go look up the conversion in the AnalogConversions tab
             # and add it to the encoding
             self._add_analog_conversion(row, encoding)
+        elif row["convertAs"] == "STATE":
+            # Go look up the states in the States tab
+            # and add them to the parameter type
+            self._add_state_conversion(row, parameter_type)
 
     def _add_analog_conversion(self, row: pd.Series, encoding: Et.Element) -> None:
         """
@@ -350,6 +366,34 @@ class XTCEGenerator:
                 term.attrib["coefficient"] = str(conversion[col])
                 term.attrib["exponent"] = str(i)
 
+    def _add_state_conversion(self, row: pd.Series, parameter_type: Et.Element) -> None:
+        """
+        Add a state conversion to the parameter type.
+
+        Changing from an IntegerParameterType to an EnumeratedParameterType. Adding
+        the list of state mappings to the parameter type.
+
+        Parameters
+        ----------
+        row : pandas.Row
+            Row to be added to the XTCE file, containing mnemonic, packetName.
+        parameter_type : Element
+            The parameter type element to add the conversion to.
+        """
+        # It is an EnumeratedParameterType rather than an IntegerParameterType
+        parameter_type.tag = "xtce:EnumeratedParameterType"
+        enumeration_list = Et.SubElement(parameter_type, "xtce:EnumerationList")
+        # Lookup the enumeration states for this parameter from the States sheet
+        state_sheet = self.sheets["States"]
+        state_sheet = state_sheet.loc[
+            (state_sheet["packetName"] == row["packetName"])
+            & (state_sheet["mnemonic"] == row["mnemonic"])
+        ]
+        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"])
+
     def to_xml(self, output_xml_path: Path) -> None:
         """
         Create and output an XTCE file from the Element Tree representation.

{imap_processing-0.4.0 → imap_processing-0.6.0}/imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml

@@ -21,90 +21,104 @@ imap_codice_l1a_hskp:
     Logical_source: imap_codice_l1a_hskp
     Logical_source_description: IMAP Mission CoDICE Instrument Level-1A Housekeeping Data.
 
-imap_codice_l1a_hi_counters_aggregated:
+imap_codice_l1a_hi-counters-aggregated:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_hi-counters-aggregated->Level-1A Hi Aggregated Instrument Counts Data
     Logical_source: imap_codice_l1a_hi-counters-aggregated
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Aggregated Instrument Counts Data.
 
-imap_codice_l1a_hi_counters_singles:
+imap_codice_l1a_hi-counters-singles:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_hi-counters-singles->Level-1A Hi Single Instrument Counts Data
     Logical_source: imap_codice_l1a_hi-counters-singles
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Single Instrument Counts Data.
 
-imap_codice_l1a_hi_omni:
+imap_codice_l1a_hi-omni:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_hi-omni->Level-1A Hi Omnidirectional Data
     Logical_source: imap_codice_l1a_hi-omni
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Omnidirectional Data.
 
-imap_codice_l1a_hi_sectored:
+imap_codice_l1a_hi-sectored:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_hi-sectored->Level-1A Hi Sectored Data
     Logical_source: imap_codice_l1a_hi-sectored
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Sectored Data.
 
-imap_codice_l1a_lo_counters_aggregated:
+imap_codice_l1a_hi-pha:
+    <<: *instrument_base
+    Data_level: 1A
+    Data_type: L1A_hi-pha->Level-1A Hi Event Data
+    Logical_source: imap_codice_l1a_hi-pha
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1A Event Data.
+
+imap_codice_l1a_lo-counters-aggregated:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-counters-aggregated->Level-1A Lo Aggregated Instrument Counts Data
     Logical_source: imap_codice_l1a_lo-counters-aggregated
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Aggregated Instrument Counts Data.
 
-imap_codice_l1a_lo_counters_singles:
+imap_codice_l1a_lo-counters-singles:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-counters-aggregated->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_codice_l1a_lo_sw_angular:
+imap_codice_l1a_lo-sw-angular:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-sw-angular->Level-1A Lo Sunward Angular Counts Data
     Logical_source: imap_codice_l1a_lo-sw-angular
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Sunward Angular Counts Data.
 
-imap_codice_l1a_lo_nsw_angular:
+imap_codice_l1a_lo-nsw-angular:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-nsw-angular->Level-1A Lo Non-Sunward Angular Counts Data
     Logical_source: imap_codice_l1a_lo-nsw-angular
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Non-Sunward Angular Counts Data.
 
-imap_codice_l1a_lo_sw_priority:
+imap_codice_l1a_lo-sw-priority:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-sw-priority->Level-1A Lo Sunward Priority Counts Data
     Logical_source: imap_codice_l1a_lo-sw-priority
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Sunward Priority Counts Data.
 
-imap_codice_l1a_lo_nsw_priority:
+imap_codice_l1a_lo-nsw-priority:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-nsw-priority->Level-1A Lo Non-Sunward Priority Counts Data
     Logical_source: imap_codice_l1a_lo-nsw-priority
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Non-Sunward Priority Counts Data.
 
-imap_codice_l1a_lo_sw_species:
+imap_codice_l1a_lo-sw-species:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-sw-species->Level-1A Lo Sunward Species Counts Data
     Logical_source: imap_codice_l1a_lo-sw-species
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Sunward Species Counts Data.
 
-imap_codice_l1a_lo_nsw_species:
+imap_codice_l1a_lo-nsw-species:
     <<: *instrument_base
     Data_level: 1A
     Data_type: L1A_lo-nsw-species->Level-1A Lo Non-Sunward Species Counts Data
     Logical_source: imap_codice_l1a_lo-nsw-species
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Non-Sunward Species Counts Data.
 
+imap_codice_l1a_lo-pha:
+    <<: *instrument_base
+    Data_level: 1A
+    Data_type: L1A_lo-pha->Level-1A Lo Event Data
+    Logical_source: imap_codice_l1a_lo-pha
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1A Event Data.
+
 # L1b
 imap_codice_l1b_hskp:
     <<: *instrument_base