Metadata-Version: 2.4
Name: roc-rpl
Version: 1.8.1
Summary: RPW Packet parsing Library (RPL): a plugin for the RPW TM/TC packet analysis
Author-email: ROC Team <roc.support@sympa.obspm.fr>
Maintainer-email: ROC Team <roc.support@sympa.obspm.fr>
License-Expression: CECILL-2.1
Project-URL: Repository, https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RPL
Requires-Python: <4,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<3,>=2
Requires-Dist: spice_manager
Requires-Dist: poppy-core>0.12.0
Requires-Dist: poppy-pop>0.12.0
Requires-Dist: roc-idb<2.0,>=1.0
Dynamic: license-file

roc-rpl
============

Python Package to parse RPW raw telemetry.

This package has been initially designed to be run in the RPW Operations and Data Pipeline (RODP).
Contact the developer team for more details.

## Quickstart

To install package using [pip](https://pypi.org/project/pip-tools/):

```
pip install roc-rpl
```

Or using [uv](https://docs.astral.sh/uv/):

```
uv add roc-rpl
```

## Development

The package is managed with [uv](https://docs.astral.sh/uv/). To install the
plugin and its development dependencies in a local virtual environment:

```
uv sync
```

The Cython extensions are compiled at install time by `setup.py` (set
`RPL_EXTENSIONS=0` to skip them). To build the source and wheel distributions:

```
uv build
```

To run the tests:

```
export SPICE_KERNEL_PATH=/path/to/spice/kernels
uv run pytest
```

The tests do not need a database server: the RPW IDB they require is mocked in
a temporary SQLite database (see `tests/mock_db.py` and `tests/idb_fixture.py`).
The Solar Orbiter SPICE kernels are still needed to compute the UTC times of
the packets.

## Authors

- xavier dot bonnin at obspm dot fr
- florence dot henry at obspm dot fr
- sonny dot lion at obspm dot fr

## License

This project is licensed under CeCILL 2.1.

## Acknowledgments

* Solar Orbiter / RPW Operation Centre (ROC) team
