Merge pull request #97 from spedas/metadata-updates

Metadata updates

pyspedas/ace/__init__.py

@@ -3,7 +3,7 @@
 from pytplot import options
 
 def mfi(trange=['2018-11-5', '2018-11-6'],
-        datatype='k0',
+        datatype='h3',
         suffix='',  
         get_support_data=False, 
         varformat=None,
@@ -15,14 +15,22 @@ def mfi(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Fluxgate Magnetometer
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h0: 16-Second Level 2 Data
+                h1: 4-Minute Level 2 Data
+                h2: 1-Hour Level 2 Data
+                h3: (default) 1-Second Level 2 Data
+                k0: 5-Minute Key Parameters [PRELIM]
+                k1: 16-Second Key Parameters [PRELIM]
+                k2: 1-Hour Key Parameters [PRELIM] 
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -54,7 +62,8 @@ def mfi(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
@@ -74,7 +83,7 @@ def mfi(trange=['2018-11-5', '2018-11-6'],
     return tvars
 
 def swe(trange=['2018-11-5', '2018-11-6'],
-        datatype='k0',
+        datatype='h0',
         suffix='',  
         get_support_data=False, 
         varformat=None,
@@ -86,14 +95,19 @@ def swe(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Solar Wind Electron, Proton and Alpha Monitor (SWEPAM)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h0: (default) 64-Second Level 2 Data
+                h2: 1-Hour Level 2 Data
+                k0: 5-Minute Key Parameters [PRELIM] 
+                k1: 1-Hour Key Parameters [PRELIM]
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -125,14 +139,15 @@ def swe(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
     return load(instrument='swe', trange=trange, 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)
 
 def epam(trange=['2018-11-5', '2018-11-6'],
-        datatype='k0',
+        datatype='h0',
         suffix='',  
         get_support_data=False, 
         varformat=None,
@@ -144,14 +159,20 @@ def epam(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Electron Proton Alpha Monitor (EPAM)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h1: (default) 5-Minute Level 2 Data
+                h2: 1-Hour Level 2 Data
+                h3: 12-second Level 2 Data
+                k0: 5-Minute Key Parameters
+                k1: 1-Hour Key Parameters
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -183,7 +204,8 @@ def epam(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
@@ -202,14 +224,17 @@ def cris(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Cosmic Ray Isotope Spectrometer (CRIS)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h2: (default) 1-Hour Level 2 Data
+                h3: Daily-averaged Level 2 Data
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -241,7 +266,8 @@ def cris(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
@@ -260,14 +286,18 @@ def sis(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Solar Isotope Spectrometer (SIS)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h1: (default) 256-sec Level 2 Data
+                h2: 1-Hour Level 2 Data
+                k0: 1-Hour Key Parameters
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -299,7 +329,8 @@ def sis(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
@@ -319,14 +350,16 @@ def uleis(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Ultra Low Energy Isotope Spectrometer (ULEIS)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h2: 1-Hour Level 2 Data
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -358,7 +391,8 @@ def uleis(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
@@ -378,14 +412,16 @@ def sepica(trange=['2004-11-5', '2004-11-6'],
     """
     This function loads data from the Solar Energetic Particle Ionic Charge Analyzer (SEPICA)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                h2: 1-Hour Level 2 Data
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -417,7 +453,8 @@ def sepica(trange=['2004-11-5', '2004-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """
@@ -436,14 +473,21 @@ def swics(trange=['2018-11-5', '2018-11-6'],
     """
     This function loads data from the Solar Wind Ion Composition Spectrometer (SWICS)
     
-    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']
 
         datatype: str
             Data type; Valid options:
+                sw2_h3: (default) SWICS 2.0 Solar Wind 2-Hour Level 2 Data
+                swi_h2: SWICS 1.1 Solar Wind 1-Hour Level 2 Data
+                swi_h3: SWICS 1.1 Solar Wind 2-Hour Level 2 Data
+                swi_h4: SWICS 1.1 Solar Wind 1-Day Level 2 Data 
+                swi_h5: SWICS 1.1 Solar Wind 2-Hour Level 2 Q-state distributions 
+                swi_h6: Solar Wind Protons 12-min Level 2 Data
 
         suffix: str
             The tplot variable names will be given this suffix.  By default, 
@@ -475,7 +519,8 @@ def swics(trange=['2018-11-5', '2018-11-6'],
         time_clip: bool
             Time clip the variables to exactly the range specified in the trange keyword
 
-    Returns:
+    Returns
+    ----------
         List of tplot variables created.
 
     """

pyspedas/cotrans/cotrans.py

@@ -1,7 +1,7 @@
 """
 Coordinate transformations.
 
-Trasform from/to the following coordinate systems:
+Transform from/to the following coordinate systems:
 GSE, GSM, SM, GEI, GEO, MAG, J2000
 
 Times are in Unix seconds for consistency.

pyspedas/cotrans/gsm2lmn.py

@@ -4,7 +4,7 @@
 
 def gsm2lmn(times, Rxyz, Bxyz, swdata=None):
     '''
-    Transforms vector field from GSM to LMN (boundary-normal) coordimnate
+    Transforms vector field from GSM to LMN (boundary-normal) coordinate
     system for the magnetopause using the Shue et al. (1998) magnetopause model
 
 

pyspedas/mms/aspoc/aspoc.py

@@ -9,7 +9,8 @@ def mms_load_aspoc(trange=['2015-10-16', '2015-10-17'], probe='1', data_rate='sr
     """
     This function loads ASPOC data into tplot variables
     
-    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 

pyspedas/mms/dsp/dsp.py

@@ -11,7 +11,8 @@ def mms_load_dsp(trange=['2015-10-16', '2015-10-17'], probe='1', data_rate='srvy
     """
     This function loads DSP data into tplot variables
     
-    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 

pyspedas/mms/dsp/mms_dsp_set_metadata.py

@@ -5,7 +5,8 @@ def mms_dsp_set_metadata(probe, data_rate, level, suffix=''):
     """
     This function updates the metadata for DSP data products
     
-    Parameters:
+    Parameters
+    ----------
         probe : str or list of str
             probe or list of probes, valid values for MMS probes are ['1','2','3','4']. 
 

pyspedas/mms/edi/edi.py

@@ -11,7 +11,8 @@ def mms_load_edi(trange=['2016-10-16', '2016-10-17'], probe='1', data_rate='srvy
     """
     This function loads EDI data into tplot variables
     
-    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 

pyspedas/mms/edi/mms_edi_set_metadata.py

@@ -5,7 +5,8 @@ def mms_edi_set_metadata(probe, data_rate, level, suffix=''):
     """
     This function updates the metadata for EDI data products
     
-    Parameters:
+    Parameters
+    ----------
         probe : str or list of str
             probe or list of probes, valid values for MMS probes are ['1','2','3','4']. 
 

pyspedas/mms/edp/edp.py

@@ -11,7 +11,8 @@ def mms_load_edp(trange=['2015-10-16', '2015-10-17'], probe='1', data_rate='fast
     """
     This function loads EDP data into tplot variables
     
-    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 

pyspedas/mms/edp/mms_edp_set_metadata.py

@@ -5,7 +5,8 @@ def mms_edp_set_metadata(probe, data_rate, level, suffix=''):
     """
     This function updates the metadata for EDP data products
     
-    Parameters:
+    Parameters
+    ----------
         probe : str or list of str
             probe or list of probes, valid values for MMS probes are ['1','2','3','4']. 
 

pyspedas/mms/eis/eis.py

@@ -15,7 +15,8 @@ def mms_load_eis(trange=['2015-10-16', '2015-10-17'], probe='1', data_rate='srvy
     """
     This function loads EIS data into tplot variables
     
-    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 

pyspedas/mms/eis/mms_eis_omni.py

@@ -11,7 +11,8 @@ def mms_eis_omni(probe, species='proton', datatype='extof', suffix='', data_unit
     """
     This function will calculate the omni-directional EIS spectrograms, and is automatically called from mms_load_eis
     
-    Parameters:
+    Parameters
+    ----------
         probe: str
             probe #, e.g., '4' for MMS4
 

pyspedas/mms/eis/mms_eis_pad.py

@@ -22,7 +22,8 @@ def mms_eis_pad(scopes=['0', '1', '2', '3', '4', '5'], probe='1', level='l2',
     """
     Calculate pitch angle distributions using data from the MMS Energetic Ion Spectrometer (EIS)
     
-    Parameters:
+    Parameters
+    ----------
         scopes: list of str
             telescope #s to include in the calculation
 

pyspedas/mms/eis/mms_eis_pad_spinavg.py

@@ -22,7 +22,8 @@ def mms_eis_pad_spinavg(scopes=['0','1','2','3','4','5'], probe='1',
     """
     Calculate spin-averaged pitch angle distributions using data from the MMS Energetic Ion Spectrometer (EIS)
     
-    Parameters:
+    Parameters
+    ----------
         scopes: list of str
             telescope #s to include in the calculation