pyrfu.mms.get_data module#

pyrfu.mms.get_data.get_data(var_str, tint, mms_id, verbose: bool = True, data_path: str = '', source: str = '')[source]#

Load a variable. var_str must be in var (see below)

Parameters:

  • var_str (str) – Key of the target variable (use mms.get_data() to see keys.).

  • tint (list of str) – Time interval.

  • mms_id (str or int) – Index of the target spacecraft.

  • verbose (bool, Optional) – Set to True to follow the loading. Default is True.

  • data_path (str, Optional) – Local path of MMS data. Default uses that provided in pyrfu/mms/config.json

  • source ({"local", "sdc", "aws"}, Optional) – Ressource to fetch data from. Default uses default in pyrfu/mms/config.json

Returns:

out – Time series of the target variable of measured by the target spacecraft over the selected time interval.

Return type:

xarray.DataArray or xarray.Dataset

See also

pyrfu.mms.get_ts

Read time series.

pyrfu.mms.get_dist

Read velocity distribution function.

Examples

>>> from pyrfu import mms

Define time interval

>>> tint_brst = ["2019-09-14T07:54:00.000", "2019-09-14T08:11:00.000"]

Index of MMS spacecraft

>>> ic = 1

Load magnetic field from FGM

>>> b_xyz = mms.get_data("b_gse_fgm_brst_l2", tint_brst, ic)