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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imap-processing
-Version: 0.4.0
+Version: 0.5.0
 Summary: IMAP Science Operations Center Processing
 License: MIT
 Keywords: IMAP,SDC,SOC,Science Operations
@@ -29,9 +29,9 @@ 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: 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"

{imap_processing-0.4.0 → imap_processing-0.5.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.5.0"
+__version_tuple__ = (0, 5, 0)

{imap_processing-0.4.0 → imap_processing-0.5.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.5.0}/imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml

@@ -49,6 +49,13 @@ imap_codice_l1a_hi_sectored:
     Logical_source: imap_codice_l1a_hi-sectored
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Sectored Data.
 
+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
@@ -105,6 +112,13 @@ imap_codice_l1a_lo_nsw_species:
     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

{imap_processing-0.4.0 → imap_processing-0.5.0}/imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml

@@ -1,14 +1,24 @@
+# TODO: Some currently blank attributes may be removed once
+# cdf_attribute_manager.py is updated to only check required attributes.
+# See comment here:
+# https://github.com/IMAP-Science-Operations-Center/imap_processing/pull/711#discussion_r1690212527
 # <=== Defaults ===>
 default_attrs: &default
-  # Assumed values for all variable attrs unless overwritten
-  DISPLAY_TYPE: no_plot
-  FILLVAL: -9223372036854775808
-  FORMAT: I12
-  UNITS: dN
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
-  VAR_TYPE: data
-  SCALETYP: linear
+    CATDESC: ""
+    DISPLAY_TYPE: no_plot
+    FIELDNAM: ""
+    FILLVAL: -9223372036854775808
+    FORMAT: I12
+    LABLAXIS: ""
+    REFERENCE_POSITION: ""
+    RESOLUTION: ""
+    SCALETYP: linear
+    TIME_BASE: ""
+    TIME_SCALE: ""
+    UNITS: dN
+    VALIDMIN: -9223372036854775808
+    VALIDMAX: 9223372036854775807
+    VAR_TYPE: data
 
 codice_support_attrs: &support_default
     <<: *default
@@ -26,42 +36,57 @@ energy_attrs:
     VALIDMAX: 127
     VAR_TYPE: support_data
 
-epoch_attrs:
-  CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
-  FIELDNAM: epoch
-  LABLAXIS: epoch
-  FILLVAL: -9223372036854775808
-  FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
-  UNITS: ns
-  VAR_TYPE: support_data
-  SCALETYP: linear
-  MONOTON: INCREASE
-  TIME_BASE: J2000
-  TIME_SCALE: Terrestrial Time
-  REFERENCE_POSITION: Rotating Earth Geoid
+inst_az_attrs:
+    <<: *default
+    CATDESC: Azimuth
+    FIELDNAM: Azimuth
+    FORMAT: I2
+    LABLAXIS: Azimuth
+    UNITS: ' '
+    VALIDMIN: 0
+    VALIDMAX: 31
+    VAR_TYPE: support_data
+
+spin_sector_attrs:
+    <<: *default
+    CATDESC: Spin sector indicating range of spin angles
+    FIELDNAM: Spin sector
+    FORMAT: I2
+    LABLAXIS: spin sector
+    UNITS: ' '
+    VALIDMIN: 0
+    VALIDMAX: 11
+    VAR_TYPE: support_data
 
 # <=== Labels ===>
 energy_label:
     CATDESC: Energy per charge (E/q) sweeping step
+    DISPLAY_TYPE: ""
     FIELDNAM: Energy step
+    FILLVAL: ""
     FORMAT: A3
+    LABLAXIS: ""
+    REFERENCE_POSITION: ""
+    RESOLUTION: ""
+    TIME_BASE: ""
+    TIME_SCALE: ""
+    UNITS: ""
+    VALIDMAX: ""
+    VALIDMIN: ""
     VAR_TYPE: metadata
 
 # <=== Dataset Attributes ===>
-# TODO: resolve ISTP warning: Width of F10 FORMAT may be insufficient for
-#       values.  Adjust FORMAT or VALIDMIN/VALIDMAX value to resolve.
 acquisition_times_attrs:
     <<: *default
     CATDESC: Time of acquisition for the energy step
+    DEPEND_1: energy
     FIELDNAM: Acquisition Time
-    FILLVAL: 1.7976931348623157e+308
+    FILLVAL: .NAN
     FORMAT: F10.3
     LABLAXIS: Acq Time
     UNITS: ms
     VALIDMIN: 0
-    VALIDMAX: 1.7976931348623157e+308
+    VALIDMAX: 1000
     VAR_TYPE: support_data
 
 counters_attrs: &counters
@@ -79,6 +104,7 @@ counters_attrs: &counters
 esa_sweep_attrs:
     <<: *default
     CATDESC: ElectroStatic Analyzer Energy Values
+    DEPEND_1: energy
     FIELDNAM: ESA Voltage
     FORMAT: I19
     LABLAXIS: ESA V

{imap_processing-0.4.0 → imap_processing-0.5.0}/imap_processing/cdf/config/imap_codice_l1b_variable_attrs.yaml

@@ -1,14 +1,20 @@
 # <=== Defaults ===>
 default_attrs: &default
-  # Assumed values for all variable attrs unless overwritten
-  DISPLAY_TYPE: no_plot
-  FILLVAL: -9223372036854775808
-  FORMAT: I12
-  UNITS: dN
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
-  VAR_TYPE: data
-  SCALETYP: linear
+    CATDESC: ""
+    DISPLAY_TYPE: no_plot
+    FIELDNAM: ""
+    FILLVAL: -9223372036854775808
+    FORMAT: I12
+    LABLAXIS: ""
+    REFERENCE_POSITION: ""
+    RESOLUTION: ""
+    SCALETYP: linear
+    TIME_BASE: ""
+    TIME_SCALE: ""
+    UNITS: dN
+    VALIDMIN: -9223372036854775808
+    VALIDMAX: 9223372036854775807
+    VAR_TYPE: data
 
 codice_support_attrs: &support_default
     <<: *default
@@ -26,42 +32,57 @@ energy_attrs:
     VALIDMAX: 127
     VAR_TYPE: support_data
 
-epoch_attrs:
-  CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
-  FIELDNAM: epoch
-  LABLAXIS: epoch
-  FILLVAL: -9223372036854775808
-  FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
-  UNITS: ns
-  VAR_TYPE: support_data
-  SCALETYP: linear
-  MONOTON: INCREASE
-  TIME_BASE: J2000
-  TIME_SCALE: Terrestrial Time
-  REFERENCE_POSITION: Rotating Earth Geoid
+inst_az_attrs:
+    <<: *default
+    CATDESC: Azimuth
+    FIELDNAM: Azimuth
+    FORMAT: I2
+    LABLAXIS: Azimuth
+    UNITS: ' '
+    VALIDMIN: 0
+    VALIDMAX: 31
+    VAR_TYPE: support_data
+
+spin_sector_attrs:
+    <<: *default
+    CATDESC: Spin sector indicating range of spin angles
+    FIELDNAM: Spin sector
+    FORMAT: I4
+    LABLAXIS: spin sector
+    UNITS: ' '
+    VALIDMIN: 0
+    VALIDMAX: 1152
+    VAR_TYPE: support_data
 
 # <=== Labels ===>
 energy_label:
     CATDESC: Energy per charge (E/q) sweeping step
+    DISPLAY_TYPE: ""
     FIELDNAM: Energy step
+    FILLVAL: ""
     FORMAT: A3
+    LABLAXIS: ""
+    REFERENCE_POSITION: ""
+    RESOLUTION: ""
+    TIME_BASE: ""
+    TIME_SCALE: ""
+    UNITS: ""
+    VALIDMAX: ""
+    VALIDMIN: ""
     VAR_TYPE: metadata
 
 # <=== Dataset Attributes ===>
-# TODO: resolve ISTP warning: Width of F10 FORMAT may be insufficient for
-#       values.  Adjust FORMAT or VALIDMIN/VALIDMAX value to resolve.
 acquisition_times_attrs:
     <<: *default
     CATDESC: Time of acquisition for the energy step
+    DEPEND_1: energy
     FIELDNAM: Acquisition Time
-    FILLVAL: 1.7976931348623157e+308
+    FILLVAL: .NAN
     FORMAT: F10.3
     LABLAXIS: Acq Time
     UNITS: ms
     VALIDMIN: 0
-    VALIDMAX: 1.7976931348623157e+308
+    VALIDMAX: 1000
     VAR_TYPE: support_data
 
 counters_attrs: &counters
@@ -71,16 +92,15 @@ counters_attrs: &counters
     DEPEND_1: energy
     DISPLAY_TYPE: time_series
     FIELDNAM: Fill in at creation
-    FILLVAL: 1.7976931348623157e+308
-    FORMAT: F10.3
     LABL_PTR_1: energy_label
-    UNITS: rates
+    UNITS: counts
     VALIDMIN: 0
-    VALIDMAX: 1.7976931348623157e+308
+    VALIDMAX: 8388607  # max value for a signed 24-bit integer
 
 esa_sweep_attrs:
     <<: *default
     CATDESC: ElectroStatic Analyzer Energy Values
+    DEPEND_1: energy
     FIELDNAM: ESA Voltage
     FORMAT: I19
     LABLAXIS: ESA V

imap_processing-0.5.0/imap_processing/cdf/config/imap_default_global_cdf_attrs.yaml

@@ -0,0 +1,17 @@
+# Reference for sections: https://spdf.gsfc.nasa.gov/istp_guide/gattributes.html
+# Reference from IBEX: https://spdf.gsfc.nasa.gov/pub/software/cdawlib/0SKELTABLES/ibex_h3_ena_lo_r08_omni_f3-gdf-maps_5yr_00000000_v01.skt
+Project: STP>Solar Terrestrial Probes
+Source_name: IMAP>Interstellar Mapping and Acceleration Probe
+Discipline: Solar Physics>Heliospheric Physics
+Mission_group: IMAP
+PI_name: Prof. David J. McComas
+PI_affiliation: Princeton University
+File_naming_convention: source_descriptor_datatype_yyyyMMdd_vNNN
+Acknowledgement: >
+  Please acknowledge the IMAP Mission Principal Investigator, Prof. David J. McComas of Princeton University.
+Rules_of_use: >
+  All IMAP data products are publicly released and citable for use in publications.
+  Please consult the IMAP team publications and personnel for further details
+  on production, processing, and usage of these data.
+LINK_TITLE: IMAP The Interstellar Mapping and Acceleration Probe
+HTTP_LINK: https://imap.princeton.edu/

{imap_processing-0.4.0 → imap_processing-0.5.0}/imap_processing/cdf/config/imap_glows_global_cdf_attrs.yaml

@@ -2,14 +2,15 @@ instrument_base: &instrument_base
   Descriptor: GLOWS>GLObal Solar Wind Structure
   TEXT: >
     The GLObal Solar Wind Structure (GLOWS) is a non-imaging single-pixel Lyman-alpha
-    photometer that will be used to observe the sky distribution of the helioglow to
-    better understand the evolution of the solar wind structure.
-    The Lyman-alpha photon counts from these observations can be used to build a more
-    comprehensive picture of the solar wind structure and how it changes through the
-    solar cycles.
+    photometer to investigate the global heliolatitudinal structure of the solar wind
+    and its evolution during the solar cycle. Additionally, GLOWS investigates the
+    distribution of interstellar neutral hydrogen (ISN H) and the solar radiation
+    pressure acting on ISN H. The objectives of GLOWS are accomplished by observation
+    of the modulation of heliospheric backscatter glow of ISN H (the helioglow)
+    along a scanning circle in the sky.
     GLOWS design and assembly is led by the Space Research Center, Warsaw, Poland
     (CBK PAN). See https://imap.princeton.edu/instruments/glows for more details.
-  Instrument_type: Particles (space)
+  Instrument_type: Imagers (space)
 
 imap_glows_l1a_hist:
   <<: *instrument_base