From 73f134d4fe5e7f1f84b45024720d767815f64126 Mon Sep 17 00:00:00 2001 From: Greg Lucas Date: Tue, 21 Nov 2023 12:05:41 -0700 Subject: [PATCH 1/3] CI: Update codecov to target 90% for the project --- codecov.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/codecov.yml b/codecov.yml index 10dccff1a..5886e40b6 100644 --- a/codecov.yml +++ b/codecov.yml @@ -3,3 +3,10 @@ coverage: patch: default: target: 90% + paths: + - imap_processing/**/*.py + project: + default: + target: 90% + paths: + - imap_processing/**/*.py From 1d045d5829f97b27132845681a2c90a3f6908a5f Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Tue, 21 Nov 2023 15:12:06 -0700 Subject: [PATCH 2/3] Added CoDICE API reference docs --- docs/source/reference/codice.rst | 28 ++++++++++++++++++++++++++++ docs/source/reference/index.rst | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/source/reference/codice.rst diff --git a/docs/source/reference/codice.rst b/docs/source/reference/codice.rst new file mode 100644 index 000000000..47d1f7b6c --- /dev/null +++ b/docs/source/reference/codice.rst @@ -0,0 +1,28 @@ +.. _codice: + +CoDICE (Compact Dual Ion Composition Experiment) +================================================ + +.. currentmodule:: imap_processing.codice + +This is the CoDICE Instrument module, which contains the code for processing +data from the CoDICE instrument. + +The L0 code to decommutate the CCSDS packet data can be found below: + +.. autosummary:: + :toctree: generated/ + :template: autosummary.rst + :recursive: + + l0.decom_codice + +The code below is used to decompress an 8 bit science value to a 24- or 32-bit +uncompressed value: + +.. autosummary:: + :toctree: generated/ + :template: autosummary.rst + :recursive: + + l0.decompress_codice diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 7062b0f4d..44d382a26 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -15,6 +15,7 @@ Instruments .. toctree:: :maxdepth: 1 + codice glows hit swe From c0354dd02cd98a0f0dc1537d21ba37919ac77ead Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Wed, 22 Nov 2023 10:17:45 -0700 Subject: [PATCH 3/3] Fixed documentation error for numbered lists --- .../codice/l0/decompress_codice.py | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/imap_processing/codice/l0/decompress_codice.py b/imap_processing/codice/l0/decompress_codice.py index 66dcc5f5e..6536643f2 100644 --- a/imap_processing/codice/l0/decompress_codice.py +++ b/imap_processing/codice/l0/decompress_codice.py @@ -1,18 +1,20 @@ """Decompress CoDICE science data. For CoDICE, there are 3 forms of compression: - 1. Table-based lossy compression A (24- or 32-bit -> 8-bit) - 2. Table-based lossy compression B (24- or 32-bit -> 8 bit) - 3. LZMA lossless compression + + | 1. Table-based lossy compression A (24- or 32-bit -> 8-bit) + | 2. Table-based lossy compression B (24- or 32-bit -> 8 bit) + | 3. LZMA lossless compression Only one lossy option can be selected in cases of lossy + lossless compression. Thus, there are 6 possibly compression algorithms: - 1. No compression - 2. Lossy A only - 3. Lossy B only - 4. Lossless only - 5. Lossy A + lossless - 6. Lossy B + lossless + + | 1. No compression + | 2. Lossy A only + | 3. Lossy B only + | 4. Lossless only + | 5. Lossy A + lossless + | 6. Lossy B + lossless In the case of (5) and (6), the data is first run through lossy compression, and then the result is run through lossless compression. Thus, to decompress, one @@ -96,7 +98,7 @@ def decompress(compressed_value: int, algorithm: IntEnum): ---------- compressed_value : int The 8-bit compressed value to decompress - algorithm : IntEnum + algorithm : int The algorithm to apply. Supported algorithms are provided in the ``codice_utils.CoDICECompression`` class