Van Allen Probes (RBSP)

The routines in this module can be used to load data from the Van Allen Probes (RBSP) mission.

Electric and Magnetic Field Instrument Suite and Integrated Science (EMFISIS)

pyspedas.rbsp.emfisis(trange=['2018-11-5', '2018-11-6'], probe='a', datatype='magnetometer', level='l3', cadence='4sec', coord='sm', wavetype='waveform', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Electric and Magnetic Field Instrument Suite and Integrated Science (EMFISIS) instrument

For information on the EMFISIS data products, see:: https://emfisis.physics.uiowa.edu/data/level_descriptions

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
cadence (str) – Data cadence (default: 4sec); other options: ‘1sec’, ‘hires’
coord (str) – Data coordinate system (default: sm)
level (str) – Data level; options: ‘l1’, ‘l2’, ‘l3’, l4’
datatype (str) – Data type; valid options: Level 1:

‘magnetometer’ ‘hfr’ ‘housekeeping’ ‘sc-hk’ ‘spaceweather’ ‘wfr’ ‘wna’

Level 2:
‘magnetometer’ ‘wfr’ ‘hfr’ ‘housekeeping’

Level 3:
‘magnetometer’

Level 4:
‘density’ ‘wna-survey’
wavetype (str) –

Type of level 2 waveform data; valid options:
For WFR data: ‘waveform’ (default) ‘waveform-continuous-burst’ ‘spectral-matrix’ ‘spectral-matrix-diagonal’ ‘spectral-matrix-diagonal-merged’

For HFR data: ‘waveform’ ‘spectra’ ‘spectra-burst’ ‘spectra-merged’

For descriptions of these data, see:
https://emfisis.physics.uiowa.edu/data/L2_products
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
emfisis_vars = pyspedas.rbsp.emfisis(trange=['2018-11-5/10:00', '2018-11-5/15:00'], datatype='magnetometer', level='l3', time_clip=True)
tplot(['Mag', 'Magnitude'])

Electric Field and Waves Suite (EFW)

pyspedas.rbsp.efw(trange=['2015-11-5', '2015-11-6'], probe='a', datatype='spec', level='l3', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Electric Field and Waves Suite (EFW)

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
datatype (str) – Data type; Valid options:
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
efw_vars = pyspedas.rbsp.efw(trange=['2015-11-5', '2015-11-6'], level='l3')
tplot(['efield_in_inertial_frame_spinfit_mgse', 'spacecraft_potential'])

Radiation Belt Storm Probes Ion Composition Experiment (RBSPICE)

pyspedas.rbsp.rbspice(trange=['2018-11-5', '2018-11-6'], probe='a', datatype='TOFxEH', level='l3', suffix='', get_support_data=True, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Radiation Belt Storm Probes Ion Composition Experiment (RBSPICE) instrument

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
datatype (str) – Data type (default: tofxeh); Valid options:
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
rbspice_vars = pyspedas.rbsp.rbspice(trange=['2018-11-5', '2018-11-6'], datatype='TOFxEH', level='l3')
tplot('rbspa_rbspice_l3_TOFxEH_proton_omni_spin')
# calculate the pitch angle distributions
from pyspedas.rbsp.rbspice_lib.rbsp_rbspice_pad import rbsp_rbspice_pad
rbsp_rbspice_pad(probe='a', datatype='TOFxEH', level='l3')
tplot(['rbspa_rbspice_l3_TOFxEH_proton_omni_spin',
       'rbspa_rbspice_l3_TOFxEH_proton_omni_0-1000keV_pad_spin'])

Energetic Particle, Composition, and Thermal Plasma Suite (ECT) - MagEIS

pyspedas.rbsp.mageis(trange=['2015-11-5', '2015-11-6'], probe='a', datatype='', level='l3', rel='rel04', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Energetic Particle, Composition, and Thermal Plasma Suite (ECT)

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
datatype (str) – Data type; Valid options:
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
mageis_vars = pyspedas.rbsp.mageis(trange=['2018-11-5', '2018-11-6'], level='l3', rel='rel04')
tplot('I')

Energetic Particle, Composition, and Thermal Plasma Suite (ECT) - HOPE

pyspedas.rbsp.hope(trange=['2015-11-5', '2015-11-6'], probe='a', datatype='moments', level='l3', rel='rel04', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Energetic Particle, Composition, and Thermal Plasma Suite (ECT)

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
datatype (str) – Data type; Valid options:
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
hope_vars = pyspedas.rbsp.hope(trange=['2018-11-5', '2018-11-6'], datatype='moments', level='l3', rel='rel04')
tplot('Ion_density')

Energetic Particle, Composition, and Thermal Plasma Suite (ECT) - REPT

pyspedas.rbsp.rept(trange=['2015-11-5', '2015-11-6'], probe='a', datatype='', level='l3', rel='rel03', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Energetic Particle, Composition, and Thermal Plasma Suite (ECT)

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
datatype (str) – Data type; Valid options:
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
rept_vars = pyspedas.rbsp.rept(trange=['2018-11-5', '2018-11-6'], level='l3', rel='rel03')
tplot('Tperp_e_200')

Relativistic Proton Spectrometer (RPS)

pyspedas.rbsp.rps(trange=['2015-11-5', '2015-11-6'], probe='a', datatype='rps-1min', level='l2', suffix='', get_support_data=True, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the Relativistic Proton Spectrometer (RPS)

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’]
probe (str or list of str) – Spacecraft probe name (‘a’ or ‘b’); default: a
datatype (str) – Data type; Valid options:
suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.
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”.
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.
varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)
downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables
notplot (bool) – Return the data in hash tables instead of creating tplot variables
no_update (bool) – If set, only load data from your local cache
time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type:

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
rps_vars = pyspedas.rbsp.rps(trange=['2018-11-5', '2018-11-6'], datatype='rps', level='l2')
tplot('DOSE1')