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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str or list of str Data type; Valid options: ‘l1’, ‘l2’

  • 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.

  • coord – str Coordinate system

  • 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. If set, this function returns a list of the files downloaded.

  • 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

Returns

List of tplot variables created.

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'])
_images/themis_fgm.png

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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l1’, ‘l2’

  • 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

Returns

List of tplot variables created.

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'])
_images/themis_scm.png

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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l1’, ‘l2’

  • 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

Returns

List of tplot variables created.

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')
_images/themis_efi.png

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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l1’, ‘l2’

  • 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

Returns

List of tplot variables created.

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'])
_images/themis_esa.png

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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l1’, ‘l2’

  • 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

Returns

List of tplot variables created.

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')
_images/themis_sst.png

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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l1’, ‘l2’

  • 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

Returns

List of tplot variables created.

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'])
_images/themis_mom.png

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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l2’

  • 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

Returns

List of tplot variables created.

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'])
_images/themis_gmom.png

State data

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

This function loads 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’]

  • probe – str or list of str Spacecraft probe letter(s) (‘a’, ‘b’, ‘c’, ‘d’ and/or ‘e’)

  • level – str Data type; Valid options: ‘l1’

  • 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

Returns

List of tplot variables created.

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'])
_images/themis_state.png

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)

This function loads ground magnetometer 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’]

  • level – str Data type; Valid options: ‘l1’, ‘l2’

  • 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

  • sites – str/list of str GMAG station names to load (e.g. ‘bmls’).

  • group – str GMAG group of stations (eg. ‘epo’). If specified, stations is ignored.

Returns

List of tplot variables created.

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')
_images/themis_gmag.png