RPW Packet parsing Library (RPL): a plugin for the RPW TM/TC packet analysis
Project description
RPL PLUGIN README
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 with the POPPY framework.
Quickstart
Installation with pip
To install the plugin using pip:
pip install roc-rpl
NOTES:
- It is also possible to install plugin from gitlab: `pip install roc-rpl --extra-index-url https://__token__:<your_personal_token>@gitlab.obspm.fr/api/v4/projects/2052/packages/pypi/simple --trusted-host gitlab.obspm.fr`. A personal access token is required to reach the package registry in the ROC Gitlab server.
Installation from the repository
First, retrieve the RPL
repository from the ROC gitlab server:
git clone https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RPL.git
Then, install the package (here using (poetry)[https://python-poetry.org/]):
poetry install --extras "poppy"
NOTES:
- It is also possible to clone the repositiory using SSH
- To install poetry: `pip install poetry`
- Default branch is `develop`
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 (maintainer)
- Manuel DUARTE manuel.duarte@obspm.fr (author)
- Sonny LION sonny.lion@obspm.fr (author)
License
This project is licensed under CeCILL-C.
Acknowledgments
- Solar Orbiter / RPW Operation Centre (ROC) team
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for roc_rpl-1.6.1-cp311-cp311-manylinux_2_36_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32582d92c6d9ba432ff2c1fd00d991a2af0cde3e9b4a1ecbb16c893f3cbff5f1 |
|
MD5 | 2f0b0f5a95bbaafbc70459f2f151d107 |
|
BLAKE2b-256 | f03a16625a816d1abadfaf3f72a45e23a7de58259adabd94927f3c9f0de443ae |