.. PySPEDAS documentation master file, created by
   sphinx-quickstart on Fri Sep 10 21:11:38 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:tocdepth: 3

PySPEDAS Documentation
====================================
|build| |coverage| |version| |quality| |status| |license|

PySPEDAS is an implementation of the Space Physics Environment Data Analysis Software (SPEDAS) framework in Python.

The SPEDAS framework is written in IDL and contains data loading, data analysis and data plotting tools for various scientific missions (NASA, NOAA, etc.) and ground magnetometers.

PySPEDAS makes creating multi-mission, multi-instrument figures simple, e.g., to create a figure showing magnetometer data from `Solar Orbiter <https://pyspedas.readthedocs.io/en/latest/solo.html>`_, `Parker Solar Probe <https://pyspedas.readthedocs.io/en/latest/psp.html>`_, `MMS <https://pyspedas.readthedocs.io/en/latest/mms.html>`_, and `THEMIS <https://pyspedas.readthedocs.io/en/latest/themis.html>`_,

.. code-block:: python
   
   import pyspedas
   from pyspedas import tplot

   time_range = ['2020-04-20/06:00', '2020-04-20/08:00']

   pyspedas.projects.solo.mag(trange=time_range, time_clip=True)
   pyspedas.projects.psp.fields(trange=time_range, time_clip=True)
   pyspedas.projects.mms.fgm(trange=time_range, time_clip=True, probe=2)
   pyspedas.projects.themis.fgm(trange=time_range, time_clip=True, probe='d')

   tplot(['B_RTN', 'psp_fld_l2_mag_RTN', 'mms2_fgm_b_gsm_srvy_l2_bvec', 'thd_fgs_gsm'])

.. figure:: _static/solo-psp-mms-themis.png
   :align: center
   :class: imgborder



.. toctree::
   :caption: First Steps
   :maxdepth: 1

   getting_started
   examples_and_tutorials
   getting_help

.. toctree::
   :maxdepth: 1
   :caption: Features

   projects
   analysis
   cdaweb
   hapi
   vires
   geopack
   coords
   utilities
   mission_specific_tools
   plotting
   contributing


.. toctree::
   :caption: Updating older code to PySPEDAS 2.0+
   :maxdepth: 1

   pyspedas_2_migration

.. toctree::
   :caption: For PySPEDAS developers and admins
   :maxdepth: 1

   devguide
   dev_pycharm
   dev_vscode
   adminguide


.. |build| image:: https://github.com/spedas/pyspedas/workflows/build/badge.svg
.. |coverage| image:: https://coveralls.io/repos/github/spedas/pyspedas/badge.svg
.. |version| image:: https://img.shields.io/pypi/v/pyspedas.svg
.. |quality| image:: https://img.shields.io/lgtm/grade/python/g/spedas/pyspedas.svg?logo=lgtm&logoWidth=18
.. |status| image:: https://img.shields.io/pypi/status/pyspedas.svg
.. |license| image:: https://img.shields.io/pypi/l/pyspedas.svg