Skip to content

Commit

Permalink
Use pyspedas 2.0 style imports for examples, documentation, and inter…
Browse files Browse the repository at this point in the history 
…nal calls
  • Loading branch information
@jameswilburlewis
jameswilburlewis committed Nov 17, 2024
1 parent 7f43c2d commit d74fde2
Show file tree
Hide file tree
Showing 288 changed files with 1,669 additions and 1,629 deletions.
32 changes: 16 additions & 16 deletions docs/source/ace.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The routines in this module can be used to load data from the Advanced Compositi

Magnetometer (MFI)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.mfi
.. autofunction:: pyspedas.projects.ace.mfi

Example
^^^^^^^^^
Expand All @@ -14,7 +14,7 @@ Example
import pyspedas
from pytplot import tplot
mfi_vars = pyspedas.ace.mfi(trange=['2018-11-5', '2018-11-6'])
mfi_vars = pyspedas.projects.ace.mfi(trange=['2018-11-5', '2018-11-6'])
tplot(['BGSEc', 'Magnitude'])
.. image:: _static/ace_mfi.png
Expand All @@ -26,7 +26,7 @@ Example

Solar Wind Electron, Proton and Alpha Monitor (SWEPAM)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.swe
.. autofunction:: pyspedas.projects.ace.swe

Example
^^^^^^^^^
Expand All @@ -35,7 +35,7 @@ Example
import pyspedas
from pytplot import tplot
swe_vars = pyspedas.ace.swe(trange=['2018-11-5', '2018-11-6'])
swe_vars = pyspedas.projects.ace.swe(trange=['2018-11-5', '2018-11-6'])
tplot(['Vp', 'Tpr'])
.. image:: _static/ace_swe.png
Expand All @@ -47,7 +47,7 @@ Example

Electron, Proton, and Alpha-particle Monitor (EPAM)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.epam
.. autofunction:: pyspedas.projects.ace.epam

Example
^^^^^^^^^
Expand All @@ -56,7 +56,7 @@ Example
import pyspedas
from pytplot import tplot
epam_vars = pyspedas.ace.epam(trange=['2018-11-5', '2018-11-6'])
epam_vars = pyspedas.projects.ace.epam(trange=['2018-11-5', '2018-11-6'])
tplot(['H_lo', 'Ion_very_lo', 'Ion_lo', 'Ion_mid', 'Ion_hi', 'Electron_lo', 'Electron_hi'])
.. image:: _static/ace_epam.png
Expand All @@ -68,7 +68,7 @@ Example

Cosmic Ray Isotope Spectrometer (CRIS)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.cris
.. autofunction:: pyspedas.projects.ace.cris

Example
^^^^^^^^^
Expand All @@ -77,7 +77,7 @@ Example
import pyspedas
from pytplot import tplot
cris_vars = pyspedas.ace.cris(trange=['2018-11-5', '2018-11-6'])
cris_vars = pyspedas.projects.ace.cris(trange=['2018-11-5', '2018-11-6'])
tplot(['flux_B', 'flux_C', 'flux_N', 'flux_O', 'flux_F', 'flux_Ne'])
.. image:: _static/ace_cris.png
Expand All @@ -89,7 +89,7 @@ Example

Solar Isotope Spectrometer (SIS)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.sis
.. autofunction:: pyspedas.projects.ace.sis

Example
^^^^^^^^^
Expand All @@ -98,7 +98,7 @@ Example
import pyspedas
from pytplot import tplot
sis_vars = pyspedas.ace.sis(trange=['2018-11-5', '2018-11-6'])
sis_vars = pyspedas.projects.ace.sis(trange=['2018-11-5', '2018-11-6'])
tplot(['H_lo', 'H_hi', 'CNO_lo', 'CNO_hi', 'Z_ge_10'])
.. image:: _static/ace_sis.png
Expand All @@ -110,7 +110,7 @@ Example

Ultra Low Energy Isotope Spectrometer (ULEIS)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.uleis
.. autofunction:: pyspedas.projects.ace.uleis

Example
^^^^^^^^^
Expand All @@ -119,7 +119,7 @@ Example
import pyspedas
from pytplot import tplot
uleis_vars = pyspedas.ace.uleis(trange=['2018-11-5', '2018-11-6'])
uleis_vars = pyspedas.projects.ace.uleis(trange=['2018-11-5', '2018-11-6'])
tplot(['H_S1', 'H_S2', 'H_S3', 'H_S4', 'H_S5'])
.. image:: _static/ace_uleis.png
Expand All @@ -131,7 +131,7 @@ Example

Solar Energetic Particle Ionic Charge Analyzer (SEPICA)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.sepica
.. autofunction:: pyspedas.projects.ace.sepica

Example
^^^^^^^^^
Expand All @@ -140,7 +140,7 @@ Example
import pyspedas
from pytplot import tplot
sepica_vars = pyspedas.ace.sepica(trange=['2004-11-5', '2004-11-6'])
sepica_vars = pyspedas.projects.ace.sepica(trange=['2004-11-5', '2004-11-6'])
tplot(['H1', 'H2', 'H3'])
.. image:: _static/ace_sepica.png
Expand All @@ -152,7 +152,7 @@ Example

Solar Wind Ion Composition Spectrometer (SWICS)
----------------------------------------------------------
.. autofunction:: pyspedas.ace.swics
.. autofunction:: pyspedas.projects.ace.swics

Example
^^^^^^^^^
Expand All @@ -161,7 +161,7 @@ Example
import pyspedas
from pytplot import tplot
swi_vars = pyspedas.ace.swics(trange=['2018-11-5', '2018-11-6'])
swi_vars = pyspedas.projects.ace.swics(trange=['2018-11-5', '2018-11-6'])
tplot(['vHe2', 'vthHe2'])
.. image:: _static/ace_swics.png
Expand Down
12 changes: 6 additions & 6 deletions docs/source/akebono.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The routines in this module can be used to load data from the Akebono mission.

Plasma Waves and Sounder experiment (PWS)
----------------------------------------------------------
.. autofunction:: pyspedas.akebono.pws
.. autofunction:: pyspedas.projects.akebono.pws

Example
^^^^^^^^^
Expand All @@ -14,7 +14,7 @@ Example
import pyspedas
from pytplot import tplot
pws_vars = pyspedas.akebono.pws(trange=['2012-10-01', '2012-10-02'])
pws_vars = pyspedas.projects.akebono.pws(trange=['2012-10-01', '2012-10-02'])
tplot('akb_pws_RX1')
.. image:: _static/akebono_pws.png
Expand All @@ -24,7 +24,7 @@ Example

Radiation Moniter (RDM)
----------------------------------------------------------
.. autofunction:: pyspedas.akebono.rdm
.. autofunction:: pyspedas.projects.akebono.rdm

Example
^^^^^^^^^
Expand All @@ -33,7 +33,7 @@ Example
import pyspedas
from pytplot import tplot
rdm_vars = pyspedas.akebono.rdm(trange=['2012-10-01', '2012-10-02'])
rdm_vars = pyspedas.projects.akebono.rdm(trange=['2012-10-01', '2012-10-02'])
tplot('akb_rdm_FEIO')
.. image:: _static/akebono_rdm.png
Expand All @@ -43,7 +43,7 @@ Example

Orbit data (orb)
----------------------------------------------------------
.. autofunction:: pyspedas.akebono.orb
.. autofunction:: pyspedas.projects.akebono.orb

Example
^^^^^^^^^
Expand All @@ -52,7 +52,7 @@ Example
import pyspedas
from pytplot import tplot
orb_vars = pyspedas.akebono.orb(trange=['2012-10-01', '2012-10-02'])
orb_vars = pyspedas.projects.akebono.orb(trange=['2012-10-01', '2012-10-02'])
tplot(['akb_orb_geo', 'akb_orb_MLT'])
.. image:: _static/akebono_orb.png
Expand Down
14 changes: 7 additions & 7 deletions docs/source/analysis.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ plasma moments and plot 1D or 2D slices through the distributions.
mms_part_getspec
^^^^^^^^^^^^^^^^

.. autofunction:: pyspedas.mms.mms_part_getspec
.. autofunction:: pyspedas.projects.mms.mms_part_getspec

mms_part_slice2d
^^^^^^^^^^^^^^^^

.. autofunction:: pyspedas.mms.mms_part_slice2d
.. autofunction:: pyspedas.projects.mms.mms_part_slice2d

ERG (Arase) particle distribution tools
---------------------------------------
Expand All @@ -101,7 +101,7 @@ These routines operate on Arase 3-D particle distributions.
erg_mep_part_products
^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: pyspedas.erg.erg_mep_part_products
.. autofunction:: pyspedas.projects.erg.erg_mep_part_products

Example
^^^^^^^
Expand All @@ -110,12 +110,12 @@ Example
import pytplot
import pyspedas
from pyspedas.erg import erg_mep_part_products
from pyspedas.projects.erg import erg_mep_part_products
from pytplot import timespan, tplot
timespan('2017-04-05 21:45:00', 2.25, keyword='hours')
pyspedas.erg.mepe( trange=[ '2017-04-05 21:45:00', '2017-04-05 23:59:59'], datatype='3dflux' )
vars = pyspedas.erg.mgf(trange=['2017-04-05 21:45:00', '2017-04-05 23:59:59']) # Load necessary B-field data
vars = pyspedas.erg.orb(trange=['2017-04-05 21:45:00', '2017-04-05 23:59:59']) # Load necessary orbit data
pyspedas.projects.erg.mepe( trange=[ '2017-04-05 21:45:00', '2017-04-05 23:59:59'], datatype='3dflux' )
vars = pyspedas.projects.erg.mgf(trange=['2017-04-05 21:45:00', '2017-04-05 23:59:59']) # Load necessary B-field data
vars = pyspedas.projects.erg.orb(trange=['2017-04-05 21:45:00', '2017-04-05 23:59:59']) # Load necessary orbit data
mag_vn = 'erg_mgf_l2_mag_8sec_dsi'
pos_vn = 'erg_orb_l2_pos_gse'
# Calculate energy-time spectra of electron flux for limited pitch-angle (PA) ranges
Expand Down
16 changes: 8 additions & 8 deletions docs/source/barrel.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Data can be loaded using the wrapper functions for each data type:
import pyspedas
from pytplot import tplot
sspc_vars = pyspedas.barrel.sspc(probe='1A', trange= ['2013-01-28', '2013-02-14'])
sspc_vars = pyspedas.projects.barrel.sspc(probe='1A', trange= ['2013-01-28', '2013-02-14'])
tplot('brl1A_SSPC')
Expand All @@ -101,16 +101,16 @@ Full example notebooks available at https://github.com/spedas/pyspedas_examples
Load Routines
--------------

.. autofunction:: pyspedas.barrel.sspc
.. autofunction:: pyspedas.projects.barrel.sspc

.. autofunction:: pyspedas.barrel.mspc
.. autofunction:: pyspedas.projects.barrel.mspc

.. autofunction:: pyspedas.barrel.fspc
.. autofunction:: pyspedas.projects.barrel.fspc

.. autofunction:: pyspedas.barrel.magn
.. autofunction:: pyspedas.projects.barrel.magn

.. autofunction:: pyspedas.barrel.ephm
.. autofunction:: pyspedas.projects.barrel.ephm

.. autofunction:: pyspedas.barrel.rcnt
.. autofunction:: pyspedas.projects.barrel.rcnt

.. autofunction:: pyspedas.barrel.hkpg
.. autofunction:: pyspedas.projects.barrel.hkpg
Loading

0 comments on commit d74fde2

Please sign in to comment.