Skip to main content

Maser4py submodule to plot radio data

Project description

About maser-plot

maser-plot is a submodule of maser4py.

It can be used with maser.data to plot radio data from the following missions:

  • RPW/Solar Orbiter

Installation

To install the package, run the following command:

pip install maser-plot

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-plot[jupyter,spacepy] if you want to use maser-plot with spacepy and jupyter notebooks:

pip install maser-plot[jupyter,spacepy]

Usage

See in examples folder about illustrations on how to use maser-plot.

Examples can also be run on Binder 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-plot

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

Then, you can install the package locally

Requirements

maser-plot requirements are detailed in the src/maser_plot/pyproject.toml file

poetry

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

pip install poetry

CDF file format

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

Installing a local copy of maser-plot

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

poetry install

or this one if you want to use maser-plot 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-plot on pypi

To publish maser-plot 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_plot 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-plot-0.2.7.tar.gz (8.9 kB view hashes)

Uploaded Source

Built Distribution

maser_plot-0.2.7-py3-none-any.whl (10.2 kB view hashes)

Uploaded Python 3

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