pypromice 1.4.3__py3-none-any.whl → 1.5.0__py3-none-any.whl

pypromice/postprocess/bufr_utilities.py

@@ -120,7 +120,8 @@ class BUFRVariables:
     )
     # https://vocabulary-manager.eumetsat.int/vocabularies/BUFR/WMO/32/TABLE_B/012101
     # Scale: 2, unit: K
-    airTemperature: float = attrs.field(converter=round_converter(2))
+    # NOTE: The expected scale is 2, but our instantanous data is rounded to 1 decimal.
+    airTemperature: float = attrs.field(converter=round_converter(1))
     # There is also a Dewpoint temperature in this template: 012103 which is currently unused.
     # https://vocabulary-manager.eumetsat.int/vocabularies/BUFR/WMO/32/TABLE_B/012103
     # Scale: 0, unit: %

pypromice/process/L1toL2.py

@@ -92,9 +92,9 @@ def toL2(
     baseline_elevation = (ds.gps_alt.to_series().resample('MS').median()
                           .reindex(ds.time.to_series().index, method='nearest')
                           .ffill().bfill())
-    mask = (np.abs(ds.gps_alt - baseline_elevation) < 100) & ds.gps_alt.notnull()
+    mask = (np.abs(ds.gps_alt - baseline_elevation) < 100) | ds.gps_alt.isnull()
     ds[['gps_alt','gps_lon', 'gps_lat']] = ds[['gps_alt','gps_lon', 'gps_lat']].where(mask)
-    
+
     # removing dlr and ulr that are missing t_rad
     # this is done now becasue t_rad can be filtered either manually or with persistence
     ds['dlr'] = ds.dlr.where(ds.t_rad.notnull())
@@ -102,23 +102,23 @@ def toL2(
 
     # calculating realtive humidity with regard to ice
     T_100 = _getTempK(T_0)
-    ds['rh_u_cor'] = correctHumidity(ds['rh_u'], ds['t_u'],
+    ds['rh_u_wrt_ice_or_water'] = adjustHumidity(ds['rh_u'], ds['t_u'],
                                      T_0, T_100, ews, ei0)
 
     if ds.attrs['number_of_booms']==2:
-        ds['rh_l_cor'] = correctHumidity(ds['rh_l'], ds['t_l'],
+        ds['rh_l_wrt_ice_or_water'] = adjustHumidity(ds['rh_l'], ds['t_l'],
                                          T_0, T_100, ews, ei0)
 
     if hasattr(ds,'t_i'):
         if ~ds['t_i'].isnull().all():
-            ds['rh_i_cor'] = correctHumidity(ds['rh_i'], ds['t_i'],
+            ds['rh_i_wrt_ice_or_water'] = adjustHumidity(ds['rh_i'], ds['t_i'],
                                              T_0, T_100, ews, ei0)
-    
+
     # Determiune cloud cover for on-ice stations
     cc = calcCloudCoverage(ds['t_u'], T_0, eps_overcast, eps_clear,        # Calculate cloud coverage
                            ds['dlr'], ds.attrs['station_id'])
     ds['cc'] = (('time'), cc.data)
-    
+
     # Determine surface temperature
     ds['t_surf'] = calcSurfaceTemperature(T_0, ds['ulr'], ds['dlr'],           # Calculate surface temperature
                                           emissivity)
@@ -136,7 +136,7 @@ def toL2(
     else:
         lat = ds['gps_lat'].mean()
         lon = ds['gps_lon'].mean()
-    
+
     # smoothing tilt and rot
     ds['tilt_x'] = smoothTilt(ds['tilt_x'])
     ds['tilt_y'] = smoothTilt(ds['tilt_y'])
@@ -151,8 +151,8 @@ def toL2(
     ZenithAngle_rad, ZenithAngle_deg = calcZenith(lat, Declination_rad,        # Calculate zenith
                                                   HourAngle_rad, deg2rad,
                                                   rad2deg)
-    
-    
+
+
     # Correct Downwelling shortwave radiation
     DifFrac = 0.2 + 0.8 * cc
     CorFac_all = calcCorrectionFactor(Declination_rad, phi_sensor_rad,         # Calculate correction
@@ -186,9 +186,9 @@ def toL2(
     TOA_crit_nopass = (ds['dsr_cor'] > (0.9 * isr_toa + 10))                   # Determine filter
     ds['dsr_cor'][TOA_crit_nopass] = np.nan                                    # Apply filter and interpolate
     ds['usr_cor'][TOA_crit_nopass] = np.nan
-    
-    ds['dsr_cor'] = ds.dsr_cor.where(ds.dsr.notnull())  
-    ds['usr_cor'] = ds.usr_cor.where(ds.usr.notnull())  
+
+    ds['dsr_cor'] = ds.dsr_cor.where(ds.dsr.notnull())
+    ds['usr_cor'] = ds.usr_cor.where(ds.usr.notnull())
     # # Check sun position
     # sundown = ZenithAngle_deg >= 90
     # _checkSunPos(ds, OKalbedos, sundown, sunonlowerdome, TOA_crit_nopass)
@@ -205,27 +205,33 @@ def toL2(
             ds['precip_l_cor'], ds['precip_l_rate']= correctPrecip(ds['precip_l'],
                                                                    ds['wspd_l'])
 
-    # Get directional wind speed 
-    ds['wdir_u'] = ds['wdir_u'].where(ds['wspd_u'] != 0)                   
-    ds['wspd_x_u'], ds['wspd_y_u'] = calcDirWindSpeeds(ds['wspd_u'], ds['wdir_u']) 
+    get_directional_wind_speed(ds)                                            # Get directional wind speed
+
+    ds = clip_values(ds, vars_df)
+    return ds
+
+def get_directional_wind_speed(ds: xr.Dataset) -> xr.Dataset:
+    """
+    Calculate directional wind speed from wind speed and direction and mutates the dataset
+    """
+
+    ds['wdir_u'] = ds['wdir_u'].where(ds['wspd_u'] != 0)
+    ds['wspd_x_u'], ds['wspd_y_u'] = calcDirWindSpeeds(ds['wspd_u'], ds['wdir_u'])
 
-    if ds.attrs['number_of_booms']==2:                                         
-        ds['wdir_l'] = ds['wdir_l'].where(ds['wspd_l'] != 0) 
+    if ds.attrs['number_of_booms']==2:
+        ds['wdir_l'] = ds['wdir_l'].where(ds['wspd_l'] != 0)
         ds['wspd_x_l'], ds['wspd_y_l'] = calcDirWindSpeeds(ds['wspd_l'], ds['wdir_l'])
 
     if hasattr(ds, 'wdir_i'):
         if ~ds['wdir_i'].isnull().all() and ~ds['wspd_i'].isnull().all():
-            ds['wdir_i'] = ds['wdir_i'].where(ds['wspd_i'] != 0)                   
-            ds['wspd_x_i'], ds['wspd_y_i'] = calcDirWindSpeeds(ds['wspd_i'], ds['wdir_i'])   
-    
-
-    ds = clip_values(ds, vars_df)
+            ds['wdir_i'] = ds['wdir_i'].where(ds['wspd_i'] != 0)
+            ds['wspd_x_i'], ds['wspd_y_i'] = calcDirWindSpeeds(ds['wspd_i'], ds['wdir_i'])
     return ds
 
 
 def calcDirWindSpeeds(wspd, wdir, deg2rad=np.pi/180):
     '''Calculate directional wind speed from wind speed and direction
-    
+
     Parameters
     ----------
     wspd : xr.Dataarray
@@ -234,16 +240,16 @@ def calcDirWindSpeeds(wspd, wdir, deg2rad=np.pi/180):
         Wind direction data array
     deg2rad : float
         Degree to radians coefficient. The default is np.pi/180
-    
+
     Returns
     -------
     wspd_x : xr.Dataarray
         Wind speed in X direction
     wspd_y : xr.Datarray
         Wind speed in Y direction
-    '''        
+    '''
     wspd_x = wspd * np.sin(wdir * deg2rad)
-    wspd_y = wspd * np.cos(wdir * deg2rad) 
+    wspd_y = wspd * np.cos(wdir * deg2rad)
     return wspd_x, wspd_y
 
 
@@ -328,7 +334,7 @@ def smoothTilt(da: xr.DataArray, threshold=0.2):
         either X or Y smoothed tilt inclinometer measurements
     '''
     # we calculate the moving standard deviation over a 3-day sliding window
-    # hourly resampling is necessary to make sure the same threshold can be used 
+    # hourly resampling is necessary to make sure the same threshold can be used
     # for 10 min and hourly data
     moving_std_gap_filled = da.to_series().resample('h').median().rolling(
                     3*24, center=True, min_periods=2
@@ -413,9 +419,12 @@ def calcTilt(tilt_x, tilt_y, deg2rad):
     return phi_sensor_rad, theta_sensor_rad
 
 
-def correctHumidity(rh, T, T_0, T_100, ews, ei0):                        #TODO figure out if T replicate is needed
-    '''Correct relative humidity using Groff & Gratch method, where values are
-    set when freezing and remain the original values when not freezing
+def adjustHumidity(rh, T, T_0, T_100, ews, ei0):                        #TODO figure out if T replicate is needed
+    '''Adjust relative humidity so that values are given with respect to
+    saturation over ice in subfreezing conditions, and with respect to
+    saturation over water (as given by the instrument) above the melting
+    point temperature. Saturation water vapors are calculated after
+    Groff & Gratch method.
 
     Parameters
     ----------
@@ -434,7 +443,7 @@ def correctHumidity(rh, T, T_0, T_100, ews, ei0):                        #TODO f
 
     Returns
     -------
-    rh_cor : xarray.DataArray
+    rh_wrt_ice_or_water : xarray.DataArray
         Corrected relative humidity
     '''
     # Convert to hPa (Groff & Gratch)
@@ -452,8 +461,8 @@ def correctHumidity(rh, T, T_0, T_100, ews, ei0):                        #TODO f
     freezing = (T < 0) & (T > -100).values
 
     # Set to Groff & Gratch values when freezing, otherwise just rh
-    rh_cor = rh.where(~freezing, other = rh*(e_s_wtr / e_s_ice))
-    return rh_cor
+    rh_wrt_ice_or_water = rh.where(~freezing, other = rh*(e_s_wtr / e_s_ice))
+    return rh_wrt_ice_or_water
 
 
 def correctPrecip(precip, wspd):