# PySPEDAS
[](https://github.com/spedas/pyspedas/actions)
[](https://coveralls.io/github/spedas/pyspedas)
[](https://pypi.org/project/pyspedas/)
[](https://www.repostatus.org/#active)
The Python-based Space Physics Environment Data Analysis Software (PySPEDAS) framework supports multi-mission, multi-instrument retrieval, analysis, and visualization of heliophysics time series data.
## Projects Supported
- [Advanced Composition Explorer (ACE)](https://pyspedas.readthedocs.io/en/latest/ace.html)
- [Akebono](https://pyspedas.readthedocs.io/en/latest/akebono.html)
- [Arase (ERG)](https://pyspedas.readthedocs.io/en/latest/erg.html)
- [Cluster](https://pyspedas.readthedocs.io/en/latest/cluster.html)
- [Colorado Student Space Weather Experiment (CSSWE)](https://pyspedas.readthedocs.io/en/latest/csswe.html)
- [Communications/Navigation Outage Forecasting System (C/NOFS)](https://pyspedas.readthedocs.io/en/latest/cnofs.html)
- [Deep Space Climate Observatory (DSCOVR)](https://pyspedas.readthedocs.io/en/latest/dscovr.html)
- [Dynamics Explorer 2 (DE2)](https://pyspedas.readthedocs.io/en/latest/de2.html)
- [Equator-S](https://pyspedas.readthedocs.io/en/latest/equator-s.html)
- [Fast Auroral Snapshot Explorer (FAST)](https://pyspedas.readthedocs.io/en/latest/fast.html)
- [Geotail](https://pyspedas.readthedocs.io/en/latest/geotail.html)
- [Geostationary Operational Environmental Satellite (GOES)](https://pyspedas.readthedocs.io/en/latest/goes.html)
- [Imager for Magnetopause-to-Aurora Global Exploration (IMAGE)](https://pyspedas.readthedocs.io/en/latest/image.html)
- [Kyoto Dst Index](https://pyspedas.readthedocs.io/en/latest/kyoto.html)
- [LANL](https://pyspedas.readthedocs.io/en/latest/lanl.html)
- [Mars Atmosphere and Volatile Evolution (MAVEN)](https://pyspedas.readthedocs.io/en/latest/maven.html)
- [Magnetic Induction Coil Array (MICA)](https://pyspedas.readthedocs.io/en/latest/mica.html)
- [Magnetospheric Multiscale (MMS)](https://pyspedas.readthedocs.io/en/latest/mms.html)
- [OMNI](https://pyspedas.readthedocs.io/en/latest/omni.html)
- [Polar Orbiting Environmental Satellites (POES)](https://pyspedas.readthedocs.io/en/latest/poes.html)
- [Polar](https://pyspedas.readthedocs.io/en/latest/polar.html)
- [Parker Solar Probe (PSP)](https://pyspedas.readthedocs.io/en/latest/psp.html)
- [Solar & Heliospheric Observatory (SOHO)](https://pyspedas.readthedocs.io/en/latest/soho.html)
- [Solar Orbiter (SOLO)](https://pyspedas.readthedocs.io/en/latest/solo.html)
- [Solar Terrestrial Relations Observatory (STEREO)](https://pyspedas.readthedocs.io/en/latest/stereo.html)
- [Space Technology 5 (ST5)](https://pyspedas.readthedocs.io/en/latest/st5.html)
- [Spherical Elementary Currents (SECS)](https://github.com/spedas/pyspedas/blob/master/pyspedas/secs/README.md)
- [Swarm](https://github.com/spedas/pyspedas/blob/master/pyspedas/swarm/README.md)
- [Time History of Events and Macroscale Interactions during Substorms (THEMIS)](https://pyspedas.readthedocs.io/en/latest/themis.html)
- [Two Wide-Angle Imaging Neutral-Atom Spectrometers (TWINS)](https://pyspedas.readthedocs.io/en/latest/twins.html)
- [Ulysses](https://pyspedas.readthedocs.io/en/latest/ulysses.html)
- [Van Allen Probes (RBSP)](https://pyspedas.readthedocs.io/en/latest/rbsp.html)
- [Wind](https://pyspedas.readthedocs.io/en/latest/wind.html)
## Requirements
Python 3.9+ is required.
We recommend [Anaconda](https://www.continuum.io/downloads/) which comes with a suite of packages useful for scientific data analysis. Step-by-step instructions for installing Anaconda can be found at: [Windows](https://docs.anaconda.com/anaconda/install/windows/), [macOS](https://docs.anaconda.com/anaconda/install/mac-os/), [Linux](https://docs.anaconda.com/anaconda/install/linux/)
## Installation
### Virtual Environment
To avoid potential dependency issues with other Python packages, we suggest creating a virtual environment for PySPEDAS; you can create a virtual environment in your terminal with:
```bash
python -m venv pyspedas
```
To enter your virtual environment, run the 'activate' script:
#### Windows
```bash
.\pyspedas\Scripts\activate
```
#### macOS and Linux
```bash
source pyspedas/bin/activate
```
#### Using Jupyter notebooks with your virtual environment
To get virtual environments working with Jupyter, in the virtual environment, type:
```bash
pip install ipykernel
python -m ipykernel install --user --name pyspedas --display-name "Python (pySPEDAS)"
```
(note: "pyspedas" is the name of your virtual environment)
Then once you open the notebook, go to "Kernel" then "Change kernel" and select the one named "Python (PySPEDAS)"
### Install
PySPEDAS supports Windows, macOS and Linux. To get started, install the `pyspedas` package using PyPI:
```bash
pip install pyspedas
```
### Upgrade
To upgrade to the latest version of PySPEDAS:
```bash
pip install pyspedas --upgrade
```
## Local Data Directories
The recommended way of setting your local data directory is to set the `SPEDAS_DATA_DIR` environment variable. `SPEDAS_DATA_DIR` acts as a root data directory for all missions, and will also be used by IDL (if you’re running a recent copy of the bleeding edge).
Mission specific data directories (e.g., `MMS_DATA_DIR` for MMS, `THM_DATA_DIR` for THEMIS) can also be set, and these will override `SPEDAS_DATA_DIR`
## Usage
To get started, import pyspedas and pytplot:
```python
import pyspedas
from pytplot import tplot
```
You can load data into tplot variables by calling `pyspedas.mission.instrument()`, e.g.,
To load and plot 1 day of THEMIS FGM data for probe 'd':
```python
thm_fgm = pyspedas.themis.fgm(trange=['2015-10-16', '2015-10-17'], probe='d')
tplot(['thd_fgs_gse', 'thd_fgs_gsm'])
```
To load and plot 2 minutes of MMS burst mode FGM data:
```python
mms_fgm = pyspedas.mms.fgm(trange=['2015-10-16/13:05:30', '2015-10-16/13:07:30'], data_rate='brst')
tplot(['mms1_fgm_b_gse_brst_l2', 'mms1_fgm_b_gsm_brst_l2'])
```
Note: by default, PySPEDAS loads all data contained in CDFs found within the requested time range; this can potentially load data outside of your requested trange. To remove the data outside of your requested trange, set the `time_clip` keyword to `True`
To load and plot 6 hours of PSP SWEAP/SPAN-i data:
```python
spi_vars = pyspedas.psp.spi(trange=['2018-11-5', '2018-11-5/06:00'], time_clip=True)
tplot(['DENS', 'VEL', 'T_TENSOR', 'TEMP'])
```
To download 5 days of STEREO magnetometer data (but not load them into tplot variables):
```python
stereo_files = pyspedas.stereo.mag(trange=['2013-11-1', '2013-11-6'], downloadonly=True)
```
### Standard Options
- `trange`: two-element list specifying the time range of interest. This keyword accepts a wide range of formats
- `time_clip`: if set, clip the variables to the exact time range specified by the `trange` keyword
- `suffix`: string specifying a suffix to append to the loaded variables
- `varformat`: string specifying which CDF variables to load; accepts the wild cards * and ?
- `varnames`: string specifying which CDF variables to load (exact names)
- `get_support_data`: if set, load the support variables from the CDFs
- `downloadonly`: if set, download the files but do not load them into tplot
- `no_update`: if set, only load the data from the local cache
- `notplot`: if set, load the variables into dictionaries containing numpy arrays (instead of creating the tplot variables)
## Examples
Please see the following notebooks for examples of using PySPEDAS
### PyTplot Basics
- [Introduction to PyTplot](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Introduction_to_PyTplot.ipynb)
### Loading Data
- [MMS examples](https://github.com/spedas/mms-examples/tree/master/basic)
- [THEMIS examples](https://github.com/spedas/themis-examples/tree/main/basic)
- [Load data from HAPI servers](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PySPEDAS_loading_data_from_HAPI_servers.ipynb)
- [Exploring the Heliosphere with Python](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Exploring_the_Heliosphere_with_Python.ipynb)
### Plotting
- [Annotations](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_annotations.ipynb)
- [Range options](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_range_options.ipynb)
- [Spectrogram options](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_spectrogram_options.ipynb)
- [Legend options](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_legend_options.ipynb)
- [Markers and symbols](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_markers_and_symbols.ipynb)
- [Error bars](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_error_bars.ipynb)
- [Pseudo variables](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_pseudo_variables.ipynb)
- [Highlight intervals and vertical bars](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_highlight_intervals_and_vertical_bars.ipynb)
Additional examples of loading and plotting data can be found in the documentation for the project you're interested in ([PySPEDAS projects](https://pyspedas.readthedocs.io/en/latest/projects.html)), as well as the project's README file.
### Dates and Times
- [Working with dates and times](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Working_with_dates_and_times_with_PySPEDAS_PyTplot.ipynb)
### Coordinate Transformations
- [Coordinate transformations](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Coordinate_transformations_with_OMNI_data.ipynb)
- [Boundary normal (LMN) coordinates](https://github.com/spedas/mms-examples/blob/master/advanced/MMS_LMN_coordinate_transformation.ipynb)
- [Quaternion transformations with SpacePy](https://github.com/spedas/mms-examples/blob/master/basic/MMS_quaternion_coordinate_transformations.ipynb)
### Analysis
- [Plasma calculations with PlasmaPy](https://github.com/spedas/mms-examples/blob/master/advanced/Plasma%20calculations%20with%20PlasmaPy.ipynb)
- [Poynting flux with MMS data](https://github.com/spedas/mms-examples/blob/master/advanced/Poynting_flux_with_MMS_data.ipynb)
- [Plasma beta with MMS data](https://github.com/spedas/mms-examples/blob/master/basic/Plasma%20Beta%20with%20FGM%20and%20FPI%20data.ipynb) (note: the PlasmaPy notebook above shows a much easier method)
- [Curlometer calculations](https://github.com/spedas/mms-examples/blob/master/basic/Curlometer%20Technique.ipynb)
- [Neutral sheet models](https://github.com/spedas/mms-examples/blob/master/advanced/MMS_neutral_sheet_models.ipynb)
- [Wave polarization calculations](https://github.com/spedas/mms-examples/blob/master/advanced/Wave_polarization_using_SCM_data.ipynb)
- [Dynamic power spectra calculations](https://github.com/spedas/mms-examples/blob/master/basic/Search-coil%20Magnetometer%20(SCM).ipynb)
- [2D slices of MMS distribution functions](https://github.com/spedas/mms-examples/blob/master/advanced/Generate_2D_slices_of_FPI_and_HPCA_data.ipynb)
- [Generating spectrograms and moments from MMS distribution functions](https://github.com/spedas/mms-examples/blob/master/advanced/Generate%20spectrograms%20and%20moments%20with%20mms_part_getspec.ipynb)
## Documentation
For more information, please see our HTML documentation at:
https://pyspedas.readthedocs.io/
## Getting Help
To find the options supported, call `help` on the instrument function you're interested in:
```python
help(pyspedas.themis.fgm)
```
You can ask questions by creating an issue or by joining the [SPEDAS mailing list](http://spedas.org/mailman/listinfo/spedas-list_spedas.org).
## PyTplot
Pytplot is a separate project, that replicates the IDL "tplot" functionality. Pyspedas uses a modified version of pytplot with matplotlib as the plotting library.
## Contributing
We welcome contributions to PySPEDAS; to learn how you can contribute, please see our [Contributing Guide](https://github.com/spedas/pyspedas/blob/master/CONTRIBUTING.md)
## Plug-in Development
An introduction to PySPEDAS plug-in development can be found here:
[Introduction to PySPEDAS plug-in development](https://github.com/spedas/pyspedas/tree/master/docs/pyspedas_plugin_development.pdf)
## Code of Conduct
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. To learn more, please see our [Code of Conduct](https://github.com/spedas/pyspedas/blob/master/CODE_OF_CONDUCT.md).
## Additional Information
For examples of pyspedas, see: https://github.com/spedas/pyspedas_examples
For MMS examples, see: https://github.com/spedas/mms-examples
For pytplot (matplotlib version), see: https://github.com/MAVENSDC/PyTplot/tree/matplotlib-backend
For cdflib, see: https://github.com/MAVENSDC/cdflib
For SPEDAS, see http://spedas.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "pyspedas",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "SPEDAS, data, tools, space physics, data analysis, space science, scientific computing, time series analysis, data visualization, satellite data, magnetosphere, ionosphere, heliophysics, geophysics, remote sensing, astrophysics, solar physics, space weather, data retrieval, NASA, NOAA, ESA, JAXA, HSO, CDF, ISTP, netCDF, Python package, THEMIS, ARTEMIS, MMS, ERG, Arase, ACE, MAVEN, RBSP, Van Allen Probes, GOES, POES, Cluster, OMNIWeb, aurora, geomagnetic index, Kp index, AE index, magnetic field models, Tsyganenko, IGRF, geopack, magnetotelluric",
"author": null,
"author_email": "Jim Lewis <jwl@ssl.berkeley.edu>",
"download_url": "https://files.pythonhosted.org/packages/cb/a1/459d1f92aeba0d560972bc80aafcd49487266aabf276a296a7196d2389ef/pyspedas-1.7.1.tar.gz",
"platform": null,
"description": "\n# PySPEDAS\n[](https://github.com/spedas/pyspedas/actions)\n[](https://coveralls.io/github/spedas/pyspedas)\n[](https://pypi.org/project/pyspedas/)\n\n\n[](https://www.repostatus.org/#active)\n\nThe Python-based Space Physics Environment Data Analysis Software (PySPEDAS) framework supports multi-mission, multi-instrument retrieval, analysis, and visualization of heliophysics time series data.\n\n\n## Projects Supported\n- [Advanced Composition Explorer (ACE)](https://pyspedas.readthedocs.io/en/latest/ace.html)\n- [Akebono](https://pyspedas.readthedocs.io/en/latest/akebono.html)\n- [Arase (ERG)](https://pyspedas.readthedocs.io/en/latest/erg.html)\n- [Cluster](https://pyspedas.readthedocs.io/en/latest/cluster.html)\n- [Colorado Student Space Weather Experiment (CSSWE)](https://pyspedas.readthedocs.io/en/latest/csswe.html)\n- [Communications/Navigation Outage Forecasting System (C/NOFS)](https://pyspedas.readthedocs.io/en/latest/cnofs.html)\n- [Deep Space Climate Observatory (DSCOVR)](https://pyspedas.readthedocs.io/en/latest/dscovr.html)\n- [Dynamics Explorer 2 (DE2)](https://pyspedas.readthedocs.io/en/latest/de2.html)\n- [Equator-S](https://pyspedas.readthedocs.io/en/latest/equator-s.html)\n- [Fast Auroral Snapshot Explorer (FAST)](https://pyspedas.readthedocs.io/en/latest/fast.html)\n- [Geotail](https://pyspedas.readthedocs.io/en/latest/geotail.html)\n- [Geostationary Operational Environmental Satellite (GOES)](https://pyspedas.readthedocs.io/en/latest/goes.html)\n- [Imager for Magnetopause-to-Aurora Global Exploration (IMAGE)](https://pyspedas.readthedocs.io/en/latest/image.html)\n- [Kyoto Dst Index](https://pyspedas.readthedocs.io/en/latest/kyoto.html)\n- [LANL](https://pyspedas.readthedocs.io/en/latest/lanl.html)\n- [Mars Atmosphere and Volatile Evolution (MAVEN)](https://pyspedas.readthedocs.io/en/latest/maven.html)\n- [Magnetic Induction Coil Array (MICA)](https://pyspedas.readthedocs.io/en/latest/mica.html)\n- [Magnetospheric Multiscale (MMS)](https://pyspedas.readthedocs.io/en/latest/mms.html)\n- [OMNI](https://pyspedas.readthedocs.io/en/latest/omni.html)\n- [Polar Orbiting Environmental Satellites (POES)](https://pyspedas.readthedocs.io/en/latest/poes.html)\n- [Polar](https://pyspedas.readthedocs.io/en/latest/polar.html)\n- [Parker Solar Probe (PSP)](https://pyspedas.readthedocs.io/en/latest/psp.html)\n- [Solar & Heliospheric Observatory (SOHO)](https://pyspedas.readthedocs.io/en/latest/soho.html)\n- [Solar Orbiter (SOLO)](https://pyspedas.readthedocs.io/en/latest/solo.html)\n- [Solar Terrestrial Relations Observatory (STEREO)](https://pyspedas.readthedocs.io/en/latest/stereo.html)\n- [Space Technology 5 (ST5)](https://pyspedas.readthedocs.io/en/latest/st5.html)\n- [Spherical Elementary Currents (SECS)](https://github.com/spedas/pyspedas/blob/master/pyspedas/secs/README.md)\n- [Swarm](https://github.com/spedas/pyspedas/blob/master/pyspedas/swarm/README.md)\n- [Time History of Events and Macroscale Interactions during Substorms (THEMIS)](https://pyspedas.readthedocs.io/en/latest/themis.html)\n- [Two Wide-Angle Imaging Neutral-Atom Spectrometers (TWINS)](https://pyspedas.readthedocs.io/en/latest/twins.html)\n- [Ulysses](https://pyspedas.readthedocs.io/en/latest/ulysses.html)\n- [Van Allen Probes (RBSP)](https://pyspedas.readthedocs.io/en/latest/rbsp.html)\n- [Wind](https://pyspedas.readthedocs.io/en/latest/wind.html)\n\n\n## Requirements\n\nPython 3.9+ is required.\n\nWe recommend [Anaconda](https://www.continuum.io/downloads/) which comes with a suite of packages useful for scientific data analysis. Step-by-step instructions for installing Anaconda can be found at: [Windows](https://docs.anaconda.com/anaconda/install/windows/), [macOS](https://docs.anaconda.com/anaconda/install/mac-os/), [Linux](https://docs.anaconda.com/anaconda/install/linux/)\n\n\n## Installation\n\n### Virtual Environment\nTo avoid potential dependency issues with other Python packages, we suggest creating a virtual environment for PySPEDAS; you can create a virtual environment in your terminal with:\n\n```bash\npython -m venv pyspedas\n```\n\nTo enter your virtual environment, run the 'activate' script:\n\n#### Windows\n\n```bash\n.\\pyspedas\\Scripts\\activate\n```\n\n#### macOS and Linux\n\n```bash\nsource pyspedas/bin/activate\n```\n\n#### Using Jupyter notebooks with your virtual environment\n\nTo get virtual environments working with Jupyter, in the virtual environment, type:\n\n```bash\npip install ipykernel\npython -m ipykernel install --user --name pyspedas --display-name \"Python (pySPEDAS)\"\n```\n\n(note: \"pyspedas\" is the name of your virtual environment)\n\nThen once you open the notebook, go to \"Kernel\" then \"Change kernel\" and select the one named \"Python (PySPEDAS)\"\n\n### Install\nPySPEDAS supports Windows, macOS and Linux. To get started, install the `pyspedas` package using PyPI:\n\n```bash\npip install pyspedas\n```\n\n### Upgrade\n\nTo upgrade to the latest version of PySPEDAS:\n\n```bash\npip install pyspedas --upgrade\n```\n\n\n## Local Data Directories\n\nThe recommended way of setting your local data directory is to set the `SPEDAS_DATA_DIR` environment variable. `SPEDAS_DATA_DIR` acts as a root data directory for all missions, and will also be used by IDL (if you\u2019re running a recent copy of the bleeding edge).\n\nMission specific data directories (e.g., `MMS_DATA_DIR` for MMS, `THM_DATA_DIR` for THEMIS) can also be set, and these will override `SPEDAS_DATA_DIR`\n\n\n## Usage\n\nTo get started, import pyspedas and pytplot:\n\n```python\nimport pyspedas\nfrom pytplot import tplot\n```\n\nYou can load data into tplot variables by calling `pyspedas.mission.instrument()`, e.g.,\n\nTo load and plot 1 day of THEMIS FGM data for probe 'd':\n```python\nthm_fgm = pyspedas.themis.fgm(trange=['2015-10-16', '2015-10-17'], probe='d')\n\ntplot(['thd_fgs_gse', 'thd_fgs_gsm'])\n```\n\nTo load and plot 2 minutes of MMS burst mode FGM data:\n```python\nmms_fgm = pyspedas.mms.fgm(trange=['2015-10-16/13:05:30', '2015-10-16/13:07:30'], data_rate='brst')\n\ntplot(['mms1_fgm_b_gse_brst_l2', 'mms1_fgm_b_gsm_brst_l2'])\n```\n\nNote: by default, PySPEDAS loads all data contained in CDFs found within the requested time range; this can potentially load data outside of your requested trange. To remove the data outside of your requested trange, set the `time_clip` keyword to `True`\n\nTo load and plot 6 hours of PSP SWEAP/SPAN-i data:\n```python\nspi_vars = pyspedas.psp.spi(trange=['2018-11-5', '2018-11-5/06:00'], time_clip=True)\n\ntplot(['DENS', 'VEL', 'T_TENSOR', 'TEMP'])\n```\n\nTo download 5 days of STEREO magnetometer data (but not load them into tplot variables):\n```python\nstereo_files = pyspedas.stereo.mag(trange=['2013-11-1', '2013-11-6'], downloadonly=True)\n```\n\n### Standard Options\n- `trange`: two-element list specifying the time range of interest. This keyword accepts a wide range of formats\n- `time_clip`: if set, clip the variables to the exact time range specified by the `trange` keyword\n- `suffix`: string specifying a suffix to append to the loaded variables\n- `varformat`: string specifying which CDF variables to load; accepts the wild cards * and ?\n- `varnames`: string specifying which CDF variables to load (exact names)\n- `get_support_data`: if set, load the support variables from the CDFs\n- `downloadonly`: if set, download the files but do not load them into tplot\n- `no_update`: if set, only load the data from the local cache\n- `notplot`: if set, load the variables into dictionaries containing numpy arrays (instead of creating the tplot variables)\n\n\n## Examples\nPlease see the following notebooks for examples of using PySPEDAS\n\n### PyTplot Basics\n- [Introduction to PyTplot](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Introduction_to_PyTplot.ipynb)\n\n### Loading Data\n- [MMS examples](https://github.com/spedas/mms-examples/tree/master/basic)\n- [THEMIS examples](https://github.com/spedas/themis-examples/tree/main/basic)\n- [Load data from HAPI servers](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PySPEDAS_loading_data_from_HAPI_servers.ipynb)\n- [Exploring the Heliosphere with Python](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Exploring_the_Heliosphere_with_Python.ipynb)\n\n### Plotting\n- [Annotations](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_annotations.ipynb)\n- [Range options](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_range_options.ipynb)\n- [Spectrogram options](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_spectrogram_options.ipynb)\n- [Legend options](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_legend_options.ipynb)\n- [Markers and symbols](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_markers_and_symbols.ipynb)\n- [Error bars](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_error_bars.ipynb)\n- [Pseudo variables](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_pseudo_variables.ipynb)\n- [Highlight intervals and vertical bars](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/PyTplot_highlight_intervals_and_vertical_bars.ipynb)\n\nAdditional examples of loading and plotting data can be found in the documentation for the project you're interested in ([PySPEDAS projects](https://pyspedas.readthedocs.io/en/latest/projects.html)), as well as the project's README file.\n\n### Dates and Times\n- [Working with dates and times](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Working_with_dates_and_times_with_PySPEDAS_PyTplot.ipynb)\n\n### Coordinate Transformations\n- [Coordinate transformations](https://github.com/spedas/pyspedas_examples/blob/master/pyspedas_examples/notebooks/Coordinate_transformations_with_OMNI_data.ipynb)\n- [Boundary normal (LMN) coordinates](https://github.com/spedas/mms-examples/blob/master/advanced/MMS_LMN_coordinate_transformation.ipynb)\n- [Quaternion transformations with SpacePy](https://github.com/spedas/mms-examples/blob/master/basic/MMS_quaternion_coordinate_transformations.ipynb)\n\n### Analysis\n- [Plasma calculations with PlasmaPy](https://github.com/spedas/mms-examples/blob/master/advanced/Plasma%20calculations%20with%20PlasmaPy.ipynb)\n- [Poynting flux with MMS data](https://github.com/spedas/mms-examples/blob/master/advanced/Poynting_flux_with_MMS_data.ipynb)\n- [Plasma beta with MMS data](https://github.com/spedas/mms-examples/blob/master/basic/Plasma%20Beta%20with%20FGM%20and%20FPI%20data.ipynb) (note: the PlasmaPy notebook above shows a much easier method)\n- [Curlometer calculations](https://github.com/spedas/mms-examples/blob/master/basic/Curlometer%20Technique.ipynb)\n- [Neutral sheet models](https://github.com/spedas/mms-examples/blob/master/advanced/MMS_neutral_sheet_models.ipynb)\n- [Wave polarization calculations](https://github.com/spedas/mms-examples/blob/master/advanced/Wave_polarization_using_SCM_data.ipynb)\n- [Dynamic power spectra calculations](https://github.com/spedas/mms-examples/blob/master/basic/Search-coil%20Magnetometer%20(SCM).ipynb)\n- [2D slices of MMS distribution functions](https://github.com/spedas/mms-examples/blob/master/advanced/Generate_2D_slices_of_FPI_and_HPCA_data.ipynb)\n- [Generating spectrograms and moments from MMS distribution functions](https://github.com/spedas/mms-examples/blob/master/advanced/Generate%20spectrograms%20and%20moments%20with%20mms_part_getspec.ipynb)\n\n\n## Documentation\nFor more information, please see our HTML documentation at:\n\nhttps://pyspedas.readthedocs.io/\n\n\n## Getting Help\nTo find the options supported, call `help` on the instrument function you're interested in:\n```python\nhelp(pyspedas.themis.fgm)\n```\n\nYou can ask questions by creating an issue or by joining the [SPEDAS mailing list](http://spedas.org/mailman/listinfo/spedas-list_spedas.org).\n\n\n## PyTplot\n\nPytplot is a separate project, that replicates the IDL \"tplot\" functionality. Pyspedas uses a modified version of pytplot with matplotlib as the plotting library.\n\n\n## Contributing\nWe welcome contributions to PySPEDAS; to learn how you can contribute, please see our [Contributing Guide](https://github.com/spedas/pyspedas/blob/master/CONTRIBUTING.md)\n\n\n## Plug-in Development\nAn introduction to PySPEDAS plug-in development can be found here:\n\n[Introduction to PySPEDAS plug-in development](https://github.com/spedas/pyspedas/tree/master/docs/pyspedas_plugin_development.pdf)\n\n\n## Code of Conduct\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. To learn more, please see our [Code of Conduct](https://github.com/spedas/pyspedas/blob/master/CODE_OF_CONDUCT.md).\n\n\n## Additional Information\n\nFor examples of pyspedas, see: https://github.com/spedas/pyspedas_examples\n\nFor MMS examples, see: https://github.com/spedas/mms-examples\n\nFor pytplot (matplotlib version), see: https://github.com/MAVENSDC/PyTplot/tree/matplotlib-backend\n\nFor cdflib, see: https://github.com/MAVENSDC/cdflib\n\nFor SPEDAS, see http://spedas.org/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Space Physics Environment Data Analysis Software (pySPEDAS)",
"version": "1.7.1",
"project_urls": {
"Documentation": "https://pyspedas.readthedocs.io",
"Homepage": "https://github.com/spedas/pyspedas",
"Information": "https://spedas.org/wiki/",
"Issue_Tracker": "https://github.com/spedas/pyspedas/issues",
"Source_Code": "https://github.com/spedas/pyspedas"
},
"split_keywords": [
"spedas",
" data",
" tools",
" space physics",
" data analysis",
" space science",
" scientific computing",
" time series analysis",
" data visualization",
" satellite data",
" magnetosphere",
" ionosphere",
" heliophysics",
" geophysics",
" remote sensing",
" astrophysics",
" solar physics",
" space weather",
" data retrieval",
" nasa",
" noaa",
" esa",
" jaxa",
" hso",
" cdf",
" istp",
" netcdf",
" python package",
" themis",
" artemis",
" mms",
" erg",
" arase",
" ace",
" maven",
" rbsp",
" van allen probes",
" goes",
" poes",
" cluster",
" omniweb",
" aurora",
" geomagnetic index",
" kp index",
" ae index",
" magnetic field models",
" tsyganenko",
" igrf",
" geopack",
" magnetotelluric"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a79b37204db9096431fc7b540da45d0c27227dac6ee03deb3472888c9e24c1c0",
"md5": "6251845f2637a70aa3ac5fa84e5f4e01",
"sha256": "02622936873ff708ee16aa20e122ae842c8b5fa68afb619f62a1e1617f186013"
},
"downloads": -1,
"filename": "pyspedas-1.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6251845f2637a70aa3ac5fa84e5f4e01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1489553,
"upload_time": "2024-12-02T22:19:01",
"upload_time_iso_8601": "2024-12-02T22:19:01.435019Z",
"url": "https://files.pythonhosted.org/packages/a7/9b/37204db9096431fc7b540da45d0c27227dac6ee03deb3472888c9e24c1c0/pyspedas-1.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cba1459d1f92aeba0d560972bc80aafcd49487266aabf276a296a7196d2389ef",
"md5": "36880eed3d8e8ee2a2573f0030dd9e24",
"sha256": "47426928775771cfdba0850c3a5cbb2d77da964a148a7a59dca1292da5fcb829"
},
"downloads": -1,
"filename": "pyspedas-1.7.1.tar.gz",
"has_sig": false,
"md5_digest": "36880eed3d8e8ee2a2573f0030dd9e24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1060436,
"upload_time": "2024-12-02T22:19:05",
"upload_time_iso_8601": "2024-12-02T22:19:05.257924Z",
"url": "https://files.pythonhosted.org/packages/cb/a1/459d1f92aeba0d560972bc80aafcd49487266aabf276a296a7196d2389ef/pyspedas-1.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 22:19:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spedas",
"github_project": "pyspedas",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.20.0"
]
]
},
{
"name": "requests",
"specs": []
},
{
"name": "cdflib",
"specs": []
},
{
"name": "pytplot-mpl-temp",
"specs": [
[
">=",
"2.2.50"
]
]
},
{
"name": "cdasws",
"specs": [
[
">=",
"1.7.24"
]
]
},
{
"name": "netCDF4",
"specs": []
},
{
"name": "pywavelets",
"specs": []
},
{
"name": "astropy",
"specs": []
},
{
"name": "geopack",
"specs": [
[
">=",
"1.0.11"
]
]
},
{
"name": "scipy",
"specs": []
},
{
"name": "hapiclient",
"specs": [
[
">=",
"0.2.2"
]
]
},
{
"name": "viresclient",
"specs": []
}
],
"lcname": "pyspedas"
}
JSON
