roc-rap 1.4.2

Rpw dAta Processor (RAP): a plugin used to process RPW L0, L1 and HK data

RAP PLUGIN README

This directory contains the source files of the Rpw dAta Processor (RAP), a plugin of the ROC pipelines dedicated to process RPW L0 data into L1.

RPL has been developed with the POPPY framework.

Quickstart

Installation with pip

To install the plugin using pip:

pip install roc-rap --extra-index-url https://__token__:<your_personal_token>@gitlab.obspm.fr/api/v4/projects/2052/packages/pypi/simple --trusted-host gitlab.obspm.fr

You will need a personnal access token to reach the package registry in the ROC Gitlab server.

Installation from the repository

First, retrieve the RAP repository from the ROC gitlab server:

git clone https://gitlab.obspm.fr/ROC/Pipelines/Plugins/RAP.git

Then, install the package (here using (poetry)[https://python-poetry.org/]):

poetry install --extras "poppy plugin"

NOTES:

- It is also possible to clone the repository using SSH
- To install poetry: `pip install poetry`

Usage

The roc-rap 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.

Known issues

Installation in MacOS based on Apple silicon processors

The RAP plugin cannot be installed for the moment in MacOs relaying on Apple silicon processors.

Contacts

• [e-mail]
• [e-mail]