Merge branch 'release-3.1.0' into develop
[infoex-autowx.git] / infoex-autowx.py
index c191e5c767c627f539ab1c8194ab8f6314ce5c81..f2be003d5c792c62f3153a4d2b7ac4404e697eb0 100755 (executable)
@@ -33,13 +33,15 @@ import time
 from ftplib import FTP
 from argparse import ArgumentParser
 
+import pytz
+
 import requests
 
 import zeep
 import zeep.cache
 import zeep.transports
 
-__version__ = '2.2.0'
+__version__ = '3.1.0'
 
 LOG = logging.getLogger(__name__)
 LOG.setLevel(logging.NOTSET)
@@ -115,6 +117,17 @@ def setup_config(config):
         if station['provider'] == 'python':
             station['path'] = config['station']['path']
 
+        tz = 'America/Los_Angeles'
+
+        if 'tz' in config['station']:
+            tz = config['station']['tz']
+
+        try:
+            station['tz'] = pytz.timezone(tz)
+        except pytz.exceptions.UnknownTimeZoneError:
+            LOG.critical("%s is not a valid timezone", tz)
+            sys.exit(1)
+
     except KeyError as err:
         LOG.critical("%s not defined in configuration file", err)
         sys.exit(1)
@@ -196,14 +209,14 @@ def main():
                       "file")
             sys.exit(1)
 
-    (begin_date, end_date) = setup_time_values()
+    (begin_date, end_date) = setup_time_values(station)
 
     if station['provider'] == 'python':
         LOG.debug("Getting custom data from external Python program")
     else:
-        LOG.debug("Getting %s data from %s to %s",
+        LOG.debug("Getting %s data from %s to %s (%s)",
                   str(station['desired_data']),
-                  str(begin_date), str(end_date))
+                  str(begin_date), str(end_date), end_date.tzinfo.zone)
 
     time_all_elements = time.time()
 
@@ -230,7 +243,7 @@ def main():
                     infoex['wx_data'] = []
             except Exception as exc:
                 LOG.error("Python program for custom Wx data failed in "
-                          "execution: " + str(exc))
+                          "execution: %s", str(exc))
                 sys.exit(1)
 
             LOG.info("Successfully executed external Python program")
@@ -243,7 +256,7 @@ def main():
             sys.exit(1)
         except Exception as exc:
             LOG.error("A problem was encountered when attempting to "
-                      "load your custom Wx program: " + str(exc))
+                      "load your custom Wx program: %s", str(exc))
             sys.exit(1)
 
     LOG.info("Time taken to get all data : %.3f sec", time.time() -
@@ -251,11 +264,14 @@ def main():
 
     LOG.debug("infoex[wx_data]: %s", str(infoex['wx_data']))
 
+    # timezone massaging
+    final_end_date = end_date.astimezone(station['tz'])
+
     # Now we only need to add in what we want to change thanks to that
     # abomination of a variable declaration earlier
     final_data[fmap['Location UUID']] = infoex['location_uuid']
-    final_data[fmap['obDate']] = end_date.strftime('%m/%d/%Y')
-    final_data[fmap['obTime']] = end_date.strftime('%H:%M')
+    final_data[fmap['obDate']] = final_end_date.strftime('%m/%d/%Y')
+    final_data[fmap['obTime']] = final_end_date.strftime('%H:%M')
 
     for element_cd in infoex['wx_data']:
         if element_cd not in iemap:
@@ -266,14 +282,15 @@ def main():
         # expectations
         #
         # 0 decimal places: wind speed, wind direction, wind gust, snow depth
-        # 1 decimal place:  air temp, baro
+        # 1 decimal place:  air temp, relative humidity, baro
         # Avoid transforming None values
         if infoex['wx_data'][element_cd] is None:
             continue
         elif element_cd in ['wind_speed', 'WSPD', 'wind_direction',
                             'WDIR', 'wind_gust', 'SNWD', 'snow_depth']:
             infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd])
-        elif element_cd in ['TOBS', 'air_temp', 'PRES', 'pressure']:
+        elif element_cd in ['TOBS', 'air_temp', 'RHUM',
+                            'relative_humidity', 'PRES', 'pressure']:
             infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd], 1)
 
         # CONSIDER: Casting every value to Float() -- need to investigate if
@@ -289,7 +306,7 @@ def main():
 
     LOG.debug("final_data: %s", str(final_data))
 
-    if len(infoex['wx_data']) > 0:
+    if infoex['wx_data']:
         if not write_local_csv(infoex['csv_filename'], final_data):
             LOG.warning('Could not write local CSV file: %s',
                         infoex['csv_filename'])
@@ -403,6 +420,10 @@ def get_nrcs_data(begin, end, station):
     client = zeep.Client(wsdl=station['source'], transport=transport)
     remote_data = {}
 
+    # massage begin/end date format
+    begin_date_str = begin.strftime('%Y-%m-%d %H:%M:00')
+    end_date_str = end.strftime('%Y-%m-%d %H:%M:00')
+
     for element_cd in station['desired_data']:
         time_element = time.time()
 
@@ -411,8 +432,8 @@ def get_nrcs_data(begin, end, station):
             stationTriplets=[station['station_id']],
             elementCd=element_cd,
             ordinal=1,
-            beginDate=begin,
-            endDate=end)
+            beginDate=begin_date_str,
+            endDate=end_date_str)
 
         LOG.info("Time to get NRCS elementCd '%s': %.3f sec", element_cd,
                  time.time() - time_element)
@@ -474,9 +495,16 @@ def get_mesowest_data(begin, end, station):
 
         # we may not have the data at all
         key_name = element_cd + '_set_1'
+
         if key_name in observations:
             if observations[key_name][pos]:
                 remote_data[element_cd] = observations[key_name][pos]
+
+                # mesowest by default provides wind_speed in m/s, but
+                # we specify 'english' units in the request; either way,
+                # we want mph
+                if element_cd in ('wind_speed', 'wind_gust'):
+                    remote_data[element_cd] = kn_to_mph(remote_data[element_cd])
             else:
                 remote_data[element_cd] = None
         else:
@@ -525,15 +553,31 @@ def upload_csv(path_to_file, infoex_data):
     os.remove(path_to_file)
 
 # other miscellaneous routines
-def setup_time_values():
+def setup_time_values(station):
     """establish time bounds of data request(s)"""
+
+    # default timezone to UTC (for MesoWest)
+    tz = pytz.utc
+
+    # but for NRCS, use the config-specified timezone
+    if station['provider'] == 'nrcs':
+        tz = station['tz']
+
     # floor time to nearest hour
-    date_time = datetime.datetime.now()
+    date_time = datetime.datetime.now(tz=tz)
     end_date = date_time - datetime.timedelta(minutes=date_time.minute % 60,
                                               seconds=date_time.second,
                                               microseconds=date_time.microsecond)
     begin_date = end_date - datetime.timedelta(hours=3)
     return (begin_date, end_date)
 
+def ms_to_mph(ms):
+    """convert meters per second to miles per hour"""
+    return ms * 2.236936
+
+def kn_to_mph(kn):
+    """convert knots to miles per hour"""
+    return kn * 1.150779
+
 if __name__ == "__main__":
     sys.exit(main())