Skip to main content

A simple Python package to deal with main Space Physics WebServices (CDA,CSA,AMDA_Webservice,..) mainly written to ease development of SciQLop.

Project description

Space Physics made EASY

Chat on Matrix https://img.shields.io/pypi/v/speasy.svg https://github.com/SciQLop/speasy/workflows/Tests/badge.svg Documentation Status Coverage Status Total alerts Language grade: Python Zendoo DOI Discover on MyBinder

Speasy is an open source Python client for Space Physics web services such as CDAWEB or AMDA. Most space physics data analysis starts with finding which server provides which dataset then figuring out how to download them. This can be difficult specially for students or newcomers, Speasy try to remove all difficulties by providing an unique and simple API to access them all. Speasy aims to support as much as possible web services and also cover a maximum of features they propose.

Quickstart

Installing Speasy with pip (more details here):

$ pip install speasy
# or
$ pip install --user speasy

Getting data is as simple as:

import speasy as spz
ace_mag = spz.get_data('amda/imf', "2016-6-2", "2016-6-5")

Where amda is the webservice and imf is the product id you will get with this request.

Using the dynamic inventory this can be even simpler:

import speasy as spz
amda_tree = spz.inventory.data_tree.amda
ace_mag = spz.get_data(amda_tree.Parameters.ACE.MFI.ace_imf_all.imf, "2016-6-2", "2016-6-5")

Will produce the exact same result than previous example but has the advantage to be easier to manipulate since you can discover available data from your favourite Python environment completion such as IPython or notebooks (might not work from IDEs).

This also works with SSCWEB, you can easily download trajectories:

import speasy as spz
sscweb_tree = spz.inventory.data_tree.ssc
solo = spz.get_data(sscweb_tree.Trajectories.solarorbiter, "2021-01-01", "2021-02-01")

Documentation

Check out the documentation and examples at speasy documentation.

Features

  • Simple and intuitive API (spz.get_data to get them all)
  • Pandas DataFrame like interface for variables
  • Quick functions to convert a variable to a Pandas DataFrame
  • Local cache to avoid repeating twice the same request
  • Can take advantage of SciQLop dedicated poxy as a community backed ultra fast cache
  • Full support of AMDA API.

Examples

See here for a complete list of examples.

Caveats

  • installing speasy on both python 3.7 or less and python 3.8 or plus at the same time doesn’t work since entries stored in cache by python 3.8+ are not readable by python 3.7-.
  • Speasy is not a plotting package, while it provides basic plot features, it is not meant to produce publication ready figures.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

The development of speasy is supported by the CDPP.

History

0.10.0 (2022-02-03)

  • Adds support for all AMDA products, even private ones
  • Adds support for AMDA credentials
  • Adds dynamic inventory for AMDA and SSC
  • Adds possibility to set config values from ENV
  • Drops Python 3.6 support and adds 3.10
  • New API documentation using numpydoc
  • New user documentation using numpydoc
  • Most code examples are tested with doctest
  • Renames SSCWeb module get_orbit to get_trajectory

0.9.1 (2021-11-25)

0.9.0 (2021-07-29)

  • Adds SPWC migration tool
  • Rename SpwcVariable to SpeasyVariable

0.8.3 (2021-07-28)

  • Package renamed from SPWC to SPEASY
  • Some doc and CI improvements

0.8.2 (2021-04-20)

  • sscweb trajectories are always in km

0.8.1 (2021-04-18)

  • Fixes minimum request duration for sscweb

0.8.0 (2021-04-18)

  • Full support for trajectories and 0.2 proxy version

0.7.2 (2020-11-13)

  • ccsweb/proxy: Fix missing coordinate system parameter

0.7.1 (2020-11-13)

  • Fix project URL on PyPi

0.7.0 (2020-11-13)

  • SSCWEB support to get satellites trajectories.
  • Few bug fixes.
  • Totally disabled cdf support for now.

0.1.0 (2019-12-07)

  • First release on PyPI.

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

speasy-0.10.2.tar.gz (549.1 kB view hashes)

Uploaded source

Built Distribution

speasy-0.10.2-py2.py3-none-any.whl (42.4 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page