First stab at "American" units implementation

diff --git a/infoex-autowx.py b/infoex-autowx.py
index 9b72eeee3bd0749994ee7910e3c902be023b7ce1..0b3305d289a80cd7f6771c5b4ad2c3974a10721a 100755 (executable)
--- a/infoex-autowx.py
+++ b/infoex-autowx.py
@@ -89,28 +89,47 @@ def setup_config(config):
         }
 
         station = dict()
+
         station['provider'] = config['station']['type']
 
         if station['provider'] not in ['nrcs', 'mesowest', 'python']:
             print("Please specify either nrcs or mesowest as the station type.")
             sys.exit(1)
 
+        # massage units config items first
+        #
+        # NOTE: custom providers don't require units to be specified
+        #       because they can do whatever they please with the units
+        #       within their own program
+        if station['provider'] != "custom":
+            station['units'] = config['station']['units']
+
+            if station['units'] not in ['metric', 'english', 'american']:
+                print("Please specify either metric, english, or american for the units.")
+                sys.exit(1)
+            else:
+                # if units are specified as "American" then we simply
+                # default to metric for the requests
+                if station['units'] == 'american':
+                    station['units_requested'] = 'metric'
+                else:
+                    station['units_requested'] = station['units']
+
+        # massage provider config items
         if station['provider'] == 'nrcs':
             station['source'] = 'https://www.wcc.nrcs.usda.gov/awdbWebService/services?WSDL'
             station['station_id'] = config['station']['station_id']
             station['desired_data'] = config['station']['desired_data'].split(',')
-            station['units'] = config['station']['units']
 
         if station['provider'] == 'mesowest':
             station['source'] = 'https://api.synopticdata.com/v2/stations/timeseries'
             station['station_id'] = config['station']['station_id']
-            station['units'] = config['station']['units']
             station['desired_data'] = config['station']['desired_data']
 
             # construct full API URL (sans start/end time, added later)
             station['source'] = station['source'] + '?token=' + \
                                 config['station']['token'] + \
-                                '&within=60&units=' + station['units'] + \
+                                '&within=60&units=' + station['units_requested'] + \
                                 '&stid=' + station['station_id'] + \
                                 '&vars=' + station['desired_data']
 
@@ -128,10 +147,6 @@ def setup_config(config):
             LOG.critical("%s is not a valid timezone", tz)
             sys.exit(1)
 
-        if station['units'] not in ['metric', 'english', 'american']:
-            print("Please specify either metric, english, or american for the units.")
-            sys.exit(1)
-
         # By default, fetch three hours of data
         #
         # If user wants hn24 or wind averaging, then
@@ -248,6 +263,10 @@ def main():
     if station['provider'] != 'python' and station['units'] == 'metric':
         final_data = switch_units_to_metric(final_data, fmap)
 
+    # likewise for "American" units
+    if station['provider'] != 'python' and station['units'] == 'american':
+        final_data = switch_units_to_american(final_data, fmap)
+
     (begin_date, end_date) = setup_time_values(station)
 
     if station['provider'] == 'python':
@@ -323,6 +342,9 @@ def main():
         if station['provider'] == 'nrcs' and station['units'] == 'metric':
             infoex['wx_data'][element_cd] = convert_nrcs_units_to_metric(element_cd, infoex['wx_data'][element_cd])
 
+        if station['provider'] != 'custom' and station['units'] == 'american':
+            infoex['wx_data'][element_cd] = convert_units_to_american(element_cd, infoex['wx_data'][element_cd])
+
         # Massage precision of certain values to fit InfoEx's
         # expectations
         #
@@ -736,6 +758,33 @@ def switch_units_to_metric(data_map, mapping):
 
     return data_map
 
+def switch_units_to_american(data_map, mapping):
+    """
+    replace units with the American mixture of metric and imperial
+
+    Precip values = imperial
+    Wind values = metric
+    """
+
+    # precip values
+    data_map[mapping['tempMaxHourUnit']] = 'F'
+    data_map[mapping['tempMinHourUnit']] = 'F'
+    data_map[mapping['tempPresUnit']] = 'F'
+    data_map[mapping['dewPointUnit']] = 'F'
+
+    data_map[mapping['precipitationGaugeUnit']] = 'in'
+    data_map[mapping['hsUnit']] = 'in'
+    data_map[mapping['hn24AutoUnit']] = 'in'
+    data_map[mapping['hstAutoUnit']] = 'in'
+
+    data_map[mapping['baroUnit']] = 'inHg'
+
+    # wind values
+    data_map[mapping['windSpeedUnit']] = 'm/s'
+    data_map[mapping['windGustSpeedNumUnit']] = 'm/s'
+
+    return data_map
+
 def convert_nrcs_units_to_metric(element_cd, value):
     """convert NRCS values from English to metric"""
     if element_cd == 'TOBS':
@@ -746,6 +795,38 @@ def convert_nrcs_units_to_metric(element_cd, value):
         value = in_to_mm(value)
     return value
 
+def convert_units_to_american(element_cd, value):
+    """
+    convert value to 'American' units
+
+    The original unit is always metric.
+
+    Precip values = imperial
+    Wind values = metric
+    """
+
+    # temp values
+    if element_cd in ['TMAX', 'TMIN', 'TOBS', 'air_temp', 'air_temp_high_24_hour', 'air_temp_low_24_hour']:
+        value = c_to_f(value)
+
+    # snow values
+    if element_cd in ['SNWD', 'snow_depth']:
+        value = cm_to_in(mm_to_cm(value))
+
+    # likewise for baro values
+    if element_cd in ['PRES', 'pressure']:
+        value = pascal_to_inhg(value)
+
+    # no need to convert wind values, as they will arrive in metric
+    # units in "American" units mode
+    # [
+    # 'WSPD',
+    # 'wind_speed', 'wind_gust'
+    # ]
+    # in_to_mm(value)
+
+    return value
+
 # CSV operations
 def write_local_csv(path_to_file, data):
     """Write the specified CSV file to disk"""
@@ -792,10 +873,22 @@ def f_to_c(f):
     """convert Fahrenheit to Celsius"""
     return (float(f) - 32) * 5.0/9.0
 
+def c_to_f(c):
+    """convert Celsius to Fahrenheit"""
+    return (float(c) * 1.8) + 32
+
 def in_to_cm(inches):
-    """convert inches to centimetrs"""
+    """convert inches to centimeters"""
     return float(inches) * 2.54
 
+def cm_to_in(cms):
+    """convert centimeters to inches"""
+    return float(cms) / 2.54
+
+def pascal_to_inhg(pa):
+    """convert pascals to inches of mercury"""
+    return float(pa) * 0.00029530
+
 def in_to_mm(inches):
     """convert inches to millimeters"""
     return (float(inches) * 2.54) * 10.0
@@ -809,7 +902,7 @@ def kn_to_mph(kn):
     return kn * 1.150779
 
 def mm_to_cm(mm):
-    """convert millimeters to centimetrs"""
+    """convert millimeters to centimeters"""
     return mm / 10.0
 
 if __name__ == "__main__":