imap-processing 0.6.0__py3-none-any.whl

imap_processing/cdf/config/imap_ultra_l1b_variable_attrs.yaml

@@ -0,0 +1,297 @@
+default_attrs: &default
+  # Assumed values for all variable attrs unless overwritten
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  FORMAT: I19
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: data
+
+x_front:
+  <<: *default
+  CATDESC: x front position
+  FIELDNAM: Event x-position on front foil
+  LABLAXIS: x front position
+  # TODO: come back to format
+  UNITS: mm
+
+y_front:
+  <<: *default
+  CATDESC: y front position
+  FIELDNAM: Event y-position on front foil
+  LABLAXIS: y front position
+  # TODO: come back to format
+  UNITS: mm
+
+x_back:
+  <<: *default
+  CATDESC: x back position
+  FIELDNAM: x_back
+  LABLAXIS: x back position
+  # TODO: come back to format
+  UNITS: mm
+
+y_back:
+  <<: *default
+  CATDESC: y back position
+  FIELDNAM: y_back
+  LABLAXIS: y back position
+  # TODO: come back to format
+  UNITS: mm
+
+x_coin:
+  <<: *default
+  CATDESC: x coincidence position
+  FIELDNAM: x_coin
+  LABLAXIS: x coincidence position
+  # TODO: come back to format
+  UNITS: mm
+
+tof_start_stop:
+  <<: *default
+  CATDESC: Particle time of flight from start to stop
+  FIELDNAM: tof_start_stop
+  LABLAXIS: tof start stop
+  # TODO: come back to format
+  UNITS: ns
+
+tof_stop_coin:
+  <<: *default
+  CATDESC: Particle time of flight from stop to coincidence
+  FIELDNAM: tof_stop_coin
+  LABLAXIS: tof stop coin
+  # TODO: come back to format
+  UNITS: ns
+
+tof_corrected:
+  <<: *default
+  CATDESC: Corrected time of flight
+  FIELDNAM: tof_corrected
+  LABLAXIS: tof corrected
+  # TODO: come back to format
+  UNITS: ns
+
+eventtype:
+  <<: *default
+  CATDESC: Eventtype (1-2 top and bottom stop types; 8-15 ssd stop types)
+  FIELDNAM: eventtype
+  LABLAXIS: eventtype
+  # TODO: come back to format
+  UNITS: " "
+
+vx_ultra:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in x direction in the instrument frame.
+  FIELDNAM: vx_ultra
+  LABLAXIS: vx ultra
+  # TODO: come back to format
+  UNITS: " "
+
+vy_ultra:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in y direction in the instrument frame.
+  FIELDNAM: vy_ultra
+  LABLAXIS: vy ultra
+  # TODO: come back to format
+  UNITS: " "
+
+vz_ultra:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in z direction in the instrument frame.
+  FIELDNAM: vz_ultra
+  LABLAXIS: vz ultra
+  # TODO: come back to format
+  UNITS: " "
+
+energy:
+  <<: *default
+  CATDESC: Energy measured using the pulse height from the stop anode (DN) or Energy measured using the SSD (keV) depending on eventtype.
+  FIELDNAM: energy
+  LABLAXIS: energy
+  # TODO: come back to format
+  UNITS: keV
+
+species:
+  <<: *default
+  CATDESC: Species bin.
+  FIELDNAM: species
+  LABLAXIS: species
+  # TODO: come back to format
+  UNITS: " "
+
+event_efficiency:
+  <<: *default
+  CATDESC: Estimated event efficiency for this path through the instrument.
+  FIELDNAM: event_efficiency
+  LABLAXIS: event efficiency
+  # TODO: come back to format
+  UNITS: " "
+
+vx_sc:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in x direction in the spacecraft frame.
+  FIELDNAM: vx_sc
+  LABLAXIS: vx sc
+  # TODO: come back to format
+  UNITS: " "
+
+vy_sc:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in y direction in the spacecraft frame.
+  FIELDNAM: vy_sc
+  LABLAXIS: vy sc
+  # TODO: come back to format
+  UNITS: " "
+
+vz_sc:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in z direction in the spacecraft frame.
+  FIELDNAM: vz_sc
+  LABLAXIS: vz sc
+  # TODO: come back to format
+  UNITS: " "
+
+vx_dps_sc:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in x direction in the DPS frame at rest WRT spacecraft (velocity w/ spacecraft frame subtracted)
+  FIELDNAM: vx_dps_sc
+  LABLAXIS: vx dps sc
+  # TODO: come back to format
+  UNITS: " "
+
+vy_dps_sc:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in y direction in the DPS frame at rest WRT spacecraft (velocity w/ spacecraft frame subtracted)
+  FIELDNAM: vy_dps_sc
+  LABLAXIS: vy dps sc
+  # TODO: come back to format
+  UNITS: " "
+
+vz_dps_sc:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in z direction in the DPS frame at rest WRT spacecraft (velocity w/ spacecraft frame subtracted)
+  FIELDNAM: vz_dps_sc
+  LABLAXIS: vz dps sc
+  # TODO: come back to format
+  UNITS: " "
+
+vx_dps_helio:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in x direction in the DPS frame at rest WRT heliosphere.
+  FIELDNAM: vx_dps_helio
+  LABLAXIS: vx dps helio
+  # TODO: come back to format
+  UNITS: " "
+
+vy_dps_helio:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in y direction in the DPS frame at rest WRT heliosphere.
+  FIELDNAM: vy_dps_helio
+  LABLAXIS: vy dps helio
+  # TODO: come back to format
+  UNITS: " "
+
+vz_dps_helio:
+  <<: *default
+  CATDESC: Normalized component of the velocity vector in z direction in the DPS frame at rest WRT heliosphere.
+  FIELDNAM: vz_dps_helio
+  LABLAXIS: vz dps helio
+  # TODO: come back to format
+  UNITS: " "
+
+eventtimes:
+  <<: *default
+  CATDESC: Event times calculated from event and universal spin table.
+  FIELDNAM: eventtimes
+  LABLAXIS: event times
+  # TODO: come back to format
+  UNITS: " "
+
+spin_number:
+  <<: *default
+  CATDESC: Spin number from Universal Spin Table.
+  FIELDNAM: spin_number
+  LABLAXIS: spin_number
+  # TODO: come back to format
+  UNITS: " "
+
+spin_start_time:
+  <<: *default
+  CATDESC: Spin start time from Universal Spin Table.
+  FIELDNAM: spin_start_time
+  LABLAXIS: spin start time
+  # TODO: come back to format
+  UNITS: s
+
+avg_spin_period:
+  <<: *default
+  CATDESC: Average spin period from Universal Spin Table.
+  FIELDNAM: avg_spin_period
+  LABLAXIS: avg_spin_period
+  # TODO: come back to format
+  UNITS: s
+
+rate_start_pulses:
+  <<: *default
+  CATDESC: Rate of start pulses (/s).
+  FIELDNAM: rate_start_pulses
+  LABLAXIS: rate start pulses
+  # TODO: come back to format
+  UNITS: 1/s
+
+rate_stop_pulses:
+  <<: *default
+  CATDESC: Rate of stop pulses (/s).
+  FIELDNAM: rate_stop_pulses
+  LABLAXIS: rate stop pulses
+  # TODO: come back to format
+  UNITS: 1/s
+
+rate_coin_pulses:
+  <<: *default
+  CATDESC: Rate of coincidence pulses (/s).
+  FIELDNAM: rate_coin_pulses
+  LABLAXIS: rate coincidence pulses
+  # TODO: come back to format
+  UNITS: 1/s
+
+rate_processed_events:
+  <<: *default
+  CATDESC: Rate of processed events (/s).
+  FIELDNAM: rate_processed_events
+  LABLAXIS: rate processed events
+  # TODO: come back to format
+  UNITS: 1/s
+
+rate_rejected_events:
+  <<: *default
+  CATDESC: Rate of rejected events (/s).
+  FIELDNAM: rate_rejected_events
+  LABLAXIS: rate rejected events
+  # TODO: come back to format
+  UNITS: 1/s
+
+quality_hk:
+  <<: *default
+  CATDESC: Spin filter derived from Ultra housekeeping. Bitwise flagging used to filter the spin.
+  FIELDNAM: quality_hk
+  LABLAXIS: quality hk
+  # TODO: come back to format
+  UNITS: " "
+
+quality_attitude:
+  <<: *default
+  CATDESC: Spin filter derived from IMAP attitude. Bitwise flagging used to filter the spin.
+  FIELDNAM: quality_attitude
+  LABLAXIS: quality attitude
+  # TODO: come back to format
+  UNITS: " "
+
+quality_instruments:
+  <<: *default
+  CATDESC: Spin filter derived from instruments other than Ultra. Bitwise flagging used to filter the spin.
+  FIELDNAM: quality_instruments
+  LABLAXIS: quality instruments
+  # TODO: come back to format
+  UNITS: " "

imap_processing/cdf/config/imap_ultra_l1c_variable_attrs.yaml

@@ -0,0 +1,121 @@
+default_attrs: &default
+  # Assumed values for all variable attrs unless overwritten
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  FORMAT: I12
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: data
+
+spin_angle:
+  <<: *default
+  CATDESC: Angular bin defined by central location of the bin
+  FIELDNAM: spin_angle
+  LABLAXIS: spin angle
+  # TODO: come back to format
+  UNITS: degrees
+
+esa_step:
+  <<: *default
+  CATDESC: ESA step (0-10), nominally 9, but possibly 8 or 10, 0 is likely a background test. Energy bin.
+  FIELDNAM: esa_step
+  LABLAXIS: esa step
+  # TODO: come back to format
+  UNITS: " "
+
+time_bin:
+  <<: *default
+  CATDESC: Time bin defined by central location of the bin.
+  FIELDNAM: time_bin
+  LABLAXIS: time bin
+  # TODO: come back to format
+  UNITS: seconds
+
+species_bin:
+  <<: *default
+  CATDESC: Species bin defined by central location.
+  FIELDNAM: species_bin
+  LABLAXIS: species bin
+  # TODO: come back to format
+  UNITS: " "
+
+exposure_times:
+  <<: *default
+  CATDESC: Exposure time for a spin.
+  FIELDNAM: exposure_times
+  LABLAXIS: exposure times
+  # TODO: come back to format
+  UNITS: seconds
+
+sensitivity:
+  <<: *default
+  CATDESC: Calibration/sensitivity factor.
+  FIELDNAM: sensitivity
+  LABLAXIS: sensitivity
+  # TODO: come back to format
+  UNITS: counts/second
+
+counts:
+  <<: *default
+  CATDESC: Counts for a spin.
+  FIELDNAM: counts
+  LABLAXIS: counts
+  # TODO: come back to format
+  UNITS: counts
+
+background_rates:
+  <<: *default
+  CATDESC: Background rates. Background dominated by accidentals caused by a combination of UV light and misregistered low energy ENA events.
+  FIELDNAM: background_rates
+  LABLAXIS: background rates
+  # TODO: come back to format
+  UNITS: counts/second
+
+sid:
+  <<: *default
+  CATDESC: Science ID (always totals 8).
+  FIELDNAM: sid
+  LABLAXIS: sid
+  # TODO: come back to format
+  UNITS: " "
+
+row:
+  <<: *default
+  CATDESC: Row number.
+  FIELDNAM: row
+  LABLAXIS: row
+  # TODO: come back to format
+  UNITS: " "
+
+column:
+  <<: *default
+  CATDESC: Column number.
+  FIELDNAM: column
+  LABLAXIS: column
+  # TODO: come back to format
+  UNITS: " "
+
+spin:
+  <<: *default
+  CATDESC: Spin number at integration start.
+  FIELDNAM: spin
+  LABLAXIS: spin
+  # TODO: come back to format
+  UNITS: " "
+
+shcoarse:
+  <<: *default
+  CATDESC: CCSDS packet timestamp.
+  FIELDNAM: shcoarse
+  LABLAXIS: shcoarse
+  # TODO: come back to format
+  UNITS: seconds
+
+packetdata:
+  <<: *default
+  CATDESC: A 2D numpy array representing pixel values. Each pixel is stored as an unsigned 16-bit integer.
+  FIELDNAM: packetdata
+  LABLAXIS: packet data
+  # TODO: come back to format
+  UNITS: " "

imap_processing/cdf/config/shared/default_global_cdf_attrs_schema.yaml

@@ -0,0 +1,246 @@
+DOI:
+  description: >
+    DOI is a persistent Unique Digital Identifier with the form
+    https://doi.org/<PREFIX>/<SUFFIX> with the <PREFIX> identifying the DOI
+    registration authority and the <SUFFIX> identifying the dataset. The DOI should point to
+    a landing page for additional information about the dataset. DOIs are typically created by
+    the SPASE naming authority or archive.
+  default: null
+  required: false # NOT Required in ISTP Guide (Recommended)
+  validate: true # include in validation
+  overwrite: false
+Data_level:
+  description: >
+    This attribute is used in file name creation and records the level of processsing done
+    on the dataset. For HERMES the following are valid values:
+    - l0>Level 0
+    - l1>Level 1
+    - l2>Level 2
+    - l3>Level 3
+    - l4>Level 4
+    - ql>Quicklook
+  default: null
+  required: true # NOT Required in ISTP Guide (Derived)
+  validate: false
+  overwrite: true
+Data_product_descriptor:
+  description: >
+    This is an optional field that may not be needed for all products. Where it is used, identifier
+    should be short (e.q. 3-8 characters) descriptors that are helpful to end- users. If a
+    descriptor contains multiple components, underscores are used to separate those components.
+  default: null
+  required: false # NOT Required in ISTP Guide (Derived)
+  validate: false
+  overwrite: true
+Data_type:
+  description: >
+    This attribute is used by CDF file writing software to create a filename. It is a
+    combination of the following filename components: mode, data level, and optional data
+    product descriptor.
+  default: null
+  required: false # NOT Required in ISTP Guide (Derived)
+  validate: false
+  overwrite: true
+Data_version:
+  description: >
+    This attribute identifies the version of a particular CDF data file.
+  default: null
+  required: true
+  validate: true
+  overwrite: false
+Descriptor:
+  description: >
+    This attribute identifies the name of the instrument or sensor that collected the data. Both
+    a long name and a short name are given. For any data file, only a single value is allowed.
+    For HERMES, the following are valid values:
+    - EEA>Electron Electrostatic Analyzer
+    - MERIT>Miniaturized Electron pRoton Telescope
+    - NEMISIS> Noise Eliminating Magnetometer In a Small Integrated System
+    - SPAN-I>Solar Probe Analyzer for Ions
+  default: null
+  required: true
+  validate: true
+  overwrite: false
+Discipline:
+  description: >
+    This attribute describes both the science discipline and sub discipline. For HERMES,
+    this value should always be "Space Physics>Magnetospheric Science."
+  default: Space Physics>Magnetospheric Science
+  required: true
+  validate: true
+  overwrite: false
+File_naming_convention:
+  description: >
+    If File_naming_convention was not set, it uses default setting:
+      source_datatype_descriptor_yyyyMMdd
+  default: source_datatype_descriptor_yyyyMMdd
+  required: false
+  validate: false
+  overwrite: true
+Generation_date:
+  description: >
+    Date stamps the creation of the file using the syntax yyyymmdd, e.g., "
+  default: null
+  required: false # NOT Required in ISTP Guide (Recommended)
+  validate: true
+  overwrite: true
+HTTP_LINK:
+  description: >
+    The 'HTTP_LINK', 'LINK_TEXT', and 'LINK_TITLE' attributes store the URL with a
+    description of this dataset at the HERMES SDC. The use of HTTP_LINK attribute requires
+    the existence and equal number of corresponding LINK_TEXT and LINK_TITLE attributes.
+    If text is not needed for these attributes, use an empty string "".
+  default: null
+  required: false # NOT Required in ISTP Guide (Recommended)
+  validate: true
+  overwrite: false
+Instrument_mode:
+  description: >
+    TBS
+  default: null
+  required: false # NOT Required in ISTP Guide (Derived)
+  validate: false
+  overwrite: false
+Instrument_type:
+  description: >
+    This attribute is used to facilitate making choices of instrument type. More than one entry
+    is allowed. Acceptable values for HERMES include:
+    - Magnetic Fields (space)
+    - Particles (space)
+    - Plasma and Solar Wind
+    - Ephemeris -> Ephemeris/Attitude/Ancillary
+  default: null
+  required: true
+  validate: true
+  overwrite: false
+LINK_TEXT:
+  description: >
+    The 'HTTP_LINK', 'LINK_TEXT', and 'LINK_TITLE' attributes store the URL with a
+    description of this dataset at the HERMES SDC. The use of HTTP_LINK attribute requires
+    the existence and equal number of corresponding LINK_TEXT and LINK_TITLE attributes.
+    If text is not needed for these attributes, use an empty string "".
+  default: null
+  required: false # NOT Required in ISTP Guide (Recommended)
+  validate: true
+  overwrite: false
+LINK_TITLE:
+  description: >
+    The 'HTTP_LINK', 'LINK_TEXT', and 'LINK_TITLE' attributes store the URL with a
+    description of this dataset at the HERMES SDC. The use of HTTP_LINK attribute requires
+    the existence and equal number of corresponding LINK_TEXT and LINK_TITLE attributes.
+    If text is not needed for these attributes, use an empty string "".
+  default: null
+  required: false # NOT Required in ISTP Guide (Recommended)
+  validate: true
+  overwrite: false
+Logical_file_id:
+  description: >
+    This attribute stores the name of the CDF file but without the
+    file extension (e.g. ".cdf"). This attribute is required to avoid loss of the original source
+    in the case of accidental (or intentional) renaming.
+  default: null
+  required: true
+  validate: true
+  overwrite: true
+Logical_source:
+  description: >
+    This attribute determines the file naming convention in the SKT Editor and is used by
+    CDA Web. It is composed of the following values:
+    - source_name - (e.g. spacecraft identifier)
+    - descriptor - (e.g. instrument identifier - see Section Error! Reference source not
+    found.)
+    - data_type - (e.g. mode, data level, and optional data product descriptor - value
+    come from 'Data_type' attribute)
+  default: null
+  required: true
+  validate: true
+  overwrite: true
+Logical_source_description:
+  description: >
+    This attribute writes out the full words associated with the encrypted Logical_source
+    above, e.g., "Level 1 Dual Electron Spectrometer Survey Data". Users on CDAWeb see
+    this value on their website.
+  default: null
+  required: true
+  validate: true
+  overwrite: true
+MODS:
+  description: >
+    This attribute is an SPDF standard global attribute, which is used to denote the history of
+    modifications made to the CDF data set. The MODS attribute should contain a
+    description of all significant changes to the data set, essentially capturing a log of high-
+    level release notes. This attribute can have as many entries as necessary and should be
+    updated if the Interface Number ("X") of the version number changes.
+  default: null
+  required: false # NOT Required in ISTP Guide (Recommended)
+  validate: true
+  overwrite: false
+Mission_group:
+  description: >
+    This attribute has a single value and is used to facilitate making choices of source through
+    CDAWeb. This value should be "HERMES."
+  default: HERMES
+  required: true
+  validate: true
+  overwrite: false
+PI_affiliation:
+  description: >
+    This attribute value should include the HERMES mission PI affiliation followed by a
+    comma-separated list of any Co-I affiliations that are responsible for this particular
+    dataset. The following are valid HERMES values, of which the abbreviations should be
+    used exclusively within this attribute value, and the full text of the affiliation included in
+    the general 'text' attribute as it is used solely in plot labels.
+    - GSFC - Goddard Space Flight Center
+    - UCB - University of California, Berkeley
+    - SSL - Space Sciences Laboratory, UCB
+    - UM - University of Michigan
+  default: null
+  required: true
+  validate: true
+  overwrite: false
+PI_name:
+  description: >
+    This attribute value should include first initial and last name of the HERMES mission PI
+    followed by a comma-separated list of any Co-Is that are responsible for this particular
+    dataset.
+  default: null
+  required: true
+  validate: true
+  overwrite: false
+Project:
+  description: >
+    This attribute identifies the name of the project and indicates ownership. For HERMES,
+    this value should be "STP>Solar-Terrestrial Physics".
+  default: STP>Solar-Terrestrial Physics
+  required: true
+  validate: true
+  overwrite: false
+Source_name:
+  description: >
+    This attribute identifies the observatory where the data originated. The following are
+    valid values for HERMES:
+    - HERMES>Heliophysics Environmental and Radiation Measurement Experiment Suite
+  default: HERMES>Heliophysics Environmental and Radiation Measurement Experiment Suite
+  required: true
+  validate: true
+  overwrite: false
+Start_time:
+  description: >
+    The start time of the contained data given in YYYYMMDD_hhmmss
+  default: null
+  required: false # NOT Required in ISTP Guide (Derived)
+  validate: false
+  overwrite: true
+TEXT:
+  description: >
+    This attribute is an SPDF standard global attribute, which is a text description of the
+    experiment whose data is included in the CDF. A reference to a journal article(s) or to a
+    World Wide Web page describing the experiment is essential and constitutes the
+    minimum requirement. A written description of the data set is also desirable. This
+    attribute can have as many entries as necessary to contain the desired information.
+    Typically, this attribute is about a paragraph in length and is not shown on CDAWeb.
+    CDAWeb is the web portal for access to SPDF data, available at https://cdaweb.gsfc.nasa.gov.
+  default: null
+  required: true
+  validate: true
+  overwrite: false