Skip to content

Commit

Permalink
Updated doc headers THEMIS EFI,FBK,FFT,FGM,FIT,SCM
Browse files Browse the repository at this point in the history
  • Loading branch information
Jim McTiernan committed Jan 23, 2024
1 parent cc788d4 commit 481b24c
Show file tree
Hide file tree
Showing 6 changed files with 182 additions and 68 deletions.
40 changes: 30 additions & 10 deletions pyspedas/themis/spacecraft/fields/efi.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
43 changes: 32 additions & 11 deletions pyspedas/themis/spacecraft/fields/fbk.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
40 changes: 30 additions & 10 deletions pyspedas/themis/spacecraft/fields/fft.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
49 changes: 32 additions & 17 deletions pyspedas/themis/spacecraft/fields/fgm.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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'])
"""

Expand Down
Loading

0 comments on commit 481b24c

Please sign in to comment.