Skip to main content

Maser4py submodule to handle radio data

Project description

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

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)
  • 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)

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

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.

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

maser_data-0.4.2.tar.gz (74.3 kB view details)

Uploaded Source

Built Distribution

maser_data-0.4.2-py3-none-any.whl (102.4 kB view details)

Uploaded Python 3

File details

Details for the file maser_data-0.4.2.tar.gz.

File metadata

  • Download URL: maser_data-0.4.2.tar.gz
  • Upload date:
  • Size: 74.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.13 Darwin/22.6.0

File hashes

Hashes for maser_data-0.4.2.tar.gz
Algorithm Hash digest
SHA256 d3450e181a7b65dcc9a295696f67b3e523d2cdbed884de50d62e7031982f8a1d
MD5 95fc0313e2fa1c4b3f1bcc0a5d1251a7
BLAKE2b-256 434bcae808eb6b107223354a81e2984ab9083440091e82743eb9a6209be3378b

See more details on using hashes here.

File details

Details for the file maser_data-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: maser_data-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 102.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.13 Darwin/22.6.0

File hashes

Hashes for maser_data-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6416fbea80190b6215df658a7e39ac6ce73e335300f37b28129d68990771b42d
MD5 c5a884b5a03ec41a54d181f5101683d0
BLAKE2b-256 249e8b8cba6779fbf640ac46755c4c7c89a74ee7140383b28280e81258d889c7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page