Merge branch 'spedas:master' into master

pyspedas/akebono/__init__.py

@@ -18,56 +18,74 @@ def pws(trange=['2012-10-01', '2012-10-02'],
         no_update=False,
         time_clip=False):
     """
-    This function loads data from the Plasma Waves and Sounder experiment (PWS)
+    This function loads data from the ACE Plasma Waves and Sounder experiment (PWS)
     
     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: ['2012-10-01', '2012-10-02']
 
         datatype: str
             Data type; Valid options:
                 'ne', 'npw-ds', 'npw-py', 'spw'
+            Default: 'ne'
 
         level: str
             Data level; options: 'h1' (default: h1)
+            Default: 'h1'
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
             no suffix is added.
+            Default: ''
 
         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".
+            Default: False
 
         varformat: str
             The file variable formats to load into tplot.  Wildcard character
             "*" is accepted.  By default, all variables are loaded in.
+            Default: None
 
         varnames: list of str
             List of variable names to load (if not specified,
             all data variables are loaded)
+            Default: []
 
         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 tplot variables created.
 
+    Example:
+    ---------- 
+        >>> import pyspedas
+        >>> from pytplot import tplot  
+        >>> pws_vars = pyspedas.akebono.pws(trange=['2012-10-01', '2012-10-02'])
+        >>> tplot(['akb_pws_RX1', 'akb_pws_RX2'])
+
     """
     tvars = load(instrument='pws', trange=trange, level=level, datatype=datatype, suffix=suffix, get_support_data=get_support_data, varformat=varformat, varnames=varnames, downloadonly=downloadonly, notplot=notplot, time_clip=time_clip, no_update=no_update)
 
@@ -94,49 +112,65 @@ def rdm(trange=['2012-10-01', '2012-10-02'],
         no_update=False,
         time_clip=False):
     """
-    This function loads data from the Radiation Moniter (RDM)
+    This function loads data from the ACE Radiation Moniter (RDM)
     
     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: ['2012-10-01', '2012-10-02']
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
             no suffix is added.
+            Default: ''
 
         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".
+            Default: False
 
         varformat: str
             The file variable formats to load into tplot.  Wildcard character
             "*" is accepted.  By default, all variables are loaded in.
+            Default: None
 
         varnames: list of str
             List of variable names to load (if not specified,
             all data variables are loaded)
+            Default: []
 
         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 tplot variables created.
 
+    Example:
+    ---------- 
+        >>> import pyspedas
+        >>> from pytplot import tplot  
+        >>> rdm_vars = pyspedas.akebono.rdm(trange=['2012-10-01', '2012-10-02'])
+        >>> tplot('akb_rdm_FEIO')
+
     """
     files = load(instrument='rdm', trange=trange, suffix=suffix, get_support_data=get_support_data, varformat=varformat, varnames=varnames, downloadonly=downloadonly, notplot=notplot, time_clip=time_clip, no_update=no_update)
 
@@ -217,49 +251,65 @@ def orb(trange=['2012-10-01', '2012-10-02'],
         no_update=False,
         time_clip=False):
     """
-    This function loads data from the Akebono orbit data (orb)
+    This function loads data from the ACE Akebono orbit data (orb)
     
     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: ['2012-10-01', '2012-10-02']
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
             no suffix is added.
+            Default: ''
 
         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".
+            Default: False
 
         varformat: str
             The file variable formats to load into tplot.  Wildcard character
             "*" is accepted.  By default, all variables are loaded in.
+            Default: None
 
         varnames: list of str
             List of variable names to load (if not specified,
             all data variables are loaded)
+            Default: []
 
         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 tplot variables created.
 
+    Example:
+    ---------- 
+        >>> import pyspedas
+        >>> from pytplot import tplot  
+        >>> rdm_vars = pyspedas.akebono.rdm(trange=['2012-10-01', '2012-10-02'])
+        >>> tplot('akb_rdm_FEIO')
+
     """
     files = load(instrument='orb', trange=trange, suffix=suffix, get_support_data=get_support_data, varformat=varformat, varnames=varnames, downloadonly=downloadonly, notplot=notplot, time_clip=time_clip, no_update=no_update)