Akebono

The routines in this module can be used to load data from the Akebono mission.

Plasma Waves and Sounder experiment (PWS)

pyspedas.akebono.pws(trange=['2012-10-01', '2012-10-02'], datatype='ne', level='h1', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)[source]

This function loads data from the ACE Plasma Waves and Sounder experiment (PWS)

Parameters:
  • trange (list of str) – time range of interest [starttime, endtime] with the format ‘YYYY-MM-DD’,’YYYY-MM-DD’] or to specify more or less than a day [‘YYYY-MM-DD/hh:mm:ss’,’YYYY-MM-DD/hh:mm:ss’] Default: [‘2012-10-01’, ‘2012-10-02’]

  • datatype (str) –

    Data type; Valid options:

    ‘ne’, ‘npw-ds’, ‘npw-py’, ‘spw’

    Default: ‘ne’

  • level (str) – Data level; options: ‘h1’ (default: h1) Default: ‘h1’

  • suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added. Default: ‘’

  • get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. By default, only loads in data with a “VAR_TYPE” attribute of “data”. Default: False

  • varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in. Default: None

  • varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded) Default: []

  • downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables Default: False

  • notplot (bool) – Return the data in hash tables instead of creating tplot variables Default: False

  • no_update (bool) – If set, only load data from your local cache Default: False

  • time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword Default: False

Return type:

List of tplot variables created.

Example:

>>> import pyspedas
>>> from pytplot import tplot
>>> pws_vars = pyspedas.akebono.pws(trange=['2012-10-01', '2012-10-02'])
>>> tplot(['akb_pws_RX1', 'akb_pws_RX2'])

Example

import pyspedas
from pytplot import tplot
pws_vars = pyspedas.akebono.pws(trange=['2012-10-01', '2012-10-02'])
tplot('akb_pws_RX1')
_images/akebono_pws.png

Radiation Moniter (RDM)

pyspedas.akebono.rdm(trange=['2012-10-01', '2012-10-02'], suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)[source]

This function loads data from the ACE Radiation Moniter (RDM)

Parameters:
  • trange (list of str) – time range of interest [starttime, endtime] with the format ‘YYYY-MM-DD’,’YYYY-MM-DD’] or to specify more or less than a day [‘YYYY-MM-DD/hh:mm:ss’,’YYYY-MM-DD/hh:mm:ss’] Default: [‘2012-10-01’, ‘2012-10-02’]

  • suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added. Default: ‘’

  • get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. By default, only loads in data with a “VAR_TYPE” attribute of “data”. Default: False

  • varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in. Default: None

  • varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded) Default: []

  • downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables Default: False

  • notplot (bool) – Return the data in hash tables instead of creating tplot variables Default: False

  • no_update (bool) – If set, only load data from your local cache Default: False

  • time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword Default: False

Return type:

List of tplot variables created.

Example:

>>> import pyspedas
>>> from pytplot import tplot
>>> rdm_vars = pyspedas.akebono.rdm(trange=['2012-10-01', '2012-10-02'])
>>> tplot('akb_rdm_FEIO')

Example

import pyspedas
from pytplot import tplot
rdm_vars = pyspedas.akebono.rdm(trange=['2012-10-01', '2012-10-02'])
tplot('akb_rdm_FEIO')
_images/akebono_rdm.png

Orbit data (orb)

pyspedas.akebono.orb(trange=['2012-10-01', '2012-10-02'], suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)[source]

This function loads data from the ACE Akebono orbit data (orb)

Parameters:
  • trange (list of str) – time range of interest [starttime, endtime] with the format ‘YYYY-MM-DD’,’YYYY-MM-DD’] or to specify more or less than a day [‘YYYY-MM-DD/hh:mm:ss’,’YYYY-MM-DD/hh:mm:ss’] Default: [‘2012-10-01’, ‘2012-10-02’]

  • suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added. Default: ‘’

  • get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. By default, only loads in data with a “VAR_TYPE” attribute of “data”. Default: False

  • varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in. Default: None

  • varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded) Default: []

  • downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables Default: False

  • notplot (bool) – Return the data in hash tables instead of creating tplot variables Default: False

  • no_update (bool) – If set, only load data from your local cache Default: False

  • time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword Default: False

Return type:

List of tplot variables created.

Example:

>>> import pyspedas
>>> from pytplot import tplot
>>> orb_vars = pyspedas.akebono.orb(trange=['2012-10-01', '2012-10-02'])
>>> tplot(['akb_orb_geo', 'akb_orb_MLT'])

Example

import pyspedas
from pytplot import tplot
orb_vars = pyspedas.akebono.orb(trange=['2012-10-01', '2012-10-02'])
tplot(['akb_orb_geo', 'akb_orb_MLT'])
_images/akebono_orb.png