Skip to content

Commit

Permalink
Added documentation for additional ERG spacecraft load routines
Browse files Browse the repository at this point in the history
  • Loading branch information
@jameswilburlewis
jameswilburlewis committed Feb 1, 2024
1 parent 7096922 commit b04537c
Showing 1 changed file with 155 additions and 44 deletions.
199 changes: 155 additions & 44 deletions docs/source/erg.rst
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
Arase (ERG)
====================================
The routines in this module can be used to load data from the Arase mission.
The routines in this module can be used to load data from the Arase mission, as well as several other ground-based datasets made available by
the ERG Science Center: https://ergsc.isee.nagoya-u.jp

Magnetic Field Experiment (MGF)
--------------------------------
.. autofunction:: pyspedas.erg.mgf
Attitude Data
-------------
.. autofunction:: pyspedas.erg.att
Example
^^^^^^^^^

.. code-block:: python
import pyspedas
from pytplot import tplot
att_vars = pyspedas.erg.att(trange=['2017-04-01', '2017-04-02'])
tplot(['erg_att_sprate', 'erg_att_spphase', 'erg_att_izras', 'erg_att_izdec', 'erg_att_gxras', 'erg_att_gxdec', 'erg_att_gzras', 'erg_att_gzdec'])
.. image:: _static/erg_att.png
:align: center
:class: imgborder

High-energy Particles – electrons (HEP-e)
------------------------------------------------
.. autofunction:: pyspedas.erg.hep

Example
^^^^^^^^^
Expand All @@ -13,42 +32,45 @@ Example
import pyspedas
from pytplot import tplot
pyspedas.erg.mgf(trange=['2017-03-27', '2017-03-28'])
tplot('erg_mgf_l2_mag_8sec_sm')
pyspedas.erg.hep(trange=['2017-03-27', '2017-03-28'])
tplot(['erg_hep_l2_FEDO_L', 'erg_hep_l2_FEDO_H'])
.. image:: _static/erg_mgf.png
.. image:: _static/erg_hep.png
:align: center
:class: imgborder


Extremely High-energy electrons (XEP-e)

Low-energy Particles – electrons (LEP-e)
------------------------------------------------
.. autofunction:: pyspedas.erg.xep
.. autofunction:: pyspedas.erg.lepe

.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.xep(trange=['2017-03-27', '2017-03-28'])
tplot('erg_xep_l2_FEDO_SSD')
pyspedas.erg.lepe(trange=['2017-03-27', '2017-03-28'])
tplot('erg_lepe_l2_omniflux_FEDO')
.. image:: _static/erg_xep.png
.. image:: _static/erg_lepe.png
:align: center
:class: imgborder


High-energy Particles – electrons (HEP-e)
Low-energy Particles – ion (LEP-i)
------------------------------------------------
.. autofunction:: pyspedas.erg.hep
.. autofunction:: pyspedas.erg.lepi

Example
^^^^^^^^^
.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.hep(trange=['2017-03-27', '2017-03-28'])
tplot(['erg_hep_l2_FEDO_L', 'erg_hep_l2_FEDO_H'])
.. image:: _static/erg_hep.png
lepi_vars = pyspedas.erg.lepi(trange=['2017-03-27', '2017-03-28'])
tplot('erg_lepi_l2_omniflux_FODO')
.. image:: _static/erg_lepi.png
:align: center
:class: imgborder

Expand All @@ -69,60 +91,116 @@ Medium-energy Particles - electrons (MEP-e)
:class: imgborder


Low-energy Particles – electrons (LEP-e)
Medium-energy Particles – "normal mode" ion (MEP-i)
------------------------------------------------
.. autofunction:: pyspedas.erg.lepe
.. autofunction:: pyspedas.erg.mepi_nml

.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.lepe(trange=['2017-03-27', '2017-03-28'])
tplot('erg_lepe_l2_omniflux_FEDO')
pyspedas.erg.mepi_nml(trange=['2017-03-27', '2017-03-28'])
tplot('erg_mepi_l2_omniflux_FODO')
.. image:: _static/erg_lepe.png
.. image:: _static/erg_mepi_nml.png
:align: center
:class: imgborder


Medium-energy Particles – ion (MEP-i)
------------------------------------------------
.. autofunction:: pyspedas.erg.mepi_nml

Medium-energy Particles - "time of flight mode" ion (MEP-i)
.. autofunction:: pyspedas.erg.mepi_tof
.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.mepi_nml(trange=['2017-03-27', '2017-03-28'])
tplot('erg_mepi_l2_omniflux_FODO')
.. image:: _static/erg_mepi_nml.png
.. image:: _static/erg_mepi_tof.png
:align: center
:class: imgborder

.. autofunction:: pyspedas.erg.mepi_tof
Magnetic Field Experiment (MGF)
--------------------------------
.. autofunction:: pyspedas.erg.mgf

Example
^^^^^^^^^

.. code-block:: python
Low-energy Particles – ion (LEP-i)
------------------------------------------------
.. autofunction:: pyspedas.erg.lepi
import pyspedas
from pytplot import tplot
pyspedas.erg.mgf(trange=['2017-03-27', '2017-03-28'])
tplot('erg_mgf_l2_mag_8sec_sm')
.. image:: _static/erg_mgf.png
:align: center
:class: imgborder

Orbit data (ORB)
--------------------------------
.. autofunction:: pyspedas.erg.orb

Example
^^^^^^^^^

.. code-block:: python
Plasma Wave Experiment (PWE)
import pyspedas
from pytplot import tplot
orb_vars = pyspedas.erg.orb(trange=['2017-03-27', '2017-03-28'])
tplot('erg_orb_l2_pos_gse')
.. image:: _static/erg_orb.png
:align: center
:class: imgborder


Orbit data
------------------------------------------------
.. autofunction:: pyspedas.erg.pwe_ofa
.. autofunction:: pyspedas.erg.orb
Example
^^^^^^^^^

.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.pwe_ofa(trange=['2017-03-27', '2017-03-28'])
tplot('erg_pwe_ofa_l2_spec_E_spectra_132')
pyspedas.erg.orb(trange=['2017-03-27', '2017-03-28'])
tplot(['erg_orb_l2_pos_gsm', 'erg_orb_l2_vel_gsm'])
.. image:: _static/erg_pwe_ofa.png
.. image:: _static/erg_orb.png
:align: center
:class: imgborder

Plasma Wave Experiment - Electric Field Detector (PWE-EFD)
--------------------------------------------------------------

.. autofunction:: pyspedas.erg.pwe_efd
Example
^^^^^^^^^

.. code-block:: python
import pyspedas
from pytplot import tplot
pwe_efd_vars = pyspedas.erg.pwe_efd(trange=['2017-03-27', '2017-03-28'])
tplot('erg_pwe_efd_l2_E_spin_Eu_dsi')
.. image:: _static/erg_pwe_efd.png
:align: center
:class: imgborder



Plasma Wave Experiment - High Frequency Analyzer (PWE-HFA)
--------------------------------------------------------------

.. autofunction:: pyspedas.erg.pwe_hfa
Example
^^^^^^^^^

.. code-block:: python
Expand All @@ -135,19 +213,52 @@ Plasma Wave Experiment (PWE)
:align: center
:class: imgborder

.. autofunction:: pyspedas.erg.pwe_efd
Plasma Wave Experiment - Onboard Frequency Analyzer (PWE-OFA)
--------------------------------------------------------------
.. autofunction:: pyspedas.erg.pwe_ofa
Example
^^^^^^^^^

Orbit data
.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.pwe_ofa(trange=['2017-03-27', '2017-03-28'])
tplot('erg_pwe_ofa_l2_spec_E_spectra_132')
.. image:: _static/erg_pwe_ofa.png
:align: center
:class: imgborder

Plasma Wave Experiment - Waveform Capture (PWE-WFC)
--------------------------------------------------------------
.. autofunction:: pyspedas.erg.pwe_wfc
Example
^^^^^^^^^

.. code-block:: python
import pyspedas
from pytplot import tplot
pwe_wfc_vars = pyspedas.erg.pwe_wfc(trange=['2017-04-01/12:00:00', '2017-04-01/13:00:00'])
tplot('erg_pwe_wfc_l2_e_65khz_Ex_waveform')
.. image:: _static/erg_pwe_wfc.png
:align: center
:class: imgborder

Extremely High-energy electrons (XEP-e)
------------------------------------------------
.. autofunction:: pyspedas.erg.orb
.. autofunction:: pyspedas.erg.xep

.. code-block:: python
import pyspedas
from pytplot import tplot
pyspedas.erg.orb(trange=['2017-03-27', '2017-03-28'])
tplot(['erg_orb_l2_pos_gsm', 'erg_orb_l2_vel_gsm'])
pyspedas.erg.xep(trange=['2017-03-27', '2017-03-28'])
tplot('erg_xep_l2_FEDO_SSD')
.. image:: _static/erg_orb.png
.. image:: _static/erg_xep.png
:align: center
:class: imgborder

0 comments on commit b04537c

Please sign in to comment.