Skip to content

Commit

Permalink
packet_file_to_datasets *NOT* in IDEX (#743)
Browse files Browse the repository at this point in the history
* Adding notes in docstring to establish it won't work for IDEX.
  • Loading branch information
anamanica committed Aug 7, 2024
1 parent 8222c1b commit c71368e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions imap_processing/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,12 @@ def packet_file_to_datasets(
-------
datasets : dict
Mapping from apid to xarray dataset, one dataset per apid.
Notes
-----
This function only handles packet definitions with the same variable structure
across all packets with the same ApId. For example, this cannot be used for IDEX
due to the conditional XML structure defined for their science packet.
"""
# Set up containers to store our data
# We are getting a packet file that may contain multiple apids
Expand Down

0 comments on commit c71368e

Please sign in to comment.