Plugin to manage the IDB
Project description
ROC IDB
A plugin to manage different IDB source/version for RPW/Solar Orbiter.
User guide
Pre-requisites
The following software must be installed:
- Python 3.8
- pip tool
- poetry (optional)
- git (optional)
Install a stable release with pip
To install the roc-idb plugin with pip:
pip install roc-idb
Nominal usage
roc-idb is designed to be called from a pipeline running with the POPPy framework.
The plugin can be used in Python programs using "import roc.idb".
Developer guide
Install a local copy from source files
To install a local copy of the roc-idb plugin:
- Retrieve a copy of the source files from https://gitlab.obspm.fr/ROC/Pipelines/Plugins/IDB (restricted access)
- Use
pip install
orpoetry install
command to install local instance
Publish a new tag on Gitlab
- Update the version using
poetry version <bump_level>
where <bump_level> can be patch, minor or major - Update the descriptor using
poetry run python bump_descriptor.py
- Generate the new setup file using
poetry run dephell deps convert
- Apply code formatters using
poetry run pre-commit run -a
- Commit and tag
Authors
- Xavier BONNIN xavier.bonnin@obspm.fr (maintainer)
- 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
roc_idb-1.4.3.tar.gz
(65.2 kB
view hashes)
Built Distribution
roc_idb-1.4.3-py3-none-any.whl
(89.6 kB
view hashes)