Metadata-Version: 2.1
Name: SimbioReader
Version: 0.1.7.dev1
Summary: Python Reader for the data from SIMBIO-SYS instrument suite on-board the ESA mission BepiColombo
Author-email: Romolo Politi <Romolo.Politi@inaf.it>
License: GNU GPL ver3
Project-URL: Repository, https://github.com/SIMBIO-SYS/SimbioReader
Keywords: data reader,Space Mission,BepiColombo,SIMBIO-SYS
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: rich
Requires-Dist: update-checker
Requires-Dist: importlib-metadata ; python_version > "3.10"
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'

# 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](https://www.cosmos.esa.int/web/bepicolombo/simbio-sys)

## Installation

To install the reader you can use the command:

```shell
$ python3 -m pip install SimbioReader
```

## Usage

The package contain a class that read and decode the SIMBIO-SYS image

```python
from SimbioReader import SimbioReader as SR

dat = SimbioReader("sim_raw_sc_vihi_internal_cruise_ico4_2020-12-14_001.dat")
```

## Command line tools
in the package are included some command line toos:

+ **simbioPhases** show all the phases of the mission BepiColombo, with all the sub-phases of SIMBIO-SYS;
+ **hricFilters** show all the filters avaible for the SIMBIO-SYS channel HRIC;
+ **stcFilters** show all the filters avaible for the SIMBIO-SYS channel STC;

## Class Description

### Methods

+ **Show()** display the main information related to the data file

```python
dat.Show()
```
