maser-data 0.3.0

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 missions:

• Cassini
• Ecallisto
• Interball
• Juno
• Mars Express
• nancay decametric array (Jupiter only)
• Nancay NenuFAR/BST
• Solar orbiter
• Viking
• Wind

Installation

To install the package, 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)
• nenupy for NenuFAR data products support
• 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

Requirements

maser.data requirements are detailed in the 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 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).

Generate setup.py for editable local installation

The setup.py file have to be updated after any changes to the pyproject.toml file.

To generate a new setup.py file, go to the top level of the maser.data project folder and run:

python generate_setup.py

Now you can use the setup.py file to install the package locally in editable mode:

pip install -e path/to/project/folder

Build the documentation

Use sphinx-build docs/source docs/public to build the documentation.

Manually publish maser and generate a new DOI

To publish maser 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

maser comes with a Python client (see .ci/zenodo.py) to interact with the Zenodo API and generate automatically a DOI for each new version of maser.

To archive maser on Zenodo:

1. Create an access token
2. Is this the first maser deposit on Zenodo ?

• Yes it's the first deposit, so you don't need any ID
• No, it's a new version of maser. Then browse to the first record of maser on Zenodo and check the URL : https://zenodo.org/record/<DEPOSITION_ID> to get the maser deposition ID.

3. Use the following command to deposit the package on Zenodo:

 python .ci/zenodo.py -p ./ -t <ACCESS_TOKEN> -a ./dist/maser4py-X.Y.Z.tar.gz  -id <DEPOSITION_ID>

4. Browse to the maser record on Zenodo, check the metadata/files and publish the package to finally generate the DOI.

Notes :

• the --sandbox keyword can be used to deposit files on the Zenodo test server
• the --publish keyword can be used to automatically publish the new record and generate the DOI. But be careful, once published, there is no way to modify a record on Zenodo without publishing a new version.