Skip to content

IDEX l1a event messages#2870

Merged
lacoak21 merged 6 commits intoIMAP-Science-Operations-Center:devfrom
lacoak21:idex_event_message_products
Mar 27, 2026
Merged

IDEX l1a event messages#2870
lacoak21 merged 6 commits intoIMAP-Science-Operations-Center:devfrom
lacoak21:idex_event_message_products

Conversation

@lacoak21
Copy link
Copy Markdown
Contributor

Change Summary

Overview

Parse and write all IDEX event messages out to the msg l1a CDF

File changes

imap_processing/cdf/config/imap_idex_global_cdf_attrs.yaml
- update descriptor

  • imap_processing/cdf/config/imap_idex_l1a_variable_attrs.yaml
    • add attributes for messages
  • imap_processing/idex/evt_msg_decode_utils.py
    • Add a regex repacer function to fill in event message placeholders with the given parameters
  • imap_processing/idex/idex_evt_msg_parsing_dictionaries.json
    • Lookup tables provided by the IDEX team
  • imap_processing/idex/idex_l1a.py
    • Parse the l1a packet into messages

Testing

Update l1a event message test

@lacoak21 lacoak21 added this to the March 2026 milestone Mar 25, 2026
@lacoak21 lacoak21 requested a review from Copilot March 25, 2026 22:44
@lacoak21 lacoak21 self-assigned this Mar 25, 2026
@lacoak21 lacoak21 added this to IMAP Mar 25, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds support for decoding IDEX event-message packets into rendered, human-readable message strings and writing them to a dedicated L1A “msg” CDF product, along with the needed CDF metadata and updated tests.

Changes:

  • Introduces template-based rendering for IDEX event messages using IDEX-provided lookup dictionaries.
  • Updates IDEX L1A processing to generate an imap_idex_l1a_msg dataset with a messages variable.
  • Extends CDF global/variable attribute configs and updates the L1A event-message test expectations.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
imap_processing/tests/idex/test_idex_l1a.py Updates EVT test to expect “msg” product naming and validates rendered messages against example data.
imap_processing/idex/idex_l1a.py Adds message-product processing (process_idex_msg_data) and renders event messages into a new dataset variable.
imap_processing/idex/idex_evt_msg_parsing_dictionaries.json Adds IDEX-provided dictionaries/templates used for decoding event messages.
imap_processing/idex/evt_msg_decode_utils.py Adds placeholder/template rendering utility for event message strings.
imap_processing/cdf/config/imap_idex_l1a_variable_attrs.yaml Adds CDF variable attributes for the new messages variable.
imap_processing/cdf/config/imap_idex_global_cdf_attrs.yaml Renames/updates global attributes for msg products and their metadata fields.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@lacoak21
Copy link
Copy Markdown
Contributor Author

This has been tested successfully locally and in dev.

@tech3371
Copy link
Copy Markdown
Contributor

This has been tested successfully locally and in dev.

That is helpful to know!

Copy link
Copy Markdown
Contributor

@tech3371 tech3371 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code changes looks good. I had minor requests for variable names updates for easier readability in the future when we don't have much context of the background. Can you make those changes? Otherwise, the code is solid and makes lot of sense!

Copy link
Copy Markdown
Contributor

@tech3371 tech3371 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thank you for making those changes!

@lacoak21 lacoak21 merged commit 88244c9 into IMAP-Science-Operations-Center:dev Mar 27, 2026
14 checks passed
@lacoak21 lacoak21 deleted the idex_event_message_products branch March 27, 2026 15:36
@github-project-automation github-project-automation bot moved this to Done in IMAP Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants