Skip to main content

Python Space Physics Environment Data Analysis Software (SPEDAS)

Project description

pySPEDAS

Build Status Coverage Status Version License Status Downloads

pySPEDAS is an implementation of the SPEDAS framework in python.

The Space Physics Environment Data Analysis Software (SPEDAS) framework is written in IDL and contains data loading, data analysis and data plotting tools for various scientific NASA missions.

This package is designed to work with the libraries cdflib and pytplot.

How It Works

CDF files are downloaded from the internet to the local machine. The data from these files is loaded into pytplot objects and can be plotted.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Install Python

Python 3.5+ is required.

We recommend Anaconda which comes with a suite of packages useful for science.

Install pySPEDAS

To install pySPEDAS, open a command line and type the command:

conda install -c spedas pyspedas

or

pip install pyspedas

Upgrade pySPEDAS

If you have already installed pySPEDAS, you can upgrade to the latest version using:

conda update -c spedas pyspedas

or

pip install --upgrade pyspedas

Running pySPEDAS

Time History of Events and Macroscale Interactions during Substorms (THEMIS) data

After installation, please change the file pyspedas/prefs.ini and set data_dir=C:\Datapy\themis to a writable directory of your choice. This is the local directory where the CDF files will be saved.

To download CDF files for the THEMIS mission, use:

import pyspedas

pyspedas.load_data(mission, dates, probes, instruments, level, downloadonly)

For example:

d = pyspedas.load_data('themis', '2015-12-31', ['tha'], 'state', 'l1', False)

Crib sheets

Folder examples contains some crib sheets to get you started.

Magnetospheric Multiscale (MMS) data

To set your local data directory for MMS, change the local_data_dir option in pyspedas/mms/mms_config.py

To load 1 day of L2 srvy-mode FGM data:

from pyspedas import mms_load_fgm

mms_load_fgm(trange=['2015-10-16', '2015-10-17'], data_rate='srvy')

To load 1 minute of L2 brst-mode FPI electron moments data for probes 3 and 4:

from pyspedas import mms_load_fpi

mms_load_fpi(probe=[3, 4], trange=['2015-10-16/13:06', '2015-10-16/13:07'], data_rate='brst', datatype='des-moms')

Additional Information

For pytplot, see: https://github.com/MAVENSDC/PyTplot

For cdflib, see: https://github.com/MAVENSDC/cdflib

For SPEDAS, see http://spedas.org/blog/

For information on the THEMIS mission, see http://themis.ssl.berkeley.edu/

(This is the permanent location of pyspedas. Previous location for the initial version of pyspedas was: https://github.com/nickssl/pyspedas)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyspedas-0.9.11.tar.gz (519.6 kB view details)

Uploaded Source

Built Distribution

pyspedas-0.9.11-py2.py3-none-any.whl (596.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pyspedas-0.9.11.tar.gz.

File metadata

  • Download URL: pyspedas-0.9.11.tar.gz
  • Upload date:
  • Size: 519.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0.post20200106 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.6

File hashes

Hashes for pyspedas-0.9.11.tar.gz
Algorithm Hash digest
SHA256 4d577e02c8ee1cfafc86972cf91f2c088ce6b6be1d9ff97e72f51439e40e63f1
MD5 1dc9aaa800f8cc82cb3dd3d1139962a1
BLAKE2b-256 78bb8245a74a54035fef552750269776b183fb86a10af8d4ba657b85cb0e7138

See more details on using hashes here.

File details

Details for the file pyspedas-0.9.11-py2.py3-none-any.whl.

File metadata

  • Download URL: pyspedas-0.9.11-py2.py3-none-any.whl
  • Upload date:
  • Size: 596.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0.post20200106 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.6

File hashes

Hashes for pyspedas-0.9.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1f0658ca821c6705824aaa2a45029b48ef3f5d7d4ff8a3d7bc06c01c4908040e
MD5 c2133e81b478f6e2ca8411537adbb54a
BLAKE2b-256 43fb8ae0f239b59e58c00b7a8af537a1049df90aa96c9cd2469dc2220412b2cb

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