OMNI data

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

Load all available OMNI variables

pyspedas.projects.omni.data(trange=['2013-11-5', '2013-11-6'], datatype='1min', level='hro', prefix='', suffix='', get_support_data=False, get_ignore_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=True, force_download=False)

Loads OMNI (Combined 1AU IP Data; Magnetic and Solar Indices) data; intended for internal use.

This function is a core component for data loading but is not meant to be called directly by users. Instead, users should utilize the wrapper function pyspedas.projects.omni.data to access this functionality.

Parameters:

  • trange (list of str, optional) – Time range of interest specified as [‘starttime’, ‘endtime’] with the format ‘YYYY-MM-DD’ or ‘YYYY-MM-DD/hh:mm:ss’ to specify more or less than a day. default=[‘2013-11-5’, ‘2013-11-6’]

  • datatype (str, optional) – Data type; valid options: ‘1min’, ‘5min’, ‘hourly’. Default: ‘1min’.

  • level (str, optional) – Data level; valid options: ‘hro’, ‘hro2’. Default=’hro’

  • prefix (str, optional) – Prefix for the tplot variable names. By default, no prefix is added.

  • suffix (str, optional) – Suffix for the tplot variable names. By default, no suffix is added.

  • get_support_data (bool, optional) – If True, loads data with “VAR_TYPE” attribute value “support_data” into tplot. By default, only loads data with a “VAR_TYPE” attribute of “data”.

  • get_ignore_data (bool, optional) – If True, specific data types will be ignored during loading. This is especially used for hourly data where ignoring certain data is required.

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

  • varnames (list of str, optional) – List of variable names to load. If not specified, all data variables are loaded.

  • downloadonly (bool, optional) – If True, downloads the CDF files but does not load them into tplot variables.

  • notplot (bool, optional) – If True, returns the data in hash tables instead of creating tplot variables.

  • no_update (bool, optional) – If True, loads data only from the local cache.

  • time_clip (bool, optional) – If True, clips the variables to exactly the range specified in the trange parameter.

  • force_download (bool, optional) – Download file even if local version is more recent than server version Default: False

Returns:

List of tplot variables created if notplot is False. Otherwise, returns a dictionary with data tables.

Return type:

list or dict

Examples

This function is not intended to be called directly.

Example

import pyspedas
from pyspedas import tplot
omni_vars = pyspedas.projects.omni.data(trange=['2013-11-5', '2013-11-6'])
tplot(['BX_GSE', 'BY_GSE', 'BZ_GSE', 'flow_speed', 'Vx', 'Vy', 'Vz', 'SYM_H'])
_images/omni_data.png