Process multiple CoDICE APIDs per input file

[bourque]

Change Summary

Overview

Apologies for the large PR here. I found that it was difficult to split this up into smaller chunks since several aspects of this are dependent on each other.

This PR

• Adds support for processing multiple APIDs per input file
• Uses updated simulated CoDICE L0 test data, which resulted in various changes
• Some updates to docstrings, in-line comments, and TODOs

Closes #769 and #992

New Files

• imap_processing/tests/codice/data/imap_codice_l0_raw_20241110_v001.pkts
  • New simulated CoDICE L0 input data, containing multiple APIDs

Deleted Files

• Individual APID test L0 files

Updated Files

• imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml
  • Fixed typo
• imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml
  • Updates to housekeeping attribute names, and some new additions
• imap_processing/codice/codice_l1a.py
  • Updated docstrings and in-line comments
  • Changes to support processing of multiple APIDs per input file
  • Implemented temporary workarounds until continuation packets can be supported (see CoDICE: Add support for continuation packets #1155)
  • Added function to log information about input file contents
• imap_processing/codice/constants.py
  • Small tweak to expected number of positions for hi-counters-singles
• imap_processing/codice/decompress.py
  • Modified code to operated on byte streams instead of strings
• imap_processing/codice/utils.py
  • Added missing APID for hi-priorities data product
• imap_processing/tests/codice/conftest.py
  • Now testing over single L0 file instead of one-file-per-APID
• imap_processing/tests/codice/test_codice_l0.py
  • Now testing using the housekeeping packets in the new L0 test file
• imap_processing/tests/codice/test_codice_l1a.py
  • Now testing using the new L0 test file with multiple APIDs
  • Added test for processing the entirety of the new file
• imap_processing/tests/codice/test_codice_l1b.py
  • Turned off the testing until I can properly implement L1B
• imap_processing/tests/codice/test_decompress.py
  • Updated test to reflect changes in algorithm

[tech3371]

In general, it looks great to me. I had few clarification questions.

[tech3371]

I still have trouble understanding relationship between data's shape and variables names. Will this change in future PR? If so, ignore my comment.

[bourque]

For example, for the lo-sw-priorty data product, the dimensions of all_data in this case is (35, 5, 1, 12, 128). That is for 35 epochs, 5 species (or what I generically call "counters"), 1 position, 12 spin sectors, and 128 energy steps.

The data for each counter needs to be in its own CDF variable, so in order to iterate over each counter, I am iterating over all_data.shape[1].

I can add some comments in the code here to make it more clear, because it is quite confusing 😓

[tech3371]

I understand. CoDICE is complicated but you are doing great job at setting up common processing code.

[tech3371]

This looks like a good setup for upcoming PR. Makes sense to me