imap-processing 0.11.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

imap_processing/cdf/config/imap_hit_l1b_variable_attrs.yaml

@@ -1,5 +1,4 @@
 # TODO: add attributes for science packets
-# TODO: update label_axis and min/max with values provided by instrument team.
 
 # <=== Defaults ===>
 # Assumed values for all variable attrs unless overwritten
@@ -14,11 +13,23 @@ default_attrs: &default
   UNITS: ' '
   SCALETYP: linear
 
-hk_support_attrs: &support_default
+hk_support_attrs: &hk_support_default
   <<: *default
   DISPLAY_TYPE: no_plot
   VAR_TYPE: ignore_data
 
+hk_metadata_attrs: &metadata_default
+  FORMAT: A2
+  VAR_TYPE: metadata
+
+default_uint32_attrs: &default_uint32
+  <<: *default
+  FILLVAL: 4294967295
+  FORMAT: I10
+  VALIDMIN: 0
+  VALIDMAX: 4294967295
+  dtype: uint32
+
 # <=== Coordinates ===>
 adc_channels:   # adc_channels is a dependency for leak_i data variable
   DISPLAY_TYPE: no_plot
@@ -44,26 +55,31 @@ adc_channels_label:
 
 
 # <=== Data Variable Attributes ===>
-#TODO is DEPEND_0 needed for no_plot variables in housekeeping?
+
+sc_tick:
+  <<: *default_uint32
+  CATDESC: CCSDS secondary header - Spacecraft Tick
+  FIELDNAM: Spacecraft Tick
+  VAR_TYPE: support_data
 
 fsw_version_a:
-  <<: *support_default
-  VALIDMAX: 3
+  <<: *hk_support_default
+  VALIDMAX: 63
   CATDESC: Flight Software Version Number (A.B.C bits)
   FIELDNAM: Flight Software Version Number A
   LABLAXIS: FSW A
-  FORMAT: I1
+  FORMAT: I2
 
 fsw_version_b:
-  <<: *support_default
-  VALIDMAX: 15
+  <<: *hk_support_default
+  VALIDMAX: 63
   CATDESC: Flight Software Version Number (A.B.C bits)
   FIELDNAM: Flight Software Version Number B
   LABLAXIS: FSW B
   FORMAT: I2
 
 fsw_version_c:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 63
   CATDESC: Flight Software Version Number (A.B.C bits)
   FIELDNAM: Flight Software Version Number C
@@ -71,7 +87,7 @@ fsw_version_c:
   FORMAT: I2
 
 num_good_cmds:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Number of Good Commands
   FIELDNAM: Number of Good Commands
@@ -79,7 +95,7 @@ num_good_cmds:
   FORMAT: I3
 
 last_good_cmd:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Last Good Command
   FIELDNAM: Last Good Command
@@ -87,7 +103,7 @@ last_good_cmd:
   FORMAT: I3
 
 last_good_seq_num:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Last Good Sequence Number
   FIELDNAM: Last Good Sequence Number
@@ -95,7 +111,7 @@ last_good_seq_num:
   FORMAT: I3
 
 num_bad_cmds:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Number of Bad Commands
   FIELDNAM: Number of Bad Commands
@@ -103,7 +119,7 @@ num_bad_cmds:
   FORMAT: I3
 
 last_bad_cmd:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Last Bad Command
   FIELDNAM: Last Bad Command
@@ -111,7 +127,7 @@ last_bad_cmd:
   FORMAT: I3
 
 last_bad_seq_num:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Last Bad Sequence Number
   FIELDNAM: Last Bad Sequence Number
@@ -119,71 +135,63 @@ last_bad_seq_num:
   FORMAT: I3
 
 fee_running:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - FEE Running (1) or Reset (0)
   FIELDNAM: FEE Running (1) or Reset (0)
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A7
 
 mram_disabled:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - MRAM Disabled (1) or Enabled (0)
   FIELDNAM: MRAM Disabled (1) or Enabled (0)
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A8
 
 enable_50khz:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - 50kHz Enabled (1) or Disabled (0)
   FIELDNAM: 50kHz Enabled (1) or Disabled (0)
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A8
 
 enable_hvps:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - HVPS Enabled (1) or Disabled (0)
   FIELDNAM: HVPS Enabled (1) or Disabled (0)
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A8
 
 table_status:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - Table Status OK (1) or Error (0)
   FIELDNAM: Table Status OK (1) or Error (0)
   LABLAXIS: Status
-  FORMAT: I1
+  FORMAT: A5
 
 heater_control:
-  <<: *support_default
-  VALIDMAX: 2
+  <<: *metadata_default
   CATDESC: State - Heater Control (0=None, 1=Pri, 2=Sec)
   FIELDNAM: Heater Control (0=None, 1=Pri, 2=Sec)
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A4
 
 adc_mode:
-  <<: *support_default
-  VALIDMAX: 3
+  <<: *metadata_default
   CATDESC: State - ADC Mode (0=quiet, 1=normal, 2=adcstim, 3=adcThreshold
   FIELDNAM: ADC Mode (0=quiet, 1=normal, 2=adcstim, 3=adcThreshold)
   LABLAXIS: ADC mode
-  FORMAT: I1
+  FORMAT: A12
 
 mode:
-  <<: *support_default
-  VALIDMAX: 3
+  <<: *metadata_default
   CATDESC: State - Mode (0=Boot, 1=Maintenance, 2=Standby, 3=Science)
   FIELDNAM: Mode (0=Boot, 1=Maintenance, 2=Standby, 3=Science)
   LABLAXIS: Mode
-  FORMAT: I1
+  FORMAT: A11
 
 dyn_thresh_lvl:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 3
   CATDESC: Dynamic Threshold Level (0-3)
   FIELDNAM: Dynamic Threshold Level (0-3)
@@ -191,15 +199,15 @@ dyn_thresh_lvl:
   FORMAT: I1
 
 num_evnt_last_hk:
-  <<: *support_default
-  VALIDMAX: 262143
+  <<: *hk_support_default
+  VALIDMAX: 4294967295
   CATDESC: Number of Events Since Last HK Update
   FIELDNAM: Number of Events Since Last HK Update
   LABLAXIS: Num events
-  FORMAT: I6
+  FORMAT: I10
 
 num_errors:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 255
   CATDESC: Number of Errors
   FIELDNAM: Number of Errors
@@ -207,15 +215,14 @@ num_errors:
   FORMAT: I3
 
 last_error_num:
-  <<: *support_default
-  VALIDMAX: 255
+  <<: *metadata_default
   CATDESC: State - Last Error Number
   FIELDNAM: Last Error Number
   LABLAXIS: Error num
-  FORMAT: I3
+  FORMAT: A18
 
 code_checksum:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 65535
   CATDESC: Code Checksum
   FIELDNAM: Code Checksum
@@ -223,7 +230,7 @@ code_checksum:
   FORMAT: I5
 
 spin_period_short:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 65535
   CATDESC: Spin Period Short at T=0
   FIELDNAM: Spin Period Short at T=0
@@ -231,7 +238,7 @@ spin_period_short:
   FORMAT: I5
 
 spin_period_long:
-  <<: *support_default
+  <<: *hk_support_default
   VALIDMAX: 65535
   CATDESC: Spin Period Long at T=0
   FIELDNAM: Spin Period Long at T=0
@@ -239,7 +246,7 @@ spin_period_long:
   FORMAT: I5
 
 leak_i:
-  <<: *support_default
+  <<: *hk_support_default
   DEPEND_1: adc_channels
   CATDESC: Leakage Current [I]
   FIELDNAM: Leakage Current [I]
@@ -248,326 +255,294 @@ leak_i:
   FORMAT: I19
 
 phasic_stat:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - Phasic Status
   FIELDNAM: Phasic Status
   LABLAXIS: Status
-  FORMAT: I1
+  FORMAT: A7
 
 active_heater:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - Active Heater
   FIELDNAM: Active Heater
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A9
 
 heater_on:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - Heater On/Off
   FIELDNAM: Heater On/Off
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A3
 
 test_pulser_on:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - Test Pulser On/Off
   FIELDNAM: Test Pulser On/Off
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A3
 
 dac0_enable:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - DAC 0 Enable
   FIELDNAM: DAC 0 Enable
   LABLAXIS: State
-  FORMAT: I1
+  FORMAT: A7
 
 dac1_enable:
-  <<: *support_default
-  VALIDMAX: 1
+  <<: *metadata_default
   CATDESC: State - DAC 1 Enable
   FIELDNAM: DAC 1 Enable
   LABLAXIS: State
-  FORMAT: I1
-
-
-# TODO Update data formats. Should be float values. Need more info from instrument team
+  FORMAT: A7
 
 preamp_l234a:
   <<: *default
-  VALIDMAX: 4095  # Need more info from instr. team
+  VALIDMAX: 10000000000
   CATDESC: Preamp L234A Voltage
   FIELDNAM: Preamp L234A Voltage
   LABLAXIS: Voltage
-  FORMAT: I4
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 preamp_l1a:
   <<: *default
-  VALIDMAX: 4095  # Need more info from instr. team
+  VALIDMAX: 10000000000
   CATDESC: Preamp L1A Voltage
   FIELDNAM: Preamp L1A Voltage
   LABLAXIS: Voltage
-  FORMAT: I4
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 preamp_l1b:
   <<: *default
-  VALIDMAX: 4095  # Need more info from instr. team
+  VALIDMAX: 10000000000
   CATDESC: Preamp L1B Voltage
   FIELDNAM: Preamp L1B Voltage
   LABLAXIS: Voltage
-  FORMAT: I4
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 preamp_l234b:
   <<: *default
-  VALIDMAX: 4095 # Need more info from instr. team
+  VALIDMAX: 10000000000
   CATDESC: Preamp L234B Voltage
   FIELDNAM: Preamp L234B Voltage
   LABLAXIS: Voltage
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 temp0:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 57
+  VALIDMAX: 10000000000
   CATDESC: FEE LDO Regulator Mounted on the Board Next to the Low-dropout Regulator
   FIELDNAM: FEE LDO Regulator
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 temp1:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 50
+  VALIDMAX: 10000000000
   CATDESC: Primary Heater Mounted on the Board Next to the Primary Heater Circuit
   FIELDNAM: Primary Heater
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 temp2:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 50
+  VALIDMAX: 10000000000
   CATDESC: FEE FPGA Mounted on the Board Next to the FPGA
   FIELDNAM: FEE FPGA
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 temp3:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 50
+  VALIDMAX: 10000000000
   CATDESC: Secondary Heater
   FIELDNAM: Secondary Heater
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 analog_temp:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 50
+  VALIDMAX: 10000000000
   CATDESC: Chassis Temp Mounted on the Analog Board Close to Thermostats, Heaters, and Chassis
   FIELDNAM: Analog Temp
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 hvps_temp:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 50
+  VALIDMAX: 10000000000
   CATDESC: Board Temp Mounted Inside Faraday Cage in Middle of Board Near Connector Side
   FIELDNAM: Board Temp
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 idpu_temp:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 65
+  VALIDMAX: 10000000000
   CATDESC: LDO Temp Mounted on Top of the Low-dropout Regulator
   FIELDNAM: LDO Temp
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 lvps_temp:
   <<: *default
   VALIDMIN: -25
-  VALIDMAX: 80
+  VALIDMAX: 10000000000
   CATDESC: Board Temp Mounted in the Middle of Board on Opposite Side of Hottest Component
   FIELDNAM: Board Temp
   LABLAXIS: Temperature
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: C
   FILLVAL: -1.0000000E+31
 
 ebox_3d4vd:
   <<: *default
-  # doc says min 3.1
-  # doc says max 3.6
-  VALIDMIN: 3
-  VALIDMAX: 4
+  VALIDMAX: 10000000000
   CATDESC: 3.4VD Ebox (Digital)
   FIELDNAM: 3.4VD Ebox (Digital)
   LABLAXIS: Voltage
-  FORMAT: F2.1
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ebox_5d1vd:
   <<: *default
-  # doc says min 4.85
-  # doc says max 5.45
-  VALIDMIN: 4
-  VALIDMAX: 6
+  VALIDMAX: 10000000000
   CATDESC: 5.1VD Ebox (Digital)
   FIELDNAM: 5.1VD Ebox (Digital)
   LABLAXIS: Voltage
-  FORMAT: F3.2
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ebox_p12va:
   <<: *default
-  # doc says min 11.2
-  # doc says max 13.1
-  VALIDMIN: 11
-  VALIDMAX: 14
+  VALIDMAX: 10000000000
   CATDESC: +12VA Ebox (Analog)
   FIELDNAM: +12VA Ebox (Analog)
   LABLAXIS: Voltage
-  FORMAT: F3.1
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ebox_m12va:
   <<: *default
-  # doc says min -13.1
-  # doc says max -11.2
-  VALIDMIN: -14
-  VALIDMAX: -12
+  VALIDMIN: -12.2
+  VALIDMAX: 10000000000
   CATDESC: -12VA Ebox (Analog)
   FIELDNAM: -12VA Ebox (Analog)
   LABLAXIS: Voltage
-  FORMAT: F3.1
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ebox_p5d7va:
   <<: *default
-  # doc says min 5.3
-  # doc says max 6.3
-  VALIDMIN: 5
-  VALIDMAX: 7
+  VALIDMAX: 10000000000
   CATDESC: +5.7VA Ebox (Analog)
   FIELDNAM: +5.7VA Ebox (Analog)
   LABLAXIS: Voltage
-  FORMAT: F2.1
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ebox_m5d7va:
   <<: *default
-  # doc says min -6.4125
-  # doc says max -5.25
-  VALIDMIN: -7
-  VALIDMAX: -5
+  VALIDMIN: -6
+  VALIDMAX: 10000000000
   CATDESC: -5.7VA Ebox (Analog)
   FIELDNAM: -5.7VA Ebox (Analog)
   LABLAXIS: Voltage
-  FORMAT: F5.4
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ref_p5v:
-  #Need more info from instrument team on min and max values
   <<: *default
+  VALIDMAX: 10000000000
   CATDESC: +5V ref
   FIELDNAM: +5V ref
   LABLAXIS: Voltage
-  FORMAT: I4
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 l1ab_bias:
   <<: *default
-  VALIDMIN: 0
-  VALIDMAX: 15
+  VALIDMAX: 10000000000
   CATDESC: L1A/B Bias
   FIELDNAM: L1A/B Bias
   LABLAXIS: Voltage
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 l2ab_bias:
   <<: *default
-  VALIDMIN: 0
-  VALIDMAX: 25
+  VALIDMAX: 10000000000
   CATDESC: L2A/B Bias
   FIELDNAM: L2A/B Bias
   LABLAXIS: Voltage
-  FORMAT: I2
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 l34a_bias:
   <<: *default
-  VALIDMIN: 0
-  VALIDMAX: 255
+  VALIDMAX: 10000000000
   CATDESC: L3/4A Bias
   FIELDNAM: L3/4A Bias
   LABLAXIS: Voltage
-  FORMAT: I3
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 l34b_bias:
   <<: *default
-  VALIDMIN: 0
-  VALIDMAX: 225
+  VALIDMAX: 10000000000
   CATDESC: L3/4B Bias
   FIELDNAM: L3/4B Bias
   LABLAXIS: Voltage
-  FORMAT: I3
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 
 ebox_p2d0vd:
   <<: *default
-  # doc says min 1.79
-  # doc says max 2.5
-  VALIDMIN: 1
-  VALIDMAX: 3
+  VALIDMAX: 10000000000
   CATDESC: +2.0VD Ebox (Digital)
   FIELDNAM: +2.0VD Ebox (Digital)
   LABLAXIS: Voltage
-  FORMAT: F3.2
+  FORMAT: F9.3
   UNITS: V
   FILLVAL: -1.0000000E+31
 

imap_processing/cdf/config/imap_hit_l2_variable_attrs.yaml

@@ -0,0 +1,14 @@
+# TODO: add attributes for L2 variables
+
+# <=== Defaults ===>
+# Assumed values for all variable attrs unless overwritten
+default_attrs: &default
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  FORMAT: I12
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: data
+  UNITS: ' '
+  SCALETYP: linear