Metadata-Version: 2.4
Name: roc-rap
Version: 1.7.0
Summary: Rpw dAta Processor (RAP): a plugin used to process RPW L0, L1 and HK data
Author-email: Xavier Bonnin <xavier.bonnin@obspm.fr>, 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/RAP
Requires-Python: <4,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<3,>=2
Requires-Dist: pandas<4,>1
Requires-Dist: h5py<4,>=3.7
Requires-Dist: spice_manager
Requires-Dist: poppy-core>0.12.0
Requires-Dist: poppy-pop>0.12.0
Requires-Dist: roc-idb<2,>=1.7
Requires-Dist: roc-rpl<2,>=1.8
Requires-Dist: roc-dingo<2,>=1.7
Dynamic: license-file

roc-rap
============

Python Package to process RPW L0 data.

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-rap
```

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

```
uv add roc-rap
```

## 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
`RAP_EXTENSIONS=0` to skip them). To build the source and wheel distributions:

```
uv build
```

The tests all live in `tests/`, and run locally without a database, without
SPICE kernels and without the test data archive:

```
uv run pytest
```

`tests/pipeline/` holds the pipeline files (settings, configuration and
descriptor) that `tests/conftest.py` loads before the first test, and
`tests/get_test_data.py` retrieves the test data archive used by the end to end
tests run in the CI.

The decommutation is tested on real RPW packets, kept in
`tests/data/l0_extract.h5`: a few packets per packet type, taken from the L0
files of 2024-04-16, 2024-04-25 and 2024-11-27. `tests/make_l0_fixture.py`
rebuilds it from those files, whose paths it takes as arguments.

## 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
