maser-data 0.5.1

Maser4py submodule to handle radio data

About maser-data

maser-data is a submodule of maser4py.

It offers programs to handle radio data from the following instruments:

• Cassini/RPWS/HFR
• E-Callisto
• Interball-Auroral/POLRAD
• Juno/Waves
• Mars Express/MARSIS
• Nançay Decameter Array (Jupiter only)
• Nançay NenuFAR/BST
• Solar Orbiter/RPW
• Viking
• Voyager/PRA
• Wind/Waves

Read maser4py main documentation for details.

Installation

With maser4py (recommanded)

To install the package, run the following command:

pip install maser4py[data]

and use one of the extra options:

• jupyter for Jupyter notebook support
• spacepy for CDF data format support (note that this requires the CDF library)

For example use maser4py[data,jupyter,spacepy] if you want to use maser-data with spacepy and jupyter notebooks:

pip install maser4py[data,jupyter,spacepy]

You can also use other options from maser4py such as:

• tools for maser-tools submodule
• plot for maser-plot submodule
• all to install all the above

pip install maser4py[all]

As a standalone submodule

An alternative way of installing the package is to run the following command:

pip install maser-data

or use one of the extra options:

• jupyter for Jupyter notebook support
• spacepy for CDF data format support (note that this requires the CDF library)
• all to install all the above

For example use maser-data[jupyter,spacepy] if you want to use maser-data with spacepy and jupyter notebooks:

pip install maser-data[jupyter,spacepy]

Usage

The Data class is a wrapper around several classes that allow you to read data from many different formats, including CDF, Fits, and some custom binary formats. By default, the class will try to automagically detect the format of the file and use the appropriate class to read the data.

from maser.data import Data

filepath = "path/to/my/data/file.ext"
data = Data(filepath=filepath)

You can also launch a Binder environment and browse through the notebook examples.

Development

To contribute to the development of the package, you will need to install a local copy of maser.data

git clone https://gitlab.obspm.fr/maser/maser4py.git

Then, you can install the package locally, by using pip install -e .[all] or by using poetry (see below).

Requirements

maser-data requirements are detailed in the src/maser_data/pyproject.toml file

poetry

To install the package, it is recommended to use poetry:

pip install poetry

CDF file format

To use maser-data to read CDF files you have to install the CDF library and the spacepy.pycdf package.

Installing a local copy of maser-data

Use the following command from src/maser_data folder to install the package:

poetry install

or this one if you want to use maser-data with spacepy to handle CDF files:

poetry install --extras "spacepy"

Tests

Use pytest -m "not test_data_required" to skip tests that require test data (and to skip auto download).

Manually publish maser-data on pypi

To publish maser-data with poetry you will have to build a dist package:

poetry build

And then publish the package on pypi (and/or on Gitlab, see https://python-poetry.org/docs/cli/#publish):

poetry publish

Commands above must be run from src/maser_data directory.