imap-processing 0.6.0__py3-none-any.whl

imap_processing/tests/mag/test_mag_l1b.py

@@ -0,0 +1,77 @@
+from pathlib import Path
+
+import numpy as np
+import pytest
+import xarray as xr
+
+from imap_processing.cdf.utils import load_cdf, write_cdf
+from imap_processing.mag.l1b.mag_l1b import mag_l1b, mag_l1b_processing
+
+
+@pytest.fixture(scope="module")
+def mag_l1a_dataset():
+    epoch = xr.DataArray(np.arange(20), name="epoch", dims=["epoch"])
+    direction = xr.DataArray(np.arange(4), name="direction", dims=["direction"])
+    vectors = xr.DataArray(
+        np.zeros((20, 4)),
+        dims=["epoch", "direction"],
+        coords={"epoch": epoch, "direction": direction},
+    )
+
+    vectors[0, :] = np.array([1, 1, 1, 0])
+
+    output_dataset = xr.Dataset(
+        coords={"epoch": epoch, "direction": direction},
+    )
+    output_dataset["vectors"] = vectors
+
+    return output_dataset
+
+
+def test_mag_processing(mag_l1a_dataset):
+    mag_l1a_dataset.attrs["Logical_source"] = ["imap_mag_l1a_norm-mago"]
+
+    mag_l1b = mag_l1b_processing(mag_l1a_dataset)
+
+    np.testing.assert_allclose(
+        mag_l1b["vectors"][0].values, [2.29819857, 2.22914442, 2.24950008, 0]
+    )
+    np.testing.assert_allclose(mag_l1b["vectors"][1].values, [0, 0, 0, 0])
+
+    assert mag_l1b["vectors"].values.shape == mag_l1a_dataset["vectors"].values.shape
+
+    mag_l1a_dataset.attrs["Logical_source"] = ["imap_mag_l1a_norm-magi"]
+
+    mag_l1b = mag_l1b_processing(mag_l1a_dataset)
+
+    np.testing.assert_allclose(
+        mag_l1b["vectors"][0].values, [2.27615106, 2.22638234, 2.24382211, 0]
+    )
+    np.testing.assert_allclose(mag_l1b["vectors"][1].values, [0, 0, 0, 0])
+
+    assert mag_l1b["vectors"].values.shape == mag_l1a_dataset["vectors"].values.shape
+
+
+def test_mag_attributes(mag_l1a_dataset):
+    mag_l1a_dataset.attrs["Logical_source"] = ["imap_mag_l1a_norm-mago"]
+
+    output = mag_l1b(mag_l1a_dataset, "v001")
+    assert output.attrs["Logical_source"] == "imap_mag_l1b_norm-mago"
+
+    mag_l1a_dataset.attrs["Logical_source"] = ["imap_mag_l1a_burst-magi"]
+
+    output = mag_l1b(mag_l1a_dataset, "v001")
+    assert output.attrs["Logical_source"] == "imap_mag_l1b_burst-magi"
+
+    assert output.attrs["Data_level"] == "L1B"
+
+
+def test_cdf_output():
+    l1a_cdf = load_cdf(
+        Path(__file__).parent / "imap_mag_l1a_burst-magi_20231025_v001.cdf"
+    )
+    l1b_dataset = mag_l1b(l1a_cdf, "v001")
+
+    output_path = write_cdf(l1b_dataset)
+
+    assert Path.exists(output_path)

imap_processing/tests/mag/test_mag_l1c.py

@@ -0,0 +1,40 @@
+import numpy as np
+import pytest
+import xarray as xr
+
+from imap_processing.mag.l1c.mag_l1c import mag_l1c
+
+
+@pytest.fixture(scope="module")
+def mag_l1b_dataset():
+    epoch = xr.DataArray(np.arange(20), name="epoch", dims=["epoch"])
+    direction = xr.DataArray(np.arange(4), name="direction", dims=["direction"])
+    vectors = xr.DataArray(
+        np.zeros((20, 4)),
+        dims=["epoch", "direction"],
+        coords={"epoch": epoch, "direction": direction},
+    )
+
+    vectors[0, :] = np.array([1, 1, 1, 0])
+
+    output_dataset = xr.Dataset(
+        coords={"epoch": epoch, "direction": direction},
+    )
+    output_dataset["vectors"] = vectors
+
+    return output_dataset
+
+
+def test_mag_attributes(mag_l1b_dataset):
+    # Fixture from test_mag_l1b.py, since L1A and L1B are very similar
+    mag_l1b_dataset.attrs["Logical_source"] = ["imap_mag_l1b_norm-mago"]
+
+    output = mag_l1c(mag_l1b_dataset, mag_l1b_dataset, "v001")
+    assert output.attrs["Logical_source"] == "imap_mag_l1c_norm-mago"
+
+    mag_l1b_dataset.attrs["Logical_source"] = ["imap_mag_l1b_norm-magi"]
+
+    output = mag_l1c(mag_l1b_dataset, mag_l1b_dataset, "v001")
+    assert output.attrs["Logical_source"] == "imap_mag_l1c_norm-magi"
+
+    assert output.attrs["Data_level"] == "L1C"

imap_processing/tests/spice/test_data/imap_ena_sim_metakernel.template

@@ -0,0 +1,4 @@
+{SPICE_TEST_DATA_PATH}/imap_sclk_0000.tsc
+{SPICE_TEST_DATA_PATH}/naif0012.tls
+{SPICE_TEST_DATA_PATH}/imap_spk_demo.bsp
+{SPICE_TEST_DATA_PATH}/de440s.bsp

imap_processing/tests/spice/test_data/imap_science_0001.tf

@@ -0,0 +1,171 @@
+KPL/FK
+
+Interstellar Mapping and Acceleration Probe Dynamic Frames Kernel
+========================================================================
+
+   This kernel contains SPICE frame definitions to support the IMAP mission.
+
+   To be consistent with conventions prior to the mission name change
+   from Solar Probe Plus (SPP) to Parker Solar Probe (PSP) in 2017, frame
+   names and other text IDs are prefixed with the legacy acronym, SPP.
+
+Version and Date
+---------------------------------------------------------------
+
+   The TEXT_KERNEL_ID stores version information of loaded project text
+   kernels.  Each entry associated with the keyword is a string that
+   consists of four parts: the kernel name, version, entry date, and type.
+
+   SPP Dynamic Frame Kernel Version:
+
+      \begindata
+
+         TEXT_KERNEL_ID = 'IMAP_DYNAMIC_FRAMES V1.0.0 2024-XXXX-NN FK'
+
+      \begintext
+
+
+   Version 1.0.0 -- April 10, 2024 -- Nick Dutton (JHU/APL)
+
+
+References
+---------------------------------------------------------------
+
+      1.   NAIF SPICE `Kernel Pool Required Reading'
+
+      2.   NAIF SPICE `Frames Required Reading'
+
+      3.   Email from Scott Turner, received May 2, 2018, containing
+           attachment InstrumentFrames.pptx, by Martha Kusterer dated
+           Sept. 19, 2017
+
+      4.   msgr_dyn_v600.tf, in Planetary Data System (PDS)
+           data set MESS-E/V/H-SPICE-6-V1.0
+
+      5.   stereo_rtn.tf, at
+           ftp://sohoftp.nascom.nasa.gov/solarsoft/stereo/gen/data/spice
+
+      6.   heliospheric.tf, at
+           ftp://sohoftp.nascom.nasa.gov/solarsoft/stereo/gen/data/spice/gen
+
+      7.   Email from Scott Turner received May 11, 2018 containing notes
+           taken from the science team meeting on the same date.
+
+      8.   Snodgrass, H.B., Ulrich, R.K., 1990, Rotation of Doppler features
+           in the solar photosphere. Astrophys. J. 351, 309. doi:10.1086/168467
+
+
+Contact Information
+---------------------------------------------------------------
+
+   Direct questions, comments, or concerns about the contents of this
+   kernel to:
+
+      Scott Turner, JHUAPL, (443)778-1693, Scott.Turner@jhuapl.edu
+
+   or
+
+      Lillian Nguyen, JHUAPL (443)778-5477, Lillian.Nguyen@jhuapl.edu
+
+   or
+
+      Douglas Rodgers, JHUAPL (443)778-4228, Douglas.Rodgers@jhuapl.edu
+
+
+Implementation Notes
+---------------------------------------------------------------
+
+   This file is used by the SPICE system as follows: programs that make use
+   of this frame kernel must `load' the kernel normally during program
+   initialization.  Loading the kernel associates the data items with
+   their names in a data structure called the `kernel pool'.  The SPICELIB
+   routine FURNSH loads a kernel into the pool as shown below:
+
+      FORTRAN: (SPICELIB)
+
+         CALL FURNSH ( frame_kernel_name )
+
+      C: (CSPICE)
+
+         furnsh_c ( frame_kernel_name );
+
+      IDL: (ICY)
+
+         cspice_furnsh, frame_kernel_name
+
+      MATLAB: (MICE)
+
+         cspice_furnsh ( frame_kernel_name )
+
+   This file was created and may be updated with a text editor or word
+   processor.
+
+
+IMAP Dynamic Frames
+---------------------------------------------------------------
+
+   This frame kernel defines a series of dynamic frames listed in [3]
+   that support Parker Solar Probe data reduction and analysis.  All
+   of the frame names defined by this kernel are prefixed with 'SPP_'
+   (the legacy mission name acronym as described in the leading paragraph
+   of this file) to avoid conflict with alternative definitions not
+   specific to the project. Further, the project-specific ID codes
+   -96900 to -96999 have been set aside to support these dynamic frames.
+
+   The following dynamic frames are defined in this kernel file:
+
+      Frame Name               Relative To              Type     NAIF ID
+      ======================   ===================      =======  =======
+
+      Earth Based Frames:
+      ------------------
+      EARTH_FIXED              IAU_EARTH                FIXED
+      IMAP_RTN                 J2000                    DYNAMIC  -96900
+      SPP_GSE                  J2000                    DYNAMIC  -96901
+
+      Mercury Based Frames:
+      ------------------
+      SPP_MSO                  J2000                    DYNAMIC  -96903
+
+      Venus Based Frames:
+      ------------------
+      SPP_VSO                  J2000                    DYNAMIC  -96904
+
+      Sun Based Frames:
+      ------------------
+      SPP_HG                   J2000                    DYNAMIC  -96910
+      SPP_HCI                  J2000                    DYNAMIC  -96911
+      SPP_HEE                  J2000                    DYNAMIC  -96912
+      SPP_HEEQ                 J2000                    DYNAMIC  -96913
+      SPP_RTN                  J2000                    DYNAMIC  -96914
+      SPP_HERTN                J2000                    DYNAMIC  -96915
+      SPP_HGI                  J2000                    DYNAMIC  -96916
+      SPP_HGDOPP               J2000                    DYNAMIC  -96917
+      SPP_HGMAG                J2000                    DYNAMIC  -96918
+      SPP_HGSPEC               J2000                    DYNAMIC  -96919
+
+
+
+   \begindata
+
+      NAIF_BODY_NAME   += ( 'IMAP_DPS' )
+      NAIF_BODY_CODE   += ( -43901     )
+
+
+
+   \begintext
+
+DPS Frame
+
+\begindata
+
+        FRAME_IMAP_DPS              = -43901
+        FRAME_-43901_NAME           = 'IMAP_DPS'
+        FRAME_-43901_CLASS          = 3
+        FRAME_-43901_CLASS_ID       = -43901
+        FRAME_-43901_CENTER         = -43
+        CK_-43901_SCLK              = -43
+
+   \begintext
+
+END OF FILE

imap_processing/tests/spice/test_data/imap_sclk_0000.tsc

@@ -0,0 +1,156 @@
+\begintext
+
+FILENAME = "imap_0000.tsc"
+CREATION_DATE = "5-January-2021"
+
+
+IMAP Spacecraft Clock Kernel (SCLK)
+===========================================================================
+
+     This file is a SPICE spacecraft clock (SCLK) kernel containing
+     information required for time conversions involving the on-board
+     IMAP spacecraft clock.
+
+Version
+--------------------------------------------------------
+
+     IMAP SCLK Kernel Version:
+
+     IMAP version 0.3 - April 22, 2022 -- Mike Ruffolo
+        Updated to use NAIF SC ID 43
+
+     IMAP Version 0.2 - June 2, 2021 -- Caroline Cocca
+         Updated to use temporary spacecraft id of 225
+
+     IMAP Version 0.1 - March 6, 2015 -- Eric Melin
+         Updated text to replace references to RBSP with SPP
+
+     IMAP Version 0.0 - August 7, 2014 -- Eric Melin
+        The initial SPP spice kernel.
+        This file was created by using RBSPA initial kernel and
+        modifying the spacecraft ID.
+
+
+Usage
+--------------------------------------------------------
+
+     This file is used by the SPICE system as follows: programs that
+     make use of this SCLK kernel must 'load' the kernel, normally
+     during program initialization.  Loading the kernel associates
+     the data items with their names in a data structure called the
+     'kernel pool'.  The SPICELIB routine FURNSH loads text kernel
+     files, such as this one, into the pool as shown below:
+
+        FORTRAN:
+
+                  CALL FURNSH ( SCLK_kernel_name )
+
+        C:
+
+                  furnsh_c ( SCLK_kernel_name );
+
+     Once loaded, the SCLK time conversion routines will be able to
+     access the necessary data located in this kernel for their
+     designed purposes.
+
+References
+--------------------------------------------------------
+
+         1.   "SCLK Required Reading"
+
+Inquiries
+--------------------------------------------------------
+
+     If you have any questions regarding this file or its usage,
+     contact:
+
+           Scott Turner
+           (443)778-1693
+           Scott.Turner@jhuapl.edu
+
+Kernel Data
+--------------------------------------------------------
+
+     The first block of keyword equals value assignments define the
+     type, parallel time system, and format of the spacecraft clock.
+     These fields are invariant from SCLK kernel update to SCLK
+     kernel update.
+
+     The IMAP spacecraft clock is represented by the SPICE
+     type 1 SCLK kernel.  It uses TDT, Terrestrial Dynamical Time,
+     as its parallel time system.
+
+\begindata
+
+SCLK_KERNEL_ID             = ( @2009-07-09T12:20:32 )
+SCLK_DATA_TYPE_43          = (        1 )
+SCLK01_TIME_SYSTEM_43      = (        2 )
+
+
+\begintext
+
+     In a particular partition of the IMAP spacecraft clock,
+     the clock read-out consists of two separate stages:
+
+                           1/18424652:24251
+
+     The first stage, a 32 bit field, represents the spacecraft
+     clock seconds count.  The second, a 16 bit field, represents
+     counts of 20 microsecond increments of the spacecraft clock.
+
+     The following keywords and their values establish this structure:
+
+\begindata
+
+SCLK01_N_FIELDS_43         = (            2 )
+SCLK01_MODULI_43           = (   4294967296       50000 )
+SCLK01_OFFSETS_43          = (            0           0 )
+SCLK01_OUTPUT_DELIM_43     = (            2 )
+
+
+\begintext
+
+     This concludes the invariant portion of the SCLK kernel data.  The
+     remaining sections of the kernel may require updates as the clock
+     correlation coefficients evolve in time.  The first section below
+     establishes the clock partitions.  The data in this section consists
+     of two parallel arrays, which denote the start and end values in
+     ticks of each partition of the spacecraft clock.
+
+     SPICE utilizes these two arrays to map from spacecraft clock ticks,
+     determined with the usual modulo arithmetic, to encoded SCLK--the
+     internal, monotonically increasing sequence used to tag various
+     data sources with spacecraft clock.
+
+\begindata
+
+SCLK_PARTITION_START_43    = ( 0.00000000000000e+00 )
+
+SCLK_PARTITION_END_43      = ( 2.14748364799999e+14 )
+
+\begintext
+
+     The remaining section of the SCLK kernel defines the clock correlation
+     coefficients.  Each line contains a 'coefficient triple':
+
+         Encoded SCLK at which Rate is introduced.
+         Corresponding TDT Epoch at which Rate is introduced.
+         Rate in TDT (seconds) / most significant clock count (~seconds).
+
+     SPICE uses linear extrapolation to convert between the parallel time
+     system and encoded SCLK.  The triples are stored in the array defined
+     below.
+
+     The first time triplet below was entered manually and represents the
+     approximate time (in TDT) at which SCLK = zero.  The current plan for
+     IMAP is that the given epoch will be used for both Observatory I&T
+     and launch.  Note that the conversion from UTC to TDT used 34 leap
+     seconds.
+
+\begindata
+
+SCLK01_COEFFICIENTS_43     = (
+
+                   0     @01-JAN-2010-00:01:06.184000     1.00000000000
+
+)

imap_processing/tests/spice/test_data/imap_simple_metakernel.template

@@ -0,0 +1,3 @@
+{SPICE_TEST_DATA_PATH}/imap_sclk_0000.tsc
+{SPICE_TEST_DATA_PATH}/naif0012.tls
+{SPICE_TEST_DATA_PATH}/imap_spk_demo.bsp