Metadata-Version: 2.1
Name: roc-rpl
Version: 1.7.0
Summary: RPW Packet parsing Library (RPL): a plugin for the RPW TM/TC packet analysis
Home-page: https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RPL
License: CeCILL 2.1
Author: ROC Team
Author-email: roc.support@sympa.obspm.fr
Requires-Python: >=3.9,<4
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: cython (>=3,<4)
Requires-Dist: numpy (>=1.20,<2)
Requires-Dist: poppy-core (>=0.12.1)
Requires-Dist: poppy-pop (>=0.12.1)
Requires-Dist: roc-idb (>=1.0,<2.0)
Requires-Dist: spice_manager
Project-URL: Repository, https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RPL
Description-Content-Type: text/markdown

RPL PLUGIN README
=================

[![pipeline status](https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RPL/badges/develop/pipeline.svg)](https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RPL/pipelines)

This directory contains the source files of the RPW Packet parsing Library (RPL), a plugin of the ROC pipelines dedicated to parse the RPW telemetry/command packets.

RPL has been developed to work with the [POPPY framework](https://poppy-framework.readthedocs.io/en/latest/).

## Quickstart

### Installation with pip

To install the plugin using pip:

```
pip install roc-rpl
```

## Usage

The roc-rpl plugin is designed to be run in a POPPy-built pipeline.
Nevertheless, it is still possible to import some classes and methods in Python files.

For instance, to test that the installation has ended correctly, run:

```
python -c "from roc.rpl import packet_structure"
```

No message should be returned if the import works well.

## Authors

* Xavier BONNIN xavier.bonnin@obspm.fr

Has also contributed in the past: Sonny LION, Manuel DUARTE

License
-------

This project is licensed under CeCILL 2.1.

Acknowledgments
---------------

* Solar Orbiter / RPW Operation Centre (ROC) team

