X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/992a343b1c78aeaa23c2d481f7f8655e11f777bf..refs/heads/american-units:/infoex-autowx.py

diff --git a/infoex-autowx.py b/infoex-autowx.py
index 87c9c4a..0b3305d 100755
--- a/infoex-autowx.py
+++ b/infoex-autowx.py
@@ -43,7 +43,7 @@ import zeep
 import zeep.cache
 import zeep.transports
 
-__version__ = '3.3.0'
+__version__ = '3.3.1'
 
 LOG = logging.getLogger(__name__)
 LOG.setLevel(logging.NOTSET)
@@ -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']
 
@@ -244,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':
@@ -319,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
         #
@@ -430,6 +456,10 @@ def setup_infoex_counterparts_mapping(provider):
         iemap['WDIR'] = 'windDirectionNum'
         # unsupported by NRCS:
         # windGustSpeedNum
+
+        # NOTE: this doesn't exist in NRCS SNOTEL, we create it in this
+        #       program, so add it to the map here
+        iemap['hn24'] = 'hn24Auto'
     elif provider == 'mesowest':
         iemap['precip_accum'] = 'precipitationGauge'
         iemap['air_temp'] = 'tempPres'
@@ -499,6 +529,44 @@ def get_nrcs_data(begin, end, station):
         else:
             remote_data[element_cd] = None
 
+
+        # calc hn24, if applicable
+        hn24 = None
+
+        if station['hn24']:
+            hn24_values = []
+
+            if element_cd == "SNWD":
+                for idx, _ in enumerate(values):
+                    val = values[idx]
+                    if val is None:
+                        continue
+                    hn24_values.append(val['value'])
+
+                if len(hn24_values) > 0:
+                    # instead of taking MAX - MIN, we want the first
+                    # value (most distant) - the last value (most
+                    # recent)
+                    #
+                    # if the result is positive, then we have
+                    # settlement; if it's not, then we have HN24
+                    hn24 = hn24_values[0] - hn24_values[len(hn24_values)-1]
+
+                    if hn24 < 0.0:
+                        hn24 = abs(hn24)
+                    else:
+                        # this case represents HS settlement
+                        hn24 = 0.0
+
+            # finally, if user wants hn24 and it's set to None at this
+            # point, then force it to 0.0
+            if hn24 is None:
+                hn24 = 0.0
+
+        if hn24 is not None:
+            if station['hn24']:
+                remote_data['hn24'] = hn24
+
     return remote_data
 
 def get_mesowest_data(begin, end, station):
@@ -627,7 +695,24 @@ def get_mesowest_data(begin, end, station):
             remote_data[element_cd] = None
 
     if len(hn24_values) > 0:
-        hn24 = max(hn24_values) - min(hn24_values)
+        # instead of taking MAX - MIN, we want the first value (most
+        # distant) - the last value (most recent)
+        #
+        # if the result is positive, then we have settlement; if it's not,
+        # then we have HN24
+        hn24 = hn24_values[0] - hn24_values[len(hn24_values)-1]
+
+        if hn24 < 0.0:
+            hn24 = abs(hn24)
+        else:
+            # this case represents HS settlement
+            hn24 = 0.0
+
+
+    # finally, if user wants hn24 and it's set to None at this
+    # point, then force it to 0.0
+    if station['hn24'] and hn24 is None:
+        hn24 = 0.0
 
     if len(wind_speed_values) > 0:
         wind_speed_avg = sum(wind_speed_values) / len(wind_speed_values) 
@@ -639,7 +724,8 @@ def get_mesowest_data(begin, end, station):
         wind_direction_avg = sum(wind_direction_values) / len(wind_direction_values) 
 
     if hn24 is not None:
-        remote_data['hn24'] = hn24
+        if station['hn24']:
+            remote_data['hn24'] = hn24
 
     # overwrite the following with the respective averages, if
     # applicable
@@ -672,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':
@@ -682,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"""
@@ -728,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
@@ -745,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__":