majis-ql-icu 1.0.0

Majis Internal Calibration Unit Quick Look

💡 MAJIS QL - Internal Calibration Unit

Documentation: https://majis_sgs.io.ias.u-psud.fr/quick-look/majis-ql-icu

This package contains a collection of notebooks to analysis Majis Internal Calibration Unit (ICU) observations performed during the different mission payload checkouts (PC) to check the behavior of the instrument and its stability over time.

These analyses consist of 7 different types:

• 🖼️ background checks with the shutter open and the lamp and blackbody OFF
• 👻 darks checks with the shutter close and the lamp and blackbody OFF
• 🔦 lamp observations with the QHT lamp ON
• 💡 blackbody observations with the IR emitter ON
• 🗿 slit profile and edges analysis from the lamp and blackbody observations
• 🌈 straylight profile and spectra analysis with the shutter close and the lamp/blackbody ON.
• 🦠 contamination checks in the 3 µm IR range
• 🪃 read-reset behavior checks on the saturated observations

The full collection of the observations types though the different PC can be found here.

Installation

This package is not (yet) available on PyPI, it have to be pull from IAS nexus registry:

If you use uv you can add it to your pyproject.toml like this:

dependencies = [
    "majis-ql-icu>=1.0.0",
]

[tool.uv.sources]
majis-ql-icu = { index = "ias" }

[[tool.uv.index]]
name = "ias"
url = "https://repositories.forge.ias.u-psud.fr/repository/pipy-ias/simple"
explicit = true

CLI usage

uv run icu --help

ICU command line interface

positional arguments:
  PC*_ICU_*             ICU name(s), eg. `PC1_N_ICU_HOT`. Multiple values can be provided. If no value is provided all the data containing the following pattern `PC*_ICU_*` will be considered.

options:
  -h, --help            show this help message and exit
  -d, --data folder     Majis data root folder. It can be defined globally with `DATA_MAJIS_ICU` env variable. Default without `DATA_MAJIS_ICU` is the current working directory.
  -e, --exclude [PC*_ICU_* ...]
                        Exclude some ICU present in the Majis data root folder if no explicit ICU is provided. Default: []
  -o, --output folder   Custom output folder. Default: `output/`. If the folder does not exists, it will be created.
  --only background|dark|lamp|blackbody|lamp-vs-blackbody|slit|straylight|contamination|read-reset [background|dark|lamp|blackbody|lamp-vs-blackbody|slit|straylight|contamination|read-reset ...]
                        Run only a subsetDefault: []

Example of usage:

uv run icu --data /data/majis/

⚙️ ICU setup:
- Data folder: data/icu
- Output folder: output
- Analysis list: background, dark, lamp, blackbody, lamp-vs-blackbody, slit, straylight, contamination, read-reset
📋 List of ICU available (N):
- PC1_N_ICU_HOT
- ...
🖼️ Generating background spectra:
- ...          ✅
👻 Generating dark spectra:
- ...          ✅
🔦 Generating lamp images:
- ...          ✅
🔦 Generating lamp spectra:
- ...          ✅
💡 Generating blackbody images:
- ...          ✅
💡 Generating blackbody spectra:
- ...          ✅
🔍 Generating lamp vs. blackbody spectra comparisons:
- ...          ✅
🗿 Generating slit profile comparisons:
- ...          ✅
🔪 Generating slit edges comparisons:
- ...          ✅
📸 Generating straylight images:
- ...          ✅
👽 Generating straylight spatial profiles:
- ...          ✅
🌈 Generating straylight spectra:
- ...          ✅
🦠 Generating contamination map and spectrum:
- ...          ✅
🦠 Generating contamination all spectra ✅
🪃 Generating read-reset images:
- ...          ✅
🪃 Generating read-reset spectra comparisons:
- ...          ✅

Local development

This project is maintained with uv package manager. You need to install it first to perform any local development.

Clone this repo

git clone -b dev-ql-icu https://git.ias.u-psud.fr/majis_sgs/quick-look/majis-ql-icu
cd majis-ql-icu

Install the package and its the required dependencies:

uv sync

Run the linter

uv run ruff format
uv run ruff check

Run unit tests (not much at the moment):

uv run pytest

Run all the notebooks used in the docs:

uv run pytest --nbval-lax docs/notebooks/ --no-cov

To build the documentation html:

uv run jupyter-book build docs/