From 481b24cea27d0556e7c2ffb0f45b5f1f61a406ec Mon Sep 17 00:00:00 2001 From: Jim McTiernan Date: Tue, 23 Jan 2024 14:13:57 -0800 Subject: [PATCH] Updated doc headers THEMIS EFI,FBK,FFT,FGM,FIT,SCM --- pyspedas/themis/spacecraft/fields/efi.py | 40 ++++++++++++++----- pyspedas/themis/spacecraft/fields/fbk.py | 43 +++++++++++++++------ pyspedas/themis/spacecraft/fields/fft.py | 40 ++++++++++++++----- pyspedas/themis/spacecraft/fields/fgm.py | 49 ++++++++++++++++-------- pyspedas/themis/spacecraft/fields/fit.py | 39 ++++++++++++++----- pyspedas/themis/spacecraft/fields/scm.py | 39 ++++++++++++++----- 6 files changed, 182 insertions(+), 68 deletions(-) diff --git a/pyspedas/themis/spacecraft/fields/efi.py b/pyspedas/themis/spacecraft/fields/efi.py index 4bed8755..92d307f0 100644 --- a/pyspedas/themis/spacecraft/fields/efi.py +++ b/pyspedas/themis/spacecraft/fields/efi.py @@ -16,51 +16,71 @@ def efi(trange=['2007-03-23', '2007-03-24'], """ This function loads Electric Field Instrument (EFI) data - Parameters: + 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. By default, - no suffix is added. + 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. By default, only loads in data with a - "VAR_TYPE" attribute of "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. By default, all variables are loaded in. + "*" is accepted. + Default: None; all variables are loaded varnames: list of str List of variable names to load - (if not specified, all data variables are loaded) + 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') - Returns: - List of tplot variables created. """ return load(instrument='efi', trange=trange, level=level, diff --git a/pyspedas/themis/spacecraft/fields/fbk.py b/pyspedas/themis/spacecraft/fields/fbk.py index 9a4447c6..ec38e1b9 100644 --- a/pyspedas/themis/spacecraft/fields/fbk.py +++ b/pyspedas/themis/spacecraft/fields/fbk.py @@ -21,47 +21,68 @@ def fbk(trange=['2007-03-23', '2007-03-24'], 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' + Data level; Valid options: 'l1', 'l2' + Default: 'l2' + + level: str + Data level; Valid options: 'l1', 'l2' + Default: 'l2' suffix: str - The tplot variable names will be given this suffix. By default, - no suffix is added. + 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. By default, only loads in data with a - "VAR_TYPE" attribute of "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. By default, all variables are loaded in. + "*" is accepted. + Default: None; all variables are loaded varnames: list of str List of variable names to load - (if not specified, all data variables are loaded) + 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 - - Returns: - List of tplot variables created. - + Default: False + + Returns + ------- + List of str + List of tplot variables created + Empty list if no data + + Example + ------- + import pyspedas + from pytplot import tplot + >>> fbk_vars = pyspedas.themis.fbk(probe='d', trange=['2013-11-5', '2013-11-6']) + >>> tplot(['thd_fb_edc12', 'thd_fb_scm1']) """ return load(instrument='fbk', trange=trange, level=level, suffix=suffix, get_support_data=get_support_data, diff --git a/pyspedas/themis/spacecraft/fields/fft.py b/pyspedas/themis/spacecraft/fields/fft.py index 7c4f61d9..ee31aa72 100644 --- a/pyspedas/themis/spacecraft/fields/fft.py +++ b/pyspedas/themis/spacecraft/fields/fft.py @@ -16,51 +16,71 @@ def fft(trange=['2007-03-23', '2007-03-24'], """ This function loads THEMIS FFT data - Parameters: + 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' + Data level; Valid options: 'l1', 'l2' + Default: 'l2' suffix: str - The tplot variable names will be given this suffix. By default, - no suffix is added. + 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. By default, only loads in data with a - "VAR_TYPE" attribute of "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. By default, all variables are loaded in. + "*" is accepted. + Default: None; all variables are loaded varnames: list of str List of variable names to load - (if not specified, all data variables are loaded) + 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 + >>> fft_vars = pyspedas.themis.fft(probe='d', trange=['2013-11-5', '2013-11-6']) + >>> tplot(['thd_fff_32_edc12','thd_fff_32_scm2']) - Returns: - List of tplot variables created. """ return load(instrument='fft', trange=trange, level=level, diff --git a/pyspedas/themis/spacecraft/fields/fgm.py b/pyspedas/themis/spacecraft/fields/fgm.py index f1db05fb..b337c7ed 100644 --- a/pyspedas/themis/spacecraft/fields/fgm.py +++ b/pyspedas/themis/spacecraft/fields/fgm.py @@ -17,55 +17,70 @@ def fgm(trange=['2007-03-23', '2007-03-24'], """ This function loads Fluxgate magnetometer (FGM) data - Parameters: - trange: list of str + 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 or list of str - Data type; Valid options: 'l1', 'l2' + level: str + Data level; Valid options: 'l1', 'l2' + Default: 'l2' suffix: str The tplot variable names will be given this suffix. - By default, no suffix is added. + Default: no suffix 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". + 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. By default, all variables are loaded in. - - coord: str - Coordinate system + "*" is accepted. + Default: None; all variables are loaded varnames: list of str List of variable names to load - (if not specified, all data variables are loaded) + 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. - If set, this function returns a list of the files downloaded. + 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 - - Returns: - List of tplot variables created. + 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']) """ diff --git a/pyspedas/themis/spacecraft/fields/fit.py b/pyspedas/themis/spacecraft/fields/fit.py index 388e6652..0b1bd601 100644 --- a/pyspedas/themis/spacecraft/fields/fit.py +++ b/pyspedas/themis/spacecraft/fields/fit.py @@ -15,51 +15,70 @@ def fit(trange=['2007-03-23', '2007-03-24'], """ This function loads THEMIS FIT data - Parameters: + 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' + Data level; Valid options: 'l1', 'l2' + Default: 'l2' suffix: str The tplot variable names will be given this suffix. - By default, no suffix is added. + Default: no suffix 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". + 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. By default, all variables are loaded in. + "*" is accepted. + Default: None; all variables are loaded varnames: list of str List of variable names to load - (if not specified, all data variables are loaded) + 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 - - Returns: - List of tplot variables created. + Default: False + + Returns + ------- + List of str + List of tplot variables created + Empty list if no data + + Example + ------- + import pyspedas + from pytplot import tplot + >>> fit_vars = pyspedas.themis.fit(probe='d', trange=['2013-11-05', '2013-11-06']) + >>> tplot(['thd_fgs_gse', 'thd_efs_dot0_gse']) """ return load(instrument='fit', trange=trange, level=level, diff --git a/pyspedas/themis/spacecraft/fields/scm.py b/pyspedas/themis/spacecraft/fields/scm.py index 04a577c3..b6a7708e 100644 --- a/pyspedas/themis/spacecraft/fields/scm.py +++ b/pyspedas/themis/spacecraft/fields/scm.py @@ -16,51 +16,70 @@ def scm(trange=['2007-03-23', '2007-03-24'], """ This function loads Search-coil magnetometer (SCM) data - Parameters: + 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' + Data level; Valid options: 'l1', 'l2' + Default: 'l2' suffix: str The tplot variable names will be given this suffix. - By default, no suffix is added. + Default: no suffix 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". + 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. By default, all variables are loaded in. + "*" is accepted. + Default: None; all variables are loaded varnames: list of str List of variable names to load - (if not specified, all data variables are loaded) + 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 - - Returns: - List of tplot variables created. + Default: False + + Returns + ------- + List of str + List of tplot variables created + Empty list if no data + >>> scm_vars = pyspedas.themis.scm(probe='d', trange=['2013-11-05', '2013-11-06']) + >>> tplot(['thd_scf_btotal', 'thd_scf_gse']) + + Example + ------- + import pyspedas + from pytplot import tplot """ return load(instrument='scm', trange=trange, level=level,