imap-processing 0.2.0__tar.gz → 0.3.0__tar.gz

{imap_processing-0.2.0 → imap_processing-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imap-processing
-Version: 0.2.0
+Version: 0.3.0
 Summary: IMAP Science Operations Center Processing
 License: MIT
 Keywords: IMAP,SDC,SOC,Science Operations
@@ -26,9 +26,9 @@ Provides-Extra: dev
 Provides-Extra: doc
 Provides-Extra: test
 Provides-Extra: tools
-Requires-Dist: bitstring (>=4.0.1)
-Requires-Dist: cdflib (>=1.2.3)
-Requires-Dist: imap-data-access (>=0.2.0)
+Requires-Dist: cdflib (==1.2.6)
+Requires-Dist: imap-data-access (>=0.5.0)
+Requires-Dist: numpy (>=1.26.4,<2.0.0)
 Requires-Dist: numpydoc (>=1.5.0,<2.0.0) ; extra == "doc"
 Requires-Dist: openpyxl (>=3.0.7) ; extra == "tools"
 Requires-Dist: pandas (>=2.0.0) ; extra == "tools"
@@ -36,19 +36,22 @@ 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: ruff (>=0.1.7) ; extra == "dev"
-Requires-Dist: space_packet_parser (>=4.1.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: ruff (==0.2.1) ; extra == "dev"
+Requires-Dist: space_packet_parser (>=4.2.0)
 Requires-Dist: sphinx ; extra == "doc"
-Requires-Dist: sphinxcontrib-openapi (>=0.8.3,<0.9.0)
+Requires-Dist: sphinxcontrib-openapi (>=0.8.3,<0.9.0) ; extra == "doc"
 Requires-Dist: spiceypy (>=6.0.0)
 Requires-Dist: xarray (>=2023.0.0)
 Description-Content-Type: text/markdown
 
 # IMAP (Interstellar Mapping and Acceleration Probe)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![readthedocs](https://readthedocs.org/projects/imap-processing/badge/?version=latest)](https://imap-processing.readthedocs.io/en/latest/)
+<!-- DOI-BADGE -->
+[![DOI](https://zenodo.org/badge/654679818.svg)](https://zenodo.org/badge/latestdoi/654679818)
 
 The Interstellar Mapping and Acceleration Probe (IMAP) is an exciting project aimed at studying the interstellar medium and investigating the acceleration mechanisms of particles within our galaxy. IMAP utilizes cutting-edge technology and advanced instrumentation to gather valuable data and expand our understanding of space.
 
@@ -85,6 +88,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/bryan-harter"><img src="https://avatars.githubusercontent.com/u/41062454?v=4?s=100" width="100px;" alt="Bryan Harter"/><br /><sub><b>Bryan Harter</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=bryan-harter" title="Code">💻</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=bryan-harter" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/mstrumik"><img src="https://avatars.githubusercontent.com/u/142874888?v=4?s=100" width="100px;" alt="mstrumik"/><br /><sub><b>mstrumik</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/pulls?q=is%3Apr+reviewed-by%3Amstrumik" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vmartinez-cu"><img src="https://avatars.githubusercontent.com/u/39746325?v=4?s=100" width="100px;" alt="vmartinez-cu"/><br /><sub><b>vmartinez-cu</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/pulls?q=is%3Apr+reviewed-by%3Avmartinez-cu" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=vmartinez-cu" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/subagonsouth"><img src="https://avatars.githubusercontent.com/u/16110870?v=4?s=100" width="100px;" alt="Tim Plummer"/><br /><sub><b>Tim Plummer</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/pulls?q=is%3Apr+reviewed-by%3Asubagonsouth" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=subagonsouth" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/daralynnrhode"><img src="https://avatars.githubusercontent.com/u/143308810?v=4?s=100" width="100px;" alt="Daralynn Rhode"/><br /><sub><b>Daralynn Rhode</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=daralynnrhode" title="Code">💻</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=daralynnrhode" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/anamanica"><img src="https://avatars.githubusercontent.com/u/171708990?v=4?s=100" width="100px;" alt="anamanica"/><br /><sub><b>anamanica</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=anamanica" title="Code">💻</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=anamanica" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>
@@ -95,3 +102,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+

{imap_processing-0.2.0 → imap_processing-0.3.0}/README.md

@@ -1,8 +1,10 @@
 # IMAP (Interstellar Mapping and Acceleration Probe)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![readthedocs](https://readthedocs.org/projects/imap-processing/badge/?version=latest)](https://imap-processing.readthedocs.io/en/latest/)
+<!-- DOI-BADGE -->
+[![DOI](https://zenodo.org/badge/654679818.svg)](https://zenodo.org/badge/latestdoi/654679818)
 
 The Interstellar Mapping and Acceleration Probe (IMAP) is an exciting project aimed at studying the interstellar medium and investigating the acceleration mechanisms of particles within our galaxy. IMAP utilizes cutting-edge technology and advanced instrumentation to gather valuable data and expand our understanding of space.
 
@@ -39,6 +41,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/bryan-harter"><img src="https://avatars.githubusercontent.com/u/41062454?v=4?s=100" width="100px;" alt="Bryan Harter"/><br /><sub><b>Bryan Harter</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=bryan-harter" title="Code">💻</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=bryan-harter" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/mstrumik"><img src="https://avatars.githubusercontent.com/u/142874888?v=4?s=100" width="100px;" alt="mstrumik"/><br /><sub><b>mstrumik</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/pulls?q=is%3Apr+reviewed-by%3Amstrumik" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vmartinez-cu"><img src="https://avatars.githubusercontent.com/u/39746325?v=4?s=100" width="100px;" alt="vmartinez-cu"/><br /><sub><b>vmartinez-cu</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/pulls?q=is%3Apr+reviewed-by%3Avmartinez-cu" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=vmartinez-cu" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/subagonsouth"><img src="https://avatars.githubusercontent.com/u/16110870?v=4?s=100" width="100px;" alt="Tim Plummer"/><br /><sub><b>Tim Plummer</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/pulls?q=is%3Apr+reviewed-by%3Asubagonsouth" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=subagonsouth" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/daralynnrhode"><img src="https://avatars.githubusercontent.com/u/143308810?v=4?s=100" width="100px;" alt="Daralynn Rhode"/><br /><sub><b>Daralynn Rhode</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=daralynnrhode" title="Code">💻</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=daralynnrhode" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/anamanica"><img src="https://avatars.githubusercontent.com/u/171708990?v=4?s=100" width="100px;" alt="anamanica"/><br /><sub><b>anamanica</b></sub></a><br /><a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=anamanica" title="Code">💻</a> <a href="https://github.com/IMAP-Science-Operations-Center/imap_processing/commits?author=anamanica" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>
@@ -48,4 +54,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

{imap_processing-0.2.0 → imap_processing-0.3.0}/imap_processing/__init__.py

@@ -7,52 +7,33 @@ contains code for each processing level.
 There are utilities to read and write IMAP data files in
 the CDF file format, and to interact with the SPICE toolkit.
 """
-__version__ = "0.2.0"
 
 # When imap_processing is installed using pip, we need to be able to find the
 # packet definitions directory path.
 #
 # This directory is used by the imap_processing package to find the packet definitions.
-import os
 from pathlib import Path
 
-# NOTE: Use a config dictionary, so it is a mutable global object,
-#       otherwise updating previous imports from other modules
-#       wouldn't have been updated globally (for example if referencing a string).
-config = {"DATA_DIR": Path(os.getenv("IMAP_DATA_DIR") or Path.cwd() / "imap-data")}
-"""imap_processing configuration dictionary.
+import numpy as np
 
-DATA_DIR : This is where the file data is stored and organized by instrument and level.
-    The default location is in the current working directory, but can be
-    set on the command line using the --data-dir option, or through
-    the environment variable IMAP_DATA_DIR.
-"""
+from imap_processing._version import __version__, __version_tuple__  # noqa: F401
 
 # Eg. imap_module_directory = /usr/local/lib/python3.11/site-packages/imap_processing
 imap_module_directory = Path(__file__).parent
 
-INSTRUMENTS = [
-    "codice",
-    "glows",
-    "hi",
-    "hit",
-    "idex",
-    "lo",
-    "mag",
-    "swapi",
-    "swe",
-    "ultra",
-]
-
+# TODO: should we move this to imap-data-access?
 PROCESSING_LEVELS = {
     "codice": ["l0", "l1a", "l1b", "l2"],
     "glows": ["l0", "l1a", "l1b", "l2"],
     "hi": ["l0", "l1a", "l1b", "l1c", "l2"],
     "hit": ["l0", "l1a", "l1b", "l2"],
-    "idex": ["l0", "l1a", "l1b", "l1c", "l2"],
+    "idex": ["l0", "l1", "l2"],
     "lo": ["l0", "l1a", "l1b", "l1c", "l2"],
     "mag": ["l0", "l1a", "l1b", "l1c", "l2pre", "l2"],
     "swapi": ["l0", "l1", "l2"],
     "swe": ["l0", "l1a", "l1b", "l2"],
-    "ultra": ["l0", "l1a", "l1b", "l1c", "l1d", "l2"],
+    "ultra": ["l0", "l1a", "l1b", "l1c", "l2"],
 }
+
+# Reference start time (launch time or epoch)
+launch_time = np.datetime64("2010-01-01T00:01:06.184", "ns")

imap_processing-0.3.0/imap_processing/_version.py

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

imap_processing-0.3.0/imap_processing/cdf/cdf_attribute_manager.py

@@ -0,0 +1,239 @@
+"""Class for creating and managing CDF attrs.
+
+Developed based of HermesDataSchema from HERMES-SOC/hermes_core.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import yaml
+
+DEFAULT_GLOBAL_CDF_ATTRS_FILE = "imap_default_global_cdf_attrs.yaml"
+DEFAULT_GLOBAL_CDF_ATTRS_SCHEMA_FILE = "default_global_cdf_attrs_schema.yaml"
+DEFAULT_VARIABLE_CDF_ATTRS_SCHEMA_FILE = "default_variable_cdf_attrs_schema.yaml"
+
+
+class CdfAttributeManager:
+    """
+    Class for creating and managing CDF attributes based out of yaml files.
+
+    This class is based on the HERMES SWxSOC project for managing CDF attributes, but
+    is intended to be a flexible and very lightweight way of managing CDF attribute
+    creation and validation.
+
+    To use, you can load one or many global and variable attribute files:
+
+    ```
+    cdf_attr_manager = CdfAttributeManager(data_dir)
+    cdf_attr_manager.load_global_attributes("global_attrs.yaml")
+    cdf_attr_manager.load_global_attributes("instrument_global_attrs.yaml")
+    cdf_attr_manager.load_variable_attributes("variable_attrs.yaml")
+    ```
+
+    Later files will overwrite earlier files if the same attribute is defined.
+
+    You can then get the global and variable attributes:
+
+    If you provide an instrument_id, it will also add the attributes defined under
+    instrument_id. If this is not included, then only the attributes defined in the top
+    level of the file are used.
+
+    ```
+    # Instrument ID is optional for refining the attributes used from the file
+    global_attrs = cdf_attr_manager.get_global_attributes(instrument_id)
+    variable_attrs = cdf_attr_manager.get_variable_attributes(variable_name)
+    ```
+
+    The variable and global attributes are validated against the schemas upon calling
+    `get_global_attributes` and `get_variable_attributes`.
+
+    Attributes
+    ----------
+    source_dir : Path
+        The directory containing the schema and variable files - nominally config/
+    """
+
+    def __init__(self, data_dir: Path):
+        """
+        Initialize the CdfAttributeManager and read schemas from data_dir.
+
+        Parameters
+        ----------
+        data_dir : Path
+            The directory containing the schema and variable files - nominally config/
+        """
+        # TODO: Split up schema source and data source?
+        self.source_dir = data_dir
+
+        # TODO: copied from hermes_core. Currently we can use default schema, but
+        # We should add some way of extending the schema and remove all the HERMES
+        # specific stuff
+        # Data Validation, Complaiance,
+        self.global_attribute_schema = self._load_default_global_attr_schema()
+
+        # Data Validation and Compliance for Variable Data
+        self.variable_attribute_schema = self._load_default_variable_attr_schema()
+
+        # Load Default IMAP Global Attributes
+        self.global_attributes = CdfAttributeManager._load_yaml_data(
+            self.source_dir / DEFAULT_GLOBAL_CDF_ATTRS_FILE
+        )
+        self.variable_attributes = dict()
+
+    def _load_default_global_attr_schema(self) -> dict:
+        """
+        Load the default global schema from the source directory.
+
+        Returns
+        -------
+        the dict representing the global schema
+        """
+        default_schema_path = (
+            self.source_dir / "shared" / DEFAULT_GLOBAL_CDF_ATTRS_SCHEMA_FILE
+        )
+        # Load the Schema
+        return CdfAttributeManager._load_yaml_data(default_schema_path)
+
+    def _load_default_variable_attr_schema(self) -> dict:
+        """
+        Load the default variable schema from the source directory.
+
+        Returns
+        -------
+        the dict representing the variable schema
+        """
+        default_schema_path = (
+            self.source_dir / "shared" / DEFAULT_VARIABLE_CDF_ATTRS_SCHEMA_FILE
+        )
+        # Load the Schema
+        return CdfAttributeManager._load_yaml_data(default_schema_path)
+
+    def load_global_attributes(self, file_path: str):
+        """
+        Update the global attributes property with the attributes from the file.
+
+        Calling this method multiple times on different files will add all the
+        attributes from the files, overwriting existing attributes if they are
+        duplicated.
+
+        Parameters
+        ----------
+        file_path: str
+            file path to load, under self.source_dir.
+
+        """
+        self.global_attributes.update(
+            CdfAttributeManager._load_yaml_data(self.source_dir / file_path)
+        )
+
+    def add_global_attribute(self, attribute_name: str, attribute_value: str) -> None:
+        """
+        Add a single global attribute to the global attributes.
+
+        This is intended only for dynamic global attributes which change per-file, such
+        as Data_version. It is not intended to be used for static attributes, which
+        should all be included in the YAML files.
+
+        This will overwrite any existing value in attribute_name if it exists. The
+        attribute must be in the global schema, or it will not be included as output.
+
+        Parameters
+        ----------
+        attribute_name: str
+            The name of the attribute to add.
+        attribute_value: str
+            The value of the attribute to add.
+        """
+        self.global_attributes[attribute_name] = attribute_value
+
+    @staticmethod
+    def _load_yaml_data(file_path: str | Path) -> dict:
+        """
+        Load a yaml file from the provided path.
+
+        Parameters
+        ----------
+        file_path: str | Path
+            path to the yaml file to load.
+
+        Returns
+        -------
+            Loaded yaml.
+        """
+        with open(file_path) as file:
+            return yaml.safe_load(file)
+
+    def get_global_attributes(self, instrument_id: str | None = None) -> dict:
+        """
+        Generate a dictionary global attributes based off the loaded schema and attrs.
+
+        Validates against the global schema to ensure all required variables are
+        present. It can also include instrument specific global attributes if
+        instrumet_id is set.
+
+        If an instrument_id is provided, the level and instrument specific
+        attributes that were previously loaded using add_instrument_global_attrs will
+        be included.
+
+        Parameters
+        ----------
+        instrument_id : str
+            The id of the CDF file, used to retrieve instrument and level
+            specific global attributes. Suggested value is the logical_source_id.
+
+        Returns
+        -------
+        output : dict
+            The global attribute values created from the input global attribute files
+            and schemas.
+        """
+        output = dict()
+        for attr_name, attr_schema in self.global_attribute_schema.items():
+            if attr_name in self.global_attributes:
+                output[attr_name] = self.global_attributes[attr_name]
+            # Retrieve instrument specific global attributes from the variable file
+            elif (
+                instrument_id is not None
+                and attr_name in self.global_attributes[instrument_id]
+            ):
+                output[attr_name] = self.global_attributes[instrument_id][attr_name]
+            elif attr_schema["required"] and attr_name not in self.global_attributes:
+                # TODO throw an error
+                output[attr_name] = None
+
+        return output
+
+    def load_variable_attributes(self, file_name: str) -> None:
+        """
+        Add variable attributes for a given filename.
+
+        Parameters
+        ----------
+        file_name : str
+            The name of the file to load from self.source_dir
+        """
+        # Add variable attributes from file_name. Each variable name should have the
+        # required sub fields as defined in the variable schema.
+        raw_var_attrs = CdfAttributeManager._load_yaml_data(self.source_dir / file_name)
+        var_attrs = raw_var_attrs.copy()
+
+        self.variable_attributes.update(var_attrs)
+
+    def get_variable_attributes(self, variable_name: str) -> dict:
+        """
+        Get the attributes for a given variable name.
+
+        It retrieves the variable from previously loaded variable definition files and
+        validates against the defined variable schemas.
+
+        Parameters
+        ----------
+        variable_name : str
+            The name of the variable to retrieve attributes for.
+        """
+        # TODO: Create a variable attribute schema file, validate here
+        if variable_name in self.variable_attributes:
+            return self.variable_attributes[variable_name]
+        # TODO: throw an error?
+        return {}

imap_processing-0.3.0/imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml

@@ -0,0 +1,198 @@
+instrument_base: &instrument_base
+  Descriptor: &desc
+    CoDICE>Compact Dual Ion Composition Experiment
+  TEXT: &txt >
+    The Compact Dual Ion Composition Experiment (CoDICE) will measure the distributions and composition of interstellar
+    pickup ions (PUIs), particles that make it through the heliosheath into the heliosphere. CoDICE also collects and
+    characterizes solar wind ions including the mass and composition of highly energized particles (called suprathermal)
+    from the Sun. CoDICE combines an electrostatic analyzer (ESA) with a Time-Of-Flight versus Energy (TOF / E)
+    subsystem to simultaneously measure the velocity, arrival direction, ionic charge state, and mass of specific
+    species of ions in the LISM. CoDICE also has a path for higher energy particles to skip the ESA but still get
+    measured by the common TOF / E system. These measurements are critical in determining the Local Interstellar Medium
+    (LISM) composition and flow properties, the origin of the enigmatic suprathermal tails on the solar wind
+    distributions and advance understanding of the acceleration of particles in the heliosphere.
+  Instrument_type: Particles (space)
+
+# L1a
+imap_codice_l1a_hskp:
+    <<: *instrument_base
+    Data_level: 1A
+    Data_type: L1A_hskp->Level-1A Housekeeping Data
+    Logical_source: imap_codice_l1a_hskp
+    Logical_source_description: IMAP Mission CoDICE Instrument Level-1A Housekeeping Data.
+
+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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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:
+    <<: *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.
+
+# L1b
+imap_codice_l1b_hskp:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_hskp->Level-1B Housekeeping Data
+    Logical_source: imap_codice_l1b_hskp
+    Logical_source_description: IMAP Mission CoDICE Instrument Level-1B Housekeeping Data.
+
+imap_codice_l1b_hi_counters_aggregated:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_hi-counters-aggregated->Level-1B Hi Aggregated Instrument Rates Data
+    Logical_source: imap_codice_l1b_hi-counters-aggregated
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1B Aggregated Instrument Rates Data.
+
+imap_codice_l1b_hi_counters_singles:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_hi-counters-singles->Level-1B Hi Single Instrument Rates Data
+    Logical_source: imap_codice_l1b_hi-counters-singles
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1B Single Instrument Rates Data.
+
+imap_codice_l1b_hi_omni:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_hi-omni->Level-1B Hi Omnidirectional Data
+    Logical_source: imap_codice_l1b_hi-omni
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1B Omnidirectional Data.
+
+imap_codice_l1b_hi_sectored:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_hi-sectored->Level-1B Hi Sectored Data
+    Logical_source: imap_codice_l1b_hi-sectored
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1B Sectored Data.
+
+imap_codice_l1b_lo_counters_aggregated:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-counters-aggregated->Level-1B Lo Aggregated Instrument Rates Data
+    Logical_source: imap_codice_l1b_lo-counters-aggregated
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Aggregated Instrument Rates Data.
+
+imap_codice_l1b_lo_counters_singles:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-counters-aggregated->Level-1B Lo Single Instrument Rates Data
+    Logical_source: imap_codice_l1b_lo-counters-singles
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Single Instrument Rates Data.
+
+imap_codice_l1b_lo_sw_angular:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-sw-angular->Level-1B Lo Sunward Angular Rates Data
+    Logical_source: imap_codice_l1b_lo-sw-angular
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Sunward Angular Rates Data.
+
+imap_codice_l1b_lo_nsw_angular:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-nsw-angular->Level-1B Lo Non-Sunward Angular Rates Data
+    Logical_source: imap_codice_l1b_lo-nsw-angular
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Non-Sunward Angular Rates Data.
+
+imap_codice_l1b_lo_sw_priority:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-sw-priority->Level-1B Lo Sunward Priority Rates Data
+    Logical_source: imap_codice_l1b_lo-sw-priority
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Sunward Priority Rates Data.
+
+imap_codice_l1b_lo_nsw_priority:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-nsw-priority->Level-1B Lo Non-Sunward Priority Rates Data
+    Logical_source: imap_codice_l1b_lo-nsw-priority
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Non-Sunward Priority Rates Data.
+
+imap_codice_l1b_lo_sw_species:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-sw-species->Level-1B Lo Sunward Species Rates Data
+    Logical_source: imap_codice_l1b_lo-sw-species
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Sunward Species Rates Data.
+
+imap_codice_l1b_lo_nsw_species:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_lo-nsw-species->Level-1B Lo Non-Sunward Species Rates Data
+    Logical_source: imap_codice_l1b_lo-nsw-species
+    Logical_source_description: IMAP Mission CoDICE Lo Level-1B Non-Sunward Species Rates Data.