Skip to main content

About maser-data

This is maser-data, a submodule of maser4py. maser4py offers modules to handle data from several space and ground radio observatory and maser-data is the submodule dedicated to handling radio data parsing.

maser4py is developed in the framework of the MASER project.

maser-data offers programs to handle radio data from the following instruments:

  • BepiColombo/MMO/PWI/SORBET
  • 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
  • STEREO/Waves
  • Viking
  • Voyager/PRA
  • Wind/Waves

Detailed information can be found in maser-data user guide.

You can also have a look to maser-data examples and notebooks.

For a broader documentation, please check maser4py main documentation for details.

Installation

As a standalone submodule (recommanded)

To install the package, run the following command:

pip install maser-data

maser-data (through spacepy ), requires the CDF library that needs to be installed on its own (see below).

It is also possible to use the extra option jupyter when installing maser-data:

  • jupyter for Jupyter notebook support

  • (all is equivalent to the line 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]

With maser4py

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

pip install maser4py[data]

and use the extra options:

  • jupyter for Jupyter notebook support

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

pip install maser4py[data,jupyter]

You can also use other options from maser4py such as:

  • tools for maser-tools submodule
  • all to install all the above
pip install maser4py[all]

CDF file format

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

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)

Binder 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 as a developer, it is recommended to use poetry:

pip install poetry

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

Notes:

- The commands above must be run from `src/maser_data` directory.
- A valid token is required to publish on pypi. Run `poetry config pypi-token.pypi <your_token>` to set it.

Metadata

Release files for maser-data 0.5.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for maser-data 0.5.3
File Size Uploaded Provenance Actions
maser_data-0.5.3.tar.gz 96.0 kB Without provenance Details for maser_data-0.5.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for maser-data 0.5.3
File Interpreter ABI Platform Actions
maser_data-0.5.3-py3-none-any.whl Python 3 none any Details for maser_data-0.5.3-py3-none-any.whl

Total release size: 224.3 kB

Release files / maser_data-0.5.3.tar.gz

Download URL maser_data-0.5.3.tar.gz
Size 96.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c0d6994fa66fae9bc155a791841743d3d893a0ae7cb389e5a9695741100bd498
BLAKE2b-256 checksum
How to use checksums
66ab786b089b0d66226a1066bdecb9ee935bbe048351286e57622872360547bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.8.20 Linux/6.12.117+deb13-amd64

Release files / maser_data-0.5.3-py3-none-any.whl

Download URL maser_data-0.5.3-py3-none-any.whl
Size 128.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e3189ef6f8fb8d40a5c99ffb3e44ed6ead2644c31f1b5473a2e088197ae1fb69
BLAKE2b-256 checksum
How to use checksums
973ded41a55c09df5a36a635bd49bf56ab03b882f9c9273a744ea2fec6146bfc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.8.20 Linux/6.12.117+deb13-amd64

Security for maser-data 0.5.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page