Documentation updates

skdaccess/astro/tess/data/cache.py

@@ -37,8 +37,6 @@ def __init__(self, ap_paramList):
         Initialize TESS Data Fetcher
 
         @param ap_paramList[tess_ids]: List of TESS IDs to retrieve
-        @param start_url: URL to prepend before the TESS ID
-        @param end_url: URL to append after the TESS ID
         '''
 
         self.start_url = 'https://archive.stsci.edu/hlsps/tess-data-alerts/hlsp_tess-data-alerts_tess_phot_'
@@ -52,13 +50,14 @@ def generateURLFromTID(self, tid_list):
         Generate URL from TID
 
         @param tid_list: List of input Tess IDs
-        @param List of url's for accessing TID
         """
         return [ self.start_url + tid[-11:] + self.end_url for tid in tid_list]
 
     def getTargetInformation():
         """
-        Retrieve Target information for TESS data alerts
+        Retrieve Target information for TESS Data Alerts
+
+        @return Pandas DataFrame of containing target information
         """
 
         toi_url = 'https://archive.stsci.edu/hlsps/tess-data-alerts/hlsp_tess-data-alerts_tess_phot_alert-summary-s01+s02_tess_v3_spoc.csv'

skdaccess/astro/tess/generic/cache.py

@@ -43,16 +43,15 @@ def __init__(self, ap_paramList, toi_information):
         Initialize TESS Data Fetcher
 
         @param ap_paramList[tess_ids]: List of TESS IDs to retrieve
-        @param start_url: URL to prepend before the TESS ID
-        @param end_url: URL to append after the TESS ID
+        @param toi_information: Pandas dataframe containing target information
         '''
         self.toi_information = toi_information
         super(DataFetcher, self).__init__(ap_paramList)
 
 
     def getTargetInformation():
         """
-        Retrieve Target list
+        Retrieve Target list information
         """
     pass
 
@@ -61,7 +60,7 @@ def generateURLFromTID(self, tid_list):
         Generate URL from TID
 
         @param tid: Input Tess ID
-        @param return url to access data
+        @return URL List of of objects in tid_list
         """
         pass
 

skdaccess/dox.cfg

@@ -100,7 +100,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ./solar/sdo/data_fetcher.py ./framework/data_class.py ./framework/param_class.py ./planetary/ode/cache/data_fetcher.py ./geo/grace/mascon/cache/data_fetcher.py ./geo/grace/data_fetcher.py ./geo/mahali/tec/data_fetcher.py ./geo/mahali/rinex/data_wrapper.py ./geo/mahali/rinex/data_fetcher.py ./geo/mahali/temperature/data_fetcher.py ./geo/ngl_gps/data_fetcher.py ./geo/era_interim/cache/data_fetcher.py ./geo/imsdnhs/data_fetcher.py ./geo/gldas/data_fetcher.py ./geo/sentinel_1/cache/data_fetcher.py ./geo/magnetometer/data_fetcher.py ./geo/wyoming_sounding/cache/data_fetcher.py ./geo/wyoming_sounding/stream/data_fetcher.py ./geo/modis/cache/cloud_opacity/data_fetcher.py ./geo/modis/cache/cloud_mask/data_fetcher.py ./geo/modis/cache/reflectance/data_fetcher.py ./geo/modis/cache/data_fetcher.py ./geo/modis/stream/cloud_opacity/data_fetcher.py ./geo/modis/stream/cloud_mask/data_fetcher.py ./geo/modis/stream/reflectance/data_fetcher.py ./geo/modis/stream/data_fetcher.py ./geo/uavsar/cache/data_fetcher.py ./geo/srtm/cache/data_fetcher.py ./geo/groundwater/data_fetcher.py ./geo/pbo/data_fetcher.py ./utilities/srtm_util.py ./utilities/modis_util.py ./utilities/support.py ./utilities/kepler_util.py ./utilities/grace_util.py ./utilities/sentinel_1_util.py ./utilities/mahali_util.py ./utilities/file_util.py ./utilities/file_browser.py ./utilities/pbo_util.py ./utilities/image_util.py ./utilities/uavsar_util.py ./utilities/ode_util.py ./utilities/gw_util.py ./utilities/sounding_util.py ./finance/timeseries/stream.py ./astro/spectra/stream.py ./astro/kepler/data_fetcher.py ./astro/voyager/data_fetcher.py ./engineering/la/generic/stream.py ./engineering/la/traffic_counts/stream.py ./engineering/webcam/mit_sailing/stream.py
+INPUT                  = ./geo/era_interim/cache/data_fetcher.py ./geo/modis/cache/reflectance/data_fetcher.py ./geo/modis/cache/data_fetcher.py ./geo/modis/cache/cloud_opacity/data_fetcher.py ./geo/modis/cache/cloud_mask/data_fetcher.py ./geo/modis/stream/reflectance/data_fetcher.py ./geo/modis/stream/data_fetcher.py ./geo/modis/stream/cloud_opacity/data_fetcher.py ./geo/modis/stream/cloud_mask/data_fetcher.py ./geo/gldas/data_fetcher.py ./geo/uavsar/cache/data_fetcher.py ./geo/pbo/data_fetcher.py ./geo/grace/data_fetcher.py ./geo/grace/mascon/cache/data_fetcher.py ./geo/sentinel_1/cache/data_fetcher.py ./geo/groundwater/data_fetcher.py ./geo/srtm/cache/data_fetcher.py ./geo/mahali/temperature/data_fetcher.py ./geo/mahali/rinex/data_wrapper.py ./geo/mahali/rinex/data_fetcher.py ./geo/mahali/tec/data_fetcher.py ./geo/magnetometer/data_fetcher.py ./geo/ngl_gps/data_fetcher.py ./geo/wyoming_sounding/cache/data_fetcher.py ./geo/wyoming_sounding/stream/data_fetcher.py ./geo/imsdnhs/data_fetcher.py ./framework/data_class.py ./framework/param_class.py ./utilities/mahali_util.py ./utilities/grace_util.py ./utilities/modis_util.py ./utilities/support.py ./utilities/sounding_util.py ./utilities/ode_util.py ./utilities/image_util.py ./utilities/srtm_util.py ./utilities/file_util.py ./utilities/file_browser.py ./utilities/uavsar_util.py ./utilities/kepler_util.py ./utilities/pbo_util.py ./utilities/sentinel_1_util.py ./utilities/tess_utils.py ./utilities/gw_util.py ./examples/terminal_groundwater_example.py ./astro/kepler/data_fetcher.py ./astro/spectra/stream.py ./astro/tess/generic/cache.py ./astro/tess/data/cache.py ./astro/tess/simulated/cache.py ./astro/voyager/data_fetcher.py ./solar/sdo/data_fetcher.py ./planetary/ode/cache/data_fetcher.py ./finance/timeseries/stream.py ./engineering/webcam/mit_sailing/stream.py ./engineering/la/traffic_counts/stream.py ./engineering/la/generic/stream.py
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = 
 RECURSIVE              = NO

skdaccess/fix_latex.sh

@@ -1 +1 @@
-gsed -ri 's/\\\+data\\\+\\_\\\+fetcher\.//g' *.tex
+sed -ri 's/\\\+data\\\+\\_\\\+fetcher\.//g' *.tex