SimbioReader

SimbioReader is the official Python reader for the data of the Spectrometer And Imagers For Mpo Bepicolombo Integrated Observatory System on board the ESA mission BepiColombo.

For more information about SIMBIO-SYS you can visit the official ESA SIMBIO-SYS webpage

Installation

To install the reader you can use the command:

$ python3 -m pip install SimbioReader

or using uv

$ uv add SimbioReader

Development

Install the project and its development dependencies with uv:

uv sync --locked --group test --group devel
uv run pytest
uv run ruff check src test
uv build
uv run --no-project --with-requirements docs/requirements.txt --with . python -m sphinx -b html docs/source docs/build/html

Usage

The package provides a class to read PDS4 labels and decode SIMBIO-SYS products. Python 3.14 or later is required.

from SimbioReader import SimbioReader as SR

dat = SR("sim_raw_sc_vihi_internal_cruise_ico4_2020-12-14_001.dat")

Filter display is guarded for product types that do not expose filter metadata, so requesting filter output on those products no longer raises an attribute error. See FLUSSO_DATI.md for the reader's parsing and data flow.

Command line tools

In the package are included two command line tools:

• simbioReader show the info of a specific SIMBIO-SYS data product;
• simbioInfo show the information about phases, subphases and test of SIMBIO-SYS;

simbioReader

simbioReader sim_raw_sc_vihi_internal_cruise_ico6_2021-11-22_001.dat

will show the main information about the product.

Are avalaible some options:

• --summarize, -s displays product, target and filter summaries for products with filter metadata
• --debug, -d enables debug output
• --verbose, -v enables verbose output
• --all will display all the avilable information
• --hk wil display also the housekeeping
• --detector will display all the detector information
• --data-structure will display the data structure of the file
• --filters will display the information about the used filter if the data come from HRIC or STC, otherwise the option will be ignored

For any details you can use the option --help.

Use simbioReader FILE --version to display the software and data-model versions. The current CLI requires an existing FILE even with this option.

simbioInfo

simbioInfo tool is a command line interface (cli) with four subcommands:

• filters Show the definition of filter(s) of a specific channel
• phases Show the past mission phase(s);
• subphases Show the past mission subphase(s);
• tests Show the past SIMBIO-SYS performed test(s)

filters

The subcommand filters has an argument, the channel and an option --name.

If the user provides only the channel, all the filters specific to that channel will be shown. If the user adds the --name option, only the selected filter will be displayed, if found.

A description of argument and options coul be required using the option --help

Examples

simbioInfo filters hric

will show all the filters of the channel HRIC

simbioInfo filters hric -n pan-l

will show the HRIC filter with the name PAN-L

phases

The subcommand phases will display a table of all or filtered past mission phases.

The options are:

• --all Show all the past mission phases;
• --date Show all the phases for the given date;
• --name Show the phase with the given name.

Examples

simbioInfo phases --all

will show all the past mission phases.

simbioInfo phases --date 2024-04-08

will show the phase that include the day 2024-04-08

simbioInfo phases --name necp

will show the phase with the name necp

subphases

The subcommand subphases will display a table of all or filtered past mission subphases.

The options are:

• --all Show all the past mission subphases;
• --date Show all the subphases for the given date;
• --name Show the subphase with the given name.

Examples

simbioInfo subphases --all

will show all the past mission subphases.

simbioInfo subphases --date 2024-04-08

will show the subphase that include the day 2024-04-08, the ico11.

simbioInfo subphases --name ico9

will show the phase with the name ico9

tests

The subcommand tests will display a table of all or filtered SIMBIO-SYS tests.

The options are:

• --all Show all the past SIMBIO-SYS tests;
• --date Show all the SIMBIO-SYS tests for the given date;
• --name Show the SIMBIO-SYS tests with the given name;
• --phase Show the SIMBIO-SYS tests for the specific phase;
• --subphase Show the SIMBIO-SYS tests for the specific subphase.

Examples

simbioInfo tests --all

will show all the SIMBIO-SYS tests.

simbioInfo tests -d 2024-04-08\ 2:00:00  

will show the test that SIMBIO-SYS was performing at 2:00:00 on 2024-04-08, the Interference Test in the subphase ico11

simbioInfo tests --name hric\ functional --subphase ico9

will show the test with the name that contain the string hric functional performed during the subphase ico9

Mission database

Mission phases may contain multiple non-contiguous intervals. simbioInfo phases --all lists intervals chronologically. The bundled database includes the fimgs subphase (Mercury First Images) and the first_images test, both covering 2026-10-18 from 07:00:00 to 21:00:00.

simbioInfo subphases --name fimgs
simbioInfo tests --subphase fimgs

Class Description

Methods

• show() display the main information related to the data file

from rich import print

print(dat.show())