Metadata-Version: 2.4
Name: mertisreader
Version: 0.0.4
Summary: helper routines to read ESA/Bepicolombo space mission - DLR MERTIS instrument data
Project-URL: homepage, https://github.com/mariodamore/mertisreader
Project-URL: repository, https://github.com/mariodamore/mertisreader
Project-URL: documentation, https://mariodamore.github.io/mertisreader/
Author-email: Mario D Amore <mario.damore@dlr.de>
License: MIT
License-File: LICENSE
Keywords: data,instrument,planetary
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: astropy
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pds4-tools>=1.4
Requires-Dist: polars
Requires-Dist: rich
Requires-Dist: scipy
Requires-Dist: xmltodict
Provides-Extra: docs
Requires-Dist: griffe<2; extra == 'docs'
Requires-Dist: jupytext>=1.16; extra == 'docs'
Requires-Dist: quartodoc>=0.11; extra == 'docs'
Description-Content-Type: text/markdown

# mertisreader


`mertisreader` reads ESA BepiColombo MERTIS data and now ships with a
Quarto documentation site plus quartodoc-generated API reference.

## Documentation

- Site home: [docs_src/index.qmd](docs_src/index.qmd)
- Tutorials:
  [docs_src/tutorials/index.qmd](docs_src/tutorials/index.qmd)
- API reference: [docs_src/api.qmd](docs_src/api.qmd)

## Quick Start

``` python
import pathlib
import mertisreader as mr

input_path = pathlib.Path("data/bcmer_tm_all_START-20200409T000000_END-20200410T000000_CRE-20240717T132010-ParamEventBootSciHK-short/cal")
reader = mr.MERTISDataPackReader(input_dir=input_path, output_dir="/tmp", log_level="INFO")
```

## What Changed

- Documentation moved from nbdev-generated notebook sources to Quarto
  tutorial pages.
- API pages are generated from Python docstrings with quartodoc.
- The published site is built with `quarto render`.

## Installation

Use the project environment and install the package with the docs extra
when you need the documentation toolchain:

``` bash
python -m pip install -e ".[docs]"
```

## Examples

For an interactive walkthrough, open
[examples/read_merstis_test.ipynb](examples/read_merstis_test.ipynb) or
the matching tutorial pages under
[docs_src/tutorials/](docs_src/tutorials/).
