Merge branch 'main' into 2382

Author: Menlo Innovations - CAVA Project

.pre-commit-config.yaml

@@ -0,0 +1,4 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks: [ ]

data_product_spec_csvs/imap_hit_l3_direct_event.csv

@@ -0,0 +1,28 @@
+NAME,DATA_TYPE,Data shape,CATDESC,VAR_TYPE,DEPEND_0,DEPEND_1,DEPEND_2,DEPEND_3,DISPLAY_TYPE,FIELDNAM,FORMAT,LABLAXIS,UNITS,VALIDMIN,VALIDMAX,FILLVAL,LABL_PTRS,UNIT_PTR,SCALETYP,SCAL_PTR,VAR_NOTES,TIME_BASE,TIME_SCALE,LEAP_SECONDS_INCLUDED,ABSOLUTE_ERROR,AVG_TYPE,BIN_LOCATION,DELTA_PLUS_VAR,DELTA_MINUS_VAR,DERIVN,DICT_KEY,MONOTON,SCALEMIN,SCALEMAX,REFERENCE_POSITION,RELATIVE_ERROR,RESOLUTION,SI_CONVERSION
+epoch,int64,epoch,"Time, number of nanoseconds since J2000 with leap seconds included",support_data,,,,,no_plot,epoch,,epoch,ns,1990-01-01T00:00:00.000000000,2099-12-31T00:00:00.000000000,9999-12-31T23:59:59.999999999,,,linear,,,J2000,Terrestrial Time,,,,,epoch_delta,epoch_delta,,,INCREASE,,,Rotating Earth Geoid,,,
+epoch_delta,int64,epoch_delta,epoch_delta,support_data,,,,,no_plot,epoch_delta,,epoch_delta,ns,1990-01-01T00:00:00.000000000,2099-12-31T00:00:00.000000000,9999-12-31T23:59:59.999999999,,,linear,,,J2000,Terrestrial Time,,,,,,,,,INCREASE,,,Rotating Earth Geoid,,,
+charge,float64,"(epoch, charge)",charge,data,epoch,,,,time_series,charge,,Charge,MeV,0,200,-1.00E+31,,,linear,,,,,,,,,,,,,,,,,,,
+energy,float64,"(epoch, energy)",energy,data,epoch,,,,time_series,energy,,Energy,MeV,1,10000,-1.00E+31,,,log,,,,,,,,,,,,,,,,,,,
+energy_at_detector,float64,"(epoch, detector_id, energy_at_detector)",energy_at_detector,data,epoch,detector_id,,,no_plot,energy_at_detector,,,,1,10000,-1.00E+31,,,log,,,,,,,,,,,,,,,,,,,
+range,int8,"(epoch, range)",range,data,epoch,,,,no_plot,range,,,,0,4,255,,,,,,,,,,,,,,,,,,,,,,
+delta_e,float64,"(epoch, delta_e)",delta_e,data,epoch,,,,time_series,delta_e,,Delta E,MeV,1,10000,-1.00E+31,,,log,,,,,,,,,,,,,,,,,,,
+e_prime,float64,"(epoch, e_prime)",e_prime,data,epoch,,,,time_series,e_prime,,E Prime,MeV,1,10000,-1.00E+31,,,log,,,,,,,,,,,,,,,,,,,
+particle_id,uint8,"(epoch, particle_id)",particle_id,data,epoch,,,,no_plot,particle_id,,,,0,255,65535,,,,,,,,,,,,,,,,,,,,,,
+priority_buffer_number,int8,"(epoch, priority_buffer_number)",priority_buffer_number,data,epoch,,,,no_plot,priority_buffer_number,,,,0,254,255,,,,,,,,,,,,,,,,,,,,,,
+latency,int8,"(epoch, latency)",latency,data,epoch,,,,no_plot,latency,,,,0,16,255,,,,,,,,,,,,,,,,,,,,,,
+stim_tag,int8,"(epoch, stim_tag)",stim_tag,data,epoch,,,,no_plot,stim_tag,,,,0,1,-1.28E+02,,,,,,,,,,,,,,,,,,,,,,
+long_event_flag,int8,"(epoch, long_event_flag)",long_event_flag,data,epoch,,,,no_plot,long_event_flag,,,,0,1,-1.28E+02,,,,,,,,,,,,,,,,,,,,,,
+haz_tag,int8,"(epoch, haz_tag)",haz_tag,data,epoch,,,,no_plot,haz_tag,,,,0,1,-1.28E+02,,,,,,,,,,,,,,,,,,,,,,
+side,int8,"(epoch, a_b_side)",a_b_side,data,epoch,,,,no_plot,a_b_side,,,,0,1,-1.28E+02,,,,,,,,,,,,,,,,,,,,,,
+has_unread_flag,int8,"(epoch, has_unread_flag)",has_unread_flag,data,epoch,,,,no_plot,has_unread_flag,,,,0,1,-1.28E+02,,,,,,,,,,,,,,,,,,,,,,
+culling_flag,int8,"(epoch, culling_flag)",culling_flag,data,epoch,,,,no_plot,culling_flag,,,,0,1,-1.28E+02,,,,,,,,,,,,,,,,,,,,,,
+pha_value,uint16,"(epoch, detector_id, pha_value)",pha_value,data,epoch,detector_id,,,no_plot,pha_value,,,,0,65534,65535,,,,,,,,,,,,,,,,,,,,,,
+is_low_gain,int8,"(epoch, detector_id, is_low_gain)",is_low_gain,data,epoch,detector_id,,,no_plot,is_low_gain,,,,0,1,-128,,,,,,,,,,,,,,,,,,,,,,
+detector_flags,uint16,"(epoch, detector_flags)",detector_flags,data,epoch,,,,no_plot,detector_flags,,,,0,65534,65535,,,,,,,,,,,,,,,,,,,,,,
+deindex,uint16,"(epoch, deindex)",deindex,data,epoch,,,,no_plot,deindex,,,,0,65534,65535,,,,,,,,,,,,,,,,,,,,,,
+epindex,uint16,"(epoch, epindex)",epindex,data,epoch,,,,no_plot,epindex,,,,0,65534,65535,,,,,,,,,,,,,,,,,,,,,,
+stim_gain,int8,"(epoch, stim_gain)",stim_gain,data,epoch,,,,no_plot,stim_gain,,,,0,1,-128,,,,,,,,,,,,,,,,,,,,,,
+a_l_stim,int8,"(epoch, a_l_stim)",a_l_stim,data,epoch,,,,no_plot,a_l_stim,,,,0,1,-128,,,,,,,,,,,,,,,,,,,,,,
+stim_step,int8,"(epoch, stim_step)",stim_step,data,epoch,,,,no_plot,stim_step,,,,0,254,255,,,,,,,,,,,,,,,,,,,,,,
+dac_value,uint16,"(epoch, dac_value)",dac_value,data,epoch,,,,no_plot,dac_value,,,,0,10000,65535,,,,,,,,,,,,,,,,,,,,,,
+detector_id,int8,"(epoch, detector_id)",index used to support up to 64 detector addresses per event,support_data,,,,,no_plot,detector_id,,,,0,64,255,,,,,,,,,,,,,,,,,,,,,,

environment.yaml

@@ -3,7 +3,7 @@ channels:
   - conda-forge
 dependencies:
   - python>=3.12
-  - healpy
+  - pyhdf
   - scipy=1.13.1
   - pip
   - pip:

imap_processing/cdf/config/imap_hit_l3_direct_event.yaml

@@ -0,0 +1,299 @@
+epoch:
+  CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: epoch
+  LABLAXIS: epoch
+  UNITS: ns
+  VALIDMIN: 1990-01-01T00:00:00.000000000
+  VALIDMAX: 2099-12-31T00:00:00.000000000
+  FILLVAL: 9999-12-31T23:59:59.999999999
+  SCALETYP: linear
+  TIME_BASE: J2000
+  TIME_SCALE: Terrestrial Time
+  DELTA_PLUS_VAR: epoch_delta
+  DELTA_MINUS_VAR: epoch_delta
+  MONOTON: INCREASE
+  REFERENCE_POSITION: Rotating Earth Geoid
+
+epoch_delta:
+  CATDESC: epoch_delta
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: epoch_delta
+  LABLAXIS: epoch_delta
+  UNITS: ns
+  VALIDMIN: 1990-01-01T00:00:00.000000000
+  VALIDMAX: 2099-12-31T00:00:00.000000000
+  FILLVAL: 9999-12-31T23:59:59.999999999
+  SCALETYP: linear
+  TIME_BASE: J2000
+  TIME_SCALE: Terrestrial Time
+  MONOTON: INCREASE
+  REFERENCE_POSITION: Rotating Earth Geoid
+
+charge:
+  CATDESC: charge
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: charge
+  LABLAXIS: Charge
+  UNITS: MeV
+  VALIDMIN: 0
+  VALIDMAX: 200
+  FILLVAL: -1.00E+31
+  SCALETYP: linear
+
+energy:
+  CATDESC: energy
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: energy
+  LABLAXIS: Energy
+  UNITS: MeV
+  VALIDMIN: 1
+  VALIDMAX: 10000
+  FILLVAL: -1.00E+31
+  SCALETYP: log
+
+energy_at_detector:
+  CATDESC: energy_at_detector
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DEPEND_1: detector_id
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: energy_at_detector
+  VALIDMIN: 1
+  VALIDMAX: 10000
+  FILLVAL: -1.00E+31
+  SCALETYP: log
+
+range:
+  CATDESC: range
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: range
+  VALIDMIN: 0
+  VALIDMAX: 4
+  FILLVAL: 255
+
+delta_e:
+  CATDESC: delta_e
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: delta_e
+  LABLAXIS: Delta E
+  UNITS: MeV
+  VALIDMIN: 1
+  VALIDMAX: 10000
+  FILLVAL: -1.00E+31
+  SCALETYP: log
+
+e_prime:
+  CATDESC: e_prime
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: e_prime
+  LABLAXIS: E Prime
+  UNITS: MeV
+  VALIDMIN: 1
+  VALIDMAX: 10000
+  FILLVAL: -1.00E+31
+  SCALETYP: log
+
+particle_id:
+  CATDESC: particle_id
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: particle_id
+  VALIDMIN: 0
+  VALIDMAX: 255
+  FILLVAL: 65535
+
+priority_buffer_number:
+  CATDESC: priority_buffer_number
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: priority_buffer_number
+  VALIDMIN: 0
+  VALIDMAX: 254
+  FILLVAL: 255
+
+latency:
+  CATDESC: latency
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: latency
+  VALIDMIN: 0
+  VALIDMAX: 16
+  FILLVAL: 255
+
+stim_tag:
+  CATDESC: stim_tag
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: stim_tag
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -1.28E+02
+
+long_event_flag:
+  CATDESC: long_event_flag
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: long_event_flag
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -1.28E+02
+
+haz_tag:
+  CATDESC: haz_tag
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: haz_tag
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -1.28E+02
+
+side:
+  CATDESC: a_b_side
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: a_b_side
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -1.28E+02
+
+has_unread_flag:
+  CATDESC: has_unread_flag
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: has_unread_flag
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -1.28E+02
+
+culling_flag:
+  CATDESC: culling_flag
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: culling_flag
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -1.28E+02
+
+pha_value:
+  CATDESC: pha_value
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DEPEND_1: detector_id
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: pha_value
+  VALIDMIN: 0
+  VALIDMAX: 65534
+  FILLVAL: 65535
+
+is_low_gain:
+  CATDESC: is_low_gain
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DEPEND_1: detector_id
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: is_low_gain
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -128
+
+detector_flags:
+  CATDESC: detector_flags
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: detector_flags
+  VALIDMIN: 0
+  VALIDMAX: 65534
+  FILLVAL: 65535
+
+deindex:
+  CATDESC: deindex
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: deindex
+  VALIDMIN: 0
+  VALIDMAX: 65534
+  FILLVAL: 65535
+
+epindex:
+  CATDESC: epindex
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: epindex
+  VALIDMIN: 0
+  VALIDMAX: 65534
+  FILLVAL: 65535
+
+stim_gain:
+  CATDESC: stim_gain
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: stim_gain
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -128
+
+a_l_stim:
+  CATDESC: a_l_stim
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: a_l_stim
+  VALIDMIN: 0
+  VALIDMAX: 1
+  FILLVAL: -128
+
+stim_step:
+  CATDESC: stim_step
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: stim_step
+  VALIDMIN: 0
+  VALIDMAX: 254
+  FILLVAL: 255
+
+dac_value:
+  CATDESC: dac_value
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: dac_value
+  VALIDMIN: 0
+  VALIDMAX: 10000
+  FILLVAL: 65535
+
+detector_id:
+  CATDESC: index used to support up to 64 detector addresses per event
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: detector_id
+  VALIDMIN: 0
+  VALIDMAX: 64
+  FILLVAL: 255
+