Ulysses

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

Magnetic field (VHM)

pyspedas.ulysses.vhm(trange=['2009-01-01', '2009-01-02'], datatype='1min', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=True)

This function loads data from the VHM/FGM experiment from the Ulysses mission

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’]
datatype (str) – Data type; Valid options:
level (str) – Data level; 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
vhm_vars = pyspedas.ulysses.vhm()
tplot('B_MAG')

Solar wind plasma (SWOOPS)

pyspedas.ulysses.swoops(trange=['2009-01-01', '2009-01-02'], datatype='bai_m0', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the SWOOPS experiment from the Ulysses mission

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’]
datatype (str) – Data type; Valid options:
level (str) – Data level; 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
swoops_vars = pyspedas.ulysses.swoops()
tplot(['Density', 'Temperature', 'Velocity'])

Solar wind ion composition (SWICS)

pyspedas.ulysses.swics(trange=['2009-01-01', '2009-01-02'], datatype='scs_m1', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the SWICS experiment from the Ulysses mission

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’]
datatype (str) – Data type; Valid options:
level (str) – Data level; 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
swics_vars = pyspedas.ulysses.swics()
tplot('Velocity')

Energetic particles (EPAC)

pyspedas.ulysses.epac(trange=['1996-01-01', '1996-01-02'], datatype='epac_m1', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the EPAC experiment from the Ulysses mission

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’]
datatype (str) – Data type; Valid options:
level (str) – Data level; 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
epac_vars = pyspedas.ulysses.epac()
tplot('Omni_Protons')

Low-energy ions and electrons (HI-SCALE)

pyspedas.ulysses.hiscale(trange=['2003-01-01', '2003-01-02'], datatype='lmde_m1', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the HI-SCALE experiment from the Ulysses mission

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’]
datatype (str) – Data type; Valid options:
level (str) – Data level; 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
hiscale_vars = pyspedas.ulysses.hiscale()
tplot('Electrons')

Solar X-rays and cosmic gamma-ray bursts (GRB)

pyspedas.ulysses.grb(trange=['2003-01-01', '2003-01-02'], datatype='grb_m0', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the GRB experiment from the Ulysses mission

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’]
datatype (str) – Data type; Valid options:
level (str) – Data level; 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
grb_vars = pyspedas.ulysses.grb()
tplot('Count_Rate')