Time History of Events and Macroscale Interactions during Substorms (THEMIS)

The routines in this module can be used to load data from the Time History of Events and Macroscale Interactions during Substorms (THEMIS) mission.

Fluxgate magnetometer (FGM)

pyspedas.themis.fgm(trange=['2007-03-23', '2007-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, coord=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads Fluxgate magnetometer (FGM) data

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data level; Valid options: ‘l1’, ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data

Example

import pyspedas from pytplot import tplot >>> fgm_vars = pyspedas.themis.fgm(probe=’d’, trange=[‘2013-11-5’, ‘2013-11-6’]) >>> tplot([‘thd_fgs_btotal’, ‘thd_fgs_gse’])

Example

import pyspedas
from pytplot import tplot
fgm_vars = pyspedas.themis.fgm(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot(['thd_fgs_btotal', 'thd_fgs_gse'])

Search-coil magnetometer (SCM)

pyspedas.themis.scm(trange=['2007-03-23', '2007-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads Search-coil magnetometer (SCM) data

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data level; Valid options: ‘l1’, ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data
>>> scm_vars = pyspedas.themis.scm(probe=``’d’, :class:`trange=[`’2013-11-05’, ``'2013-11-06'])
>>> tplot([``’thd_scf_btotal’, ``'thd_scf_gse'])

Example

import pyspedas from pytplot import tplot

Example

import pyspedas
from pytplot import tplot
scm_vars = pyspedas.themis.scm(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot(['thd_scf_btotal', 'thd_scf_gse'])

Electric Field Instrument (EFI)

pyspedas.themis.efi(trange=['2007-03-23', '2007-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads Electric Field Instrument (EFI) data

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data type; Valid options: ‘l1’, ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data

Example

import pyspedas from pytplot import tplot >>> efi_vars = pyspedas.themis.efi(probe=’d’, trange=[‘2013-11-5’, ‘2013-11-6’]) >>> tplot(‘thd_efs_dot0_gse’)

Example

import pyspedas
from pytplot import tplot
efi_vars = pyspedas.themis.efi(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot('thd_efs_dot0_gse')

Electrostatic Analyzer (ESA)

pyspedas.themis.esa(trange=['2007-03-23', '2007-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads Electrostatic Analyzer (ESA) data

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data level; Valid options: ‘l1’, ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data

Example

import pyspedas from pytplot import tplot >>> esa_vars = pyspedas.themis.esa(probe=’d’, trange=[‘2013-11-5’, ‘2013-11-6’]) >>> tplot([‘thd_peif_density’, ‘thd_peif_vthermal’])

Example

import pyspedas
from pytplot import tplot
esa_vars = pyspedas.themis.esa(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot(['thd_peif_density', 'thd_peif_vthermal'])

Solid State Telescope (SST)

pyspedas.themis.sst(trange=['2007-03-23', '2007-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads Solid State Telescope (SST) data

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data level; Valid options: ‘l1’, ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data

Example

import pyspedas from pytplot import tplot >>> sst_vars = pyspedas.themis.sst(probe=’d’, trange=[‘2013-11-5’, ‘2013-11-6’]) >>> tplot(‘thd_psif_density’)

Example

import pyspedas
from pytplot import tplot
sst_vars = pyspedas.themis.sst(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot('thd_psif_density')

Moments data

pyspedas.themis.mom(trange=['2008-03-23', '2008-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads THEMIS moments data

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: [‘2008-03-23’, ‘2008-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data level; Valid options: ‘l1’, ‘l2’ Default: ‘l2’
level (str) – Data level; Valid options: ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data

Example

import pyspedas from pytplot import tplot >>> mom_vars = pyspedas.themis.mom(probe=’d’, trange=[‘2013-11-5’, ‘2013-11-6’]) >>> tplot([‘thd_peim_velocity_gsm’, ‘thd_peim_density’])

Example

import pyspedas
from pytplot import tplot
mom_vars = pyspedas.themis.mom(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot(['thd_peim_velocity_gsm', 'thd_peim_density'])

Ground computed moments data

pyspedas.themis.gmom(trange=['2007-03-23', '2007-03-24'], probe='c', level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads THEMIS Level 2 ground calculated combined ESA+SST moments.

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data level; Valid options: ‘l2’ Default: ‘l2’
suffix (str) – The tplot variable names will be given this suffix. Default: no suffix
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. Default: False; only loads data with a “VAR_TYPE” attribute of “data”
varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. Default: None; all variables are loaded
varnames (list of str) – List of variable names to load Default: Empty list, so all data variables are loaded
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

Returns:

List of str
List of tplot variables created
Empty list if no data

Example

import pyspedas from pytplot import tplot >>> gmom_vars = pyspedas.themis.gmom(probe=’d’, trange=[‘2013-11-5’, ‘2013-11-6’]) >>> tplot([‘thd_ptiff_velocity_gse’, ‘thd_pteff_density’, ‘thd_pteff_avgtemp’])

Example

import pyspedas
from pytplot import tplot
gmom_vars = pyspedas.themis.gmom(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot(['thd_ptiff_velocity_gse', 'thd_pteff_density', 'thd_pteff_avgtemp'])

State data

pyspedas.themis.state(trange=['2007-03-23', '2007-03-24'], probe='c', level='l1', suffix='', get_support_data=False, varformat=None, exclude_format=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False, keep_spin=False)

Load THEMIS state data

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: [‘2007-03-23’, ‘2007-03-24’]
probe (str or list of str) – Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’) Default: ‘c’
level (str) – Data type; Valid options: ‘l1’ Default: ‘l1’
suffix (str) – The tplot variable names will be given this suffix. Default: None
get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. 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 (all variables are loaded)
exclude_format (str) – If specified, CDF variables matching this pattern will not be processed. Wildcard character “*” is accepted. Default: None
varnames (list of str) – List of variable names to load. If list is empty or unsoecified, all data variables are loaded Default: [] (all variables are loaded)
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
keep_spin (bool) – If True, do not delete the spin model tplot variables after the spin models are built. Default: False

Returns:

List of str
List of tplot variables created
Empty list if no data loaded

Example

>>> import pyspedas
>>> from pytplot import tplot
>>> pyspedas.themis.state(trange=['2007-03-23', '2007-03-24'], probe='a', varnames=['tha_pos_gse','tha_vel_gse'])
>>> tplot['tha_pos_gse', 'tha_vel_gse'])

Example

import pyspedas
from pytplot import tplot
state_vars = pyspedas.themis.state(probe='d', trange=['2013-11-5', '2013-11-6'])
tplot(['thd_pos', 'thd_vel'])

Ground magnetometer data

pyspedas.themis.gmag(trange=['2007-03-23', '2007-03-24'], sites=None, group=None, level='l2', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

Load ground magnetometer data from the THEMIS mission.

Parameters:

trange (list, optional) – Time range of interest in the format [“start_date”, “end_date”]. Default is [“2007-03-23”, “2007-03-24”].
sites (list or str, optional) – List of ground magnetometer sites to load data for. If None, data for all available sites will be loaded. Default is None.
group (str, optional) – Name of a pre-defined group of sites to load data for. If specified, the ‘sites’ parameter will be ignored. Default is None.
level (str, optional) – Data level to load. Default is “l2”.
suffix (str, optional) – Suffix to append to the variable names. Default is “”.
get_support_data (bool, optional) – Flag indicating whether to download support data. Default is False.
varformat (str, optional) – Format of the variable names. Default is None.
varnames (list, optional) – List of specific variable names to load. Default is [].
downloadonly (bool, optional) – Flag indicating whether to only download the data without loading it. Default is False.
notplot (bool, optional) – Flag indicating whether to plot the loaded data. Default is False.
no_update (bool, optional) – Flag indicating whether to update the data files. Default is False.
time_clip (bool, optional) – Flag indicating whether to clip the data to the specified time range. Default is False.

Returns:

A dictionary containing the loaded data.

Return type:

dict

Examples

from pyspedas.themis import gmag from pytplot import tplot

# Load ground magnetometer data for specific sites and time range gmag_vars = gmag(sites=[‘ccnv’,’bmls’], trange=[‘2013-11-05’, ‘2013-11-06’]) tplot([‘thg_mag_bmls’, ‘thg_mag_ccnv’])

Example

import pyspedas
from pytplot import tplot
gmag_vars = pyspedas.themis.gmag(sites='ccnv', trange=['2013-11-5', '2013-11-6'])
tplot('thg_mag_ccnv')