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

imap_processing/cdf/config/imap_swe_l1b_variable_attrs.yaml

@@ -1,7 +1,7 @@
 # <=== Coordinates ===>
 esa_step:
   CATDESC: Energy step id in lookup table
-  FIELDNAM: energy step
+  FIELDNAM: Energy Step
   FILLVAL: -9223370000000000000
   FORMAT: I2
   LABLAXIS: Energy Step
@@ -12,33 +12,32 @@ esa_step:
   VAR_TYPE: support_data
 
 spin_sector:
-  CATDESC: Spin angle step. Angle resolution is 12 degree nominally
-  FIELDNAM: spin angle step
+  CATDESC: Spin sector. 30 measurements nominally
+  FIELDNAM: Spin Sector
   FILLVAL: -9223370000000000000
   FORMAT: I2
-  LABLAXIS: Angle
+  LABLAXIS: Spin Sector
   SCALE_TYP: linear
-  UNITS: "Degree"
+  UNITS: " "
   VALIDMAX: 29
   VALIDMIN: 0
   VAR_TYPE: support_data
 
 cem_id:
-  CATDESC: Data rates of each CEM detectors
-  FIELDNAM: rates
+  CATDESC: CEM detector number
+  FIELDNAM: CEM Number
   FILLVAL: -9223370000000000000
-  FORMAT: E14.7
-  LABLAXIS: Rates
+  FORMAT: I2
+  LABLAXIS: CEM Number
   SCALE_TYP: linear
   UNITS: " "
-  VALIDMAX: 0.000015514
-  VALIDMIN: 0.0
-  VAR_NOTES: " "
+  VALIDMAX: 6
+  VALIDMIN: 0
   VAR_TYPE: support_data
 
 cycle:
   CATDESC: Full cycle data takes 4 spins' data
-  FIELDNAM: quarter cycle
+  FIELDNAM: Quarter Cycle
   FILLVAL: -9223370000000000000
   FORMAT: I2
   LABLAXIS: Cycle
@@ -57,27 +56,34 @@ esa_step_label:
   VAR_TYPE: metadata
 
 spin_sector_label:
-  CATDESC: Spin angle step. Angle resolution is 12 degree nominally
-  FIELDNAM: 12 Degree Resolution
+  CATDESC: Spin sector. 30 measurements nominally
+  FIELDNAM: Measurement
   FORMAT: A2
   VAR_TYPE: metadata
 
 cem_id_label:
-  CATDESC: Data rates of each CEM detectors
+  CATDESC: Data rates of each CEM detector
   FIELDNAM: CEM Rates
   FORMAT: A1
   VAR_TYPE: metadata
 
+cycle_label:
+  CATDESC: Quarter cycle number
+  FIELDNAM: Quarter Cycle
+  FORMAT: A1
+  VAR_TYPE: metadata
+
 # <=== Data Variables ===>
 # Default Attrs for all data variables unless overridden
 
 default_attrs: &default
   DEPEND_0: epoch
-  DISPLAY_TYPE: 'no_plot'
-  LABLAXIS: ' '
+  DEPEND_1: cycle
+  LABL_PTR_1: cycle_label
+  DISPLAY_TYPE: time_series
   FILLVAL: -9223372036854775808
-  FORMAT: I19
-  UNITS: ' '
+  FORMAT: I20
+  UNITS: " "
   VALIDMIN: 0
   VALIDMAX: 9223372036854769664
   VAR_TYPE: support_data
@@ -95,7 +101,7 @@ science_data:
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Counts rate by volt step and spin sector and CEM
   FORMAT: E14.7
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -9223372036854775808
   UNITS: counts/sec
   VALIDMAX: 0.000015514
   VALIDMIN: 0
@@ -113,7 +119,7 @@ acquisition_time:
   LABL_PTR_2: spin_sector_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Acquisition time by volt step and spin sector
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -9223372036854775808
   UNITS: sec
   VAR_TYPE: support_data
   VAR_NOTES: >
@@ -122,21 +128,50 @@ acquisition_time:
     acquisition duration and settle duration. It is time of each energy
     step and each science measurement.
 
+acq_duration:
+  CATDESC: Acquisition duration
+  DEPEND_0: epoch
+  DEPEND_1: esa_step
+  DEPEND_2: spin_sector
+  LABL_PTR_1: esa_step_label
+  LABL_PTR_2: spin_sector_label
+  DISPLAY_TYPE: spectrogram
+  FIELDNAM: Acquisition Duration
+  FORMAT: I10
+  VALIDMIN: 0
+  VALIDMAX: 4290000000
+  FILLVAL: -9223372036854775808
+  UNITS: microseconds
+  VAR_TYPE: support_data
+
+esa_energy:
+  CATDESC: ESA electron energy
+  DEPEND_0: epoch
+  DEPEND_1: esa_step
+  DEPEND_2: spin_sector
+  LABL_PTR_1: esa_step_label
+  LABL_PTR_2: spin_sector_label
+  DISPLAY_TYPE: time_series
+  FIELDNAM: ESA Energies
+  FORMAT: E14.7
+  FILLVAL: -9223372036854775808
+  UNITS: eV
+  VALIDMAX: 65535
+  VALIDMIN: 0.000015514
+  VAR_TYPE: support_data
+
 shcoarse:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Mission elapsed time
   FIELDNAM: SHCOARSE
 
 acq_start_coarse:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Acquisition start time coarse in seconds
   FIELDNAM: Acquisition Time Coarse
 
 acq_start_fine:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Acquisition start time fine in microseconds
   FIELDNAM: Acquisition Time Fine
   FORMAT: I10
@@ -144,7 +179,6 @@ acq_start_fine:
 
 cem_nominal_only:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: CEM Nominal status bit. '1' -- nominal, '0' -- not nominal
   FIELDNAM: CEM Nominal Status
   FORMAT: I1
@@ -152,7 +186,6 @@ cem_nominal_only:
 
 spin_period_validity:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Spin period valid bit. '1' -- valid, '0' -- invalid
   FIELDNAM: Spin Period Validity
   FORMAT: I1
@@ -160,7 +193,6 @@ spin_period_validity:
 
 spin_phase_validity:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Spin phase valid bit. '1' -- valid, '0' -- invalid
   FIELDNAM: Spin Phase Validity
   FORMAT: I1
@@ -168,7 +200,6 @@ spin_phase_validity:
 
 spin_period_source:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: >
     Spin period source bit. '1' -- sun sensor (safing), '0' -- star tracker
     (nominal)
@@ -178,41 +209,29 @@ spin_period_source:
 
 settle_duration:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: HVPS settling duration
   FIELDNAM: HVPS Setting Duration
   FORMAT: I5
   VALIDMAX: 65535
 
-acq_duration:
-  <<: *default
-  DEPEND_1: cycle
-  CATDESC: Acquisition duration
-  FIELDNAM: Acquisition Duration
-  FORMAT: I10
-  VALIDMAX: 4290000000
-
 spin_phase:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Spin phase
   FIELDNAM: Spin Phase
   FORMAT: E14.7
   VALIDMAX: 65535
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -9223372036854775808
 
 spin_period:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Spin period
   FIELDNAM: Spin Period
   FORMAT: E14.7
   VALIDMAX: 65535
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -9223372036854775808
 
 repoint_warning:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: >
     Thruster fired during this quarter cycle. '1' -- yes, warning received,
     '0' -- no, warning not received
@@ -222,7 +241,6 @@ repoint_warning:
 
 high_count:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: >
     High CEM count observed for at least one CEM during this quarter cycle.
     '1' -- yes, high count occurred, '0' -- no, no high count occurred
@@ -232,7 +250,6 @@ high_count:
 
 stim_enabled:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Stim state. '1' -- enabled, '0' -- disabled
   FIELDNAM: Stim State
   FORMAT: I1
@@ -240,7 +257,6 @@ stim_enabled:
 
 quarter_cycle:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Quarter cycle number
   FIELDNAM: Quarter Cycle Number
   FORMAT: I3
@@ -248,7 +264,7 @@ quarter_cycle:
 
 esa_table_num:
   <<: *default
-  DEPEND_1: cycle
+
   CATDESC: ESA table identifier
   FIELDNAM: ESA table Identifier
   FORMAT: I3
@@ -256,7 +272,6 @@ esa_table_num:
 
 esa_acq_cfg:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: ESA acquisition configuration
   FIELDNAM: ESA Acquisition Configuration
   FORMAT: I3
@@ -264,16 +279,14 @@ esa_acq_cfg:
 
 threshold_dac:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Threshold DAC value
   FIELDNAM: Threshold DAC Value
   FORMAT: E14.7
   VALIDMAX: 65535
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -9223372036854775808
 
 stim_cfg_reg:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: >
     Stim pulse configuration register. Bits 0-3, period, 4-7, duration, 8-9
     mode
@@ -283,7 +296,6 @@ stim_cfg_reg:
 
 cksum:
   <<: *default
-  DEPEND_1: cycle
   CATDESC: Checksum
   FIELDNAM: Checksum
   FORMAT: I5

imap_processing/cdf/config/imap_swe_l2_variable_attrs.yaml

@@ -1,7 +1,7 @@
 # <=== Coordinates ===>
 esa_step:
   CATDESC: Energy step id in lookup table
-  FIELDNAM: energy step
+  FIELDNAM: Energy Step
   FILLVAL: -9223370000000000000
   FORMAT: I2
   LABLAXIS: Energy Step
@@ -15,11 +15,11 @@ energy:
   CATDESC: Energy of the particle in eV
   FIELDNAM: Energy (eV)
   FILLVAL: -9223370000000000000
-  FORMAT: E5.4
+  FORMAT: E10.4
   LABLAXIS: Energy
   SCALE_TYP: linear
   UNITS: eV
-  VALIDMAX: 2000.0
+  VALIDMAX: 6000.0
   VALIDMIN: 0.0
   VAR_TYPE: support_data
 
@@ -36,13 +36,13 @@ spin_sector:
   VAR_TYPE: support_data
 
 inst_az:
-  CATDESC: Spin angle bins in instrument frame. Angle resolution is 12 degree nominally
-  FIELDNAM: spin angle
+  CATDESC: Spin angle in instrument frame. Angle resolution is 12 degree nominally
+  FIELDNAM: Spin Angle
   FILLVAL: -9223370000000000000
-  FORMAT: E5.4
-  LABLAXIS: Angle
+  FORMAT: E10.4
+  LABLAXIS: Degree
   SCALE_TYP: linear
-  UNITS: "Degree"
+  UNITS: Degree
   VALIDMAX: 359.999
   VALIDMIN: 0.00
   VAR_TYPE: support_data
@@ -52,33 +52,32 @@ inst_az:
     bin.
 
 cem_id:
-  CATDESC: Data of each CEM detector
-  FIELDNAM: CEM data
+  CATDESC: CEM detector number
+  FIELDNAM: CEM Number
   FILLVAL: -9223370000000000000
-  FORMAT: E14.7
-  LABLAXIS: Rates
+  FORMAT: I2
+  LABLAXIS: CEM Number
   SCALE_TYP: linear
   UNITS: " "
-  VALIDMAX: 0.000015514
-  VALIDMIN: 0.0
-  VAR_NOTES: " "
+  VALIDMAX: 6
+  VALIDMIN: 0
   VAR_TYPE: support_data
 
 inst_el:
   CATDESC: Angle of each CEM detector
-  FIELDNAM: CEM Angle
+  FIELDNAM: Polar Angle
   FILLVAL: -9223370000000000000
-  FORMAT: I2
-  LABLAXIS: Angle
+  FORMAT: I4
+  LABLAXIS: Degree
   SCALE_TYP: linear
   UNITS: Degree
-  VALIDMAX: 63
-  VALIDMIN: -63
+  VALIDMAX: 65
+  VALIDMIN: -65
   VAR_TYPE: support_data
 
 cycle:
   CATDESC: Full cycle data takes 4 spins' data
-  FIELDNAM: quarter cycle
+  FIELDNAM: Quarter Cycle
   FILLVAL: -9223370000000000000
   FORMAT: I2
   LABLAXIS: Cycle
@@ -129,7 +128,7 @@ inst_el_label:
 # <=== Data Variables ===>
 
 inst_az_spin_sector:
-  CATDESC: Spin angle organized by voltage step and spin sector
+  CATDESC: Spin angle organized by ESA step and spin sector
   DEPEND_0: epoch
   DEPEND_1: esa_step
   DEPEND_2: spin_sector
@@ -137,15 +136,16 @@ inst_az_spin_sector:
   LABL_PTR_2: spin_sector_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Spin Angle
-  FILLVAL: -1.0000000E+31
-  FORMAT: E4.5
+  FILLVAL: -1.0E+31
+  FORMAT: E10.5
   UNITS: Degree
   VALIDMAX: 359.99
   VALIDMIN: 0.0
   VAR_TYPE: data
+  DICT_KEY: SPASE>Support>SupportQuantity:SpinPhase,Qualifier:Array,CoordinateSystemName:SC,CoordinateRepresentation:Spherical
 
 phase_space_density_spin_sector:
-  CATDESC: Phase space density organized by voltage step and spin sector and CEM
+  CATDESC: Phase space density organized by ESA step and spin sector and CEM
   DEPEND_0: epoch
   DEPEND_1: esa_step
   DEPEND_2: spin_sector
@@ -155,12 +155,14 @@ phase_space_density_spin_sector:
   LABL_PTR_3: cem_id_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Phase Space Density
-  FILLVAL: -1.0000000E+31
-  UNITS: s^3 / (cm^6 * ster)
+  FILLVAL: -1.0E+31
+  UNITS: s^3 / cm^6
   FORMAT: E14.7
-  VALIDMAX: 0.000015514
-  VALIDMIN: 0
+  VALIDMAX: 0.000000000000001
+  VALIDMIN: 0.0
   VAR_TYPE: data
+  DICT_KEY: SPASE>Particle>ParticleType:Electron,ParticleQuantity:PhaseSpaceDensity,Qualifier:Array
+
 
 phase_space_density:
   CATDESC: Phase space density organized by energy (eV), spin angle, CEM angle
@@ -173,15 +175,16 @@ phase_space_density:
   LABL_PTR_3: inst_el_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Phase Space Density
-  FILLVAL: -1.0000000E+31
-  UNITS: s^3 / (cm^6 * ster)
+  FILLVAL: -1.0E+31
+  UNITS: s^3 / cm^6
   FORMAT: E14.7
-  VALIDMAX: 0.000015514
-  VALIDMIN: 0
+  VALIDMAX: 1.0E-15
+  VALIDMIN: 0.0
   VAR_TYPE: data
+  DICT_KEY: SPASE>Particle>ParticleType:Electron,ParticleQuantity:PhaseSpaceDensity,Qualifier:Array
 
 flux_spin_sector:
-  CATDESC: Flux organized by voltage step and spin sector and CEM
+  CATDESC: Number flux organized by ESA step and spin sector and CEM
   DEPEND_0: epoch
   DEPEND_1: esa_step
   DEPEND_2: spin_sector
@@ -191,15 +194,16 @@ flux_spin_sector:
   LABL_PTR_3: cem_id_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Flux
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -1.0E+31
   UNITS: 1 / (2 * eV * cm^2 * s * ster)
   FORMAT: E14.7
-  VALIDMAX: 0.000015514
-  VALIDMIN: 0
+  VALIDMAX: 1.0E+9
+  VALIDMIN: 0.0
   VAR_TYPE: data
+  DICT_KEY: SPASE>Particle>ParticleType:Electron,ParticleQuantity:NumberFlux,Qualifier:Array
 
 flux:
-  CATDESC: Flux organized by energy (eV), spin angle, CEM angle
+  CATDESC: Number flux organized by energy (eV), spin angle, CEM angle
   DEPEND_0: epoch
   DEPEND_1: energy
   DEPEND_2: inst_az
@@ -209,24 +213,26 @@ flux:
   LABL_PTR_3: inst_el_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Flux
-  FILLVAL: -1.0000000E+31
+  FILLVAL: -1.0E+31
   UNITS: 1 / (2 * eV * cm^2 * s * ster)
   FORMAT: E14.7
-  VALIDMAX: 0.000015514
-  VALIDMIN: 0
+  VALIDMAX: 1.0E+9
+  VALIDMIN: 0.0
   VAR_TYPE: data
+  DICT_KEY: SPASE>Particle>ParticleType:Electron,ParticleQuantity:NumberFlux,Qualifier:Array
+
 
 acquisition_time:
-  CATDESC: Acquisition time organized by voltage step and spin sector
+  CATDESC: Acquisition time organized by ESA step and spin sector
   DEPEND_0: epoch
   DEPEND_1: esa_step
   DEPEND_2: spin_sector
   LABL_PTR_1: esa_step_label
   LABL_PTR_2: spin_sector_label
   DISPLAY_TYPE: spectrogram
-  FIELDNAM: Acquisition time by volt step and spin sector
-  FILLVAL: -1.0000000E+31
-  FORMAT: I20
+  FIELDNAM: Acquisition time by ESA step and spin sector
+  FILLVAL: -1.0E+31
+  FORMAT: E20.4
   VALIDMAX: 9223372036854775807
   VALIDMIN: 0
   UNITS: sec
@@ -234,5 +240,23 @@ acquisition_time:
   VAR_NOTES: >
     This stores the acquisition times of each measurement. This time is
     calculated by combining ACQ_START_COARSE, ACQ_START_FINE,
-    acquisition duration and settle duration. It is time of each energy
-    step and each science measurement.
+    acquisition duration and settle duration. It is center time of each
+    science measurement (each energy and angle step).
+  DICT_KEY: SPASE>Support>SupportQuantity:Temporal,Qualifier:Array
+
+acq_duration:
+  CATDESC: Acquisition duration
+  DEPEND_0: epoch
+  DEPEND_1: esa_step
+  DEPEND_2: spin_sector
+  LABL_PTR_1: esa_step_label
+  LABL_PTR_2: spin_sector_label
+  DISPLAY_TYPE: spectrogram
+  FIELDNAM: Acquisition Duration
+  FORMAT: I10
+  VALIDMIN: 0
+  VALIDMAX: 4290000000
+  FILLVAL: -9223372036854775808
+  UNITS: microseconds
+  VAR_TYPE: support_data
+  DICT_KEY: SPASE>Support>SupportQuantity:Temporal,Qualifier:Array