ETo 1.1.1__py3-none-any.whl

eto/__init__.py

@@ -0,0 +1,5 @@
+from eto.core import ETo
+import eto.datasets
+import eto.methods
+
+__version__ = '1.1.1'

eto/core.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+"""
+Class to estimate reference ET (ETo) from the FAO 56 paper using a minimum of T_min and T_max for daily estimates and T_mean and RH_mean for hourly, but utilizing the maximum number of available met parameters. The function prioritizes the estimation of specific parameters based on the available input data.
+"""
+import pandas as pd
+from copy import copy
+from eto.param_est import param_est
+from eto.methods.ETo import eto_fao
+from eto.methods.hargreaves import hargreaves
+
+#from param_est import param_est
+#from methods.ETo import eto_fao
+#from methods.hargreaves import hargreaves
+
+
+class ETo(object):
+    """
+    Class to handle the parameter estimation of metereological values and the calcuation of reference ET and similar ET methods.
+
+    This class can be either initiated with empty parameters or will initialise to the param_est function.
+    """
+
+
+    def __init__(self, df=None, freq='D', z_msl=None, lat=None, lon=None, TZ_lon=None, z_u=2, K_rs=0.16, a_s=0.25, b_s=0.5, alb=0.23):
+
+        if df is None:
+            pass
+        else:
+            self.param_est(df, freq, z_msl, lat, lon, TZ_lon, z_u, K_rs, a_s, b_s, alb)
+
+
+    @staticmethod
+    def tsreg(ts, freq=None, interp=False, maxgap=None):
+        """
+        Function to regularize a time series object (pandas).
+        The first three indexes must be regular for freq=None!!!
+
+        Parameters
+        ----------
+        ts : DataFrame
+            With a DateTimeIndex.
+        freq : str or None
+            Either specify the known frequency of the data or use None and
+        determine the frequency from the first three indices.
+        interp : str
+            Interpolation method fro the pandas interpolate method.
+
+        Returns
+        -------
+        DataFrame
+        """
+        if freq is None:
+            freq = pd.infer_freq(ts.index[:3])
+        ts1 = ts.resample(freq).mean()
+        if isinstance(interp, str):
+            ts1 = ts1.interpolate(interp, limit=maxgap)
+
+        return ts1
+
+
+### Add in the ETo methods and other functions
+ETo.param_est = param_est
+ETo.eto_fao = eto_fao
+ETo.eto_hargreaves = hargreaves
+ETo.copy = copy

eto/datasets/__init__.py

@@ -0,0 +1,27 @@
+import os
+
+
+__all__ = ['available', 'get_path']
+
+_module_path = os.path.dirname(__file__)
+_available_csv = {p.split('.')[0]: p for p in os.listdir(_module_path) if p.endswith('.csv.zip')}
+available = list(_available_csv.keys())
+
+
+def get_path(dataset):
+    """
+    Get the path to the data file.
+
+    Parameters
+    ----------
+    dataset : str
+        The name of the dataset. See ``geopandas.datasets.available`` for
+        all options.
+
+    """
+    if dataset in _available_csv:
+        return os.path.abspath(
+            os.path.join(_module_path, _available_csv[dataset]))
+    else:
+        msg = f"The dataset '{dataset}' is not available"
+        raise ValueError(msg)

eto/methods/ETo.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+"""
+Function to estimate reference ET (ETo) from the FAO 56 paper using a minimum of T_min and T_max for daily estimates and T_mean and RH_mean for hourly, but utilizing the maximum number of available met parameters.
+"""
+import pandas as pd
+import numpy as np
+
+
+def eto_fao(self, max_ETo=15, min_ETo=0, interp=False, maxgap=15):
+    """
+    Function to estimate reference ET (ETo) from the `FAO 56 paper <http://www.fao.org/docrep/X0490E/X0490E00.htm>`_ [1]_ using a minimum of T_min and T_max for daily estimates and T_mean and RH_mean for hourly, but optionally utilising the maximum number of available met parameters. The function prioritizes the estimation of specific parameters based on the available input data.
+
+    Parameters
+    ----------
+    max_ETo : float or int
+        The max realistic value of ETo (mm).
+    min_ETo : float or int
+        The min realistic value of ETo (mm).
+    interp : False or str
+        Should missing values be filled by interpolation? Either False if no interpolation should be performed, or a string of the interpolation method. See Pandas interpolate function for methods. Recommended interpolators are 'linear' or 'pchip'.
+    maxgap : int
+        The maximum missing value gap for the interpolation.
+
+    Returns
+    -------
+    DataFrame or Series
+        If fill=False, then the function will return a Series of estimated ETo in mm. If fill is a str, then the function will return a DataFrame with an additional column for the filled ETo value in mm.
+
+    References
+    ----------
+
+    .. [1] Allen, R. G., Pereira, L. S., Raes, D., & Smith, M. (1998). Crop evapotranspiration-Guidelines for computing crop water requirements-FAO Irrigation and drainage paper 56. FAO, Rome, 300(9), D05109.
+    """
+
+    ######
+    ## ETo equation
+    if 'h' in self.freq.lower():
+        ETo_FAO = (0.408*self.ts_param['delta']*(self.ts_param['R_n'] - self.ts_param['G']) + self.ts_param['gamma']*37/(self.ts_param['T_mean'] + 273)*self.ts_param['U_2']*(self.ts_param['e_mean'] - self.ts_param['e_a']))/(self.ts_param['delta'] + self.ts_param['gamma']*(1 + 0.34*self.ts_param['U_2']))
+    else:
+        ETo_FAO = (0.408*self.ts_param['delta']*(self.ts_param['R_n'] - self.ts_param['G']) + self.ts_param['gamma']*900/(self.ts_param['T_mean'] + 273)*self.ts_param['U_2']*(self.ts_param['e_s'] - self.ts_param['e_a']))/(self.ts_param['delta'] + self.ts_param['gamma']*(1 + 0.34*self.ts_param['U_2']))
+
+    ETo_FAO.name = 'ETo_FAO_mm'
+
+    ## Remove extreme values
+    ETo_FAO[ETo_FAO > max_ETo] = np.nan
+    ETo_FAO[ETo_FAO < min_ETo] = np.nan
+
+    ## ETo equation with filled holes using interpolation (use with caution)
+    if isinstance(interp, str):
+        ETo_FAO_fill = self.tsreg(ETo_FAO, self.freq, interp, maxgap)
+        ETo_FAO_fill.name = 'ETo_FAO_interp_mm'
+        ETo = pd.concat([ETo_FAO, ETo_FAO_fill], axis=1).round(2)
+    else:
+        ETo = ETo_FAO.round(2)
+
+    return ETo

eto/methods/__init__.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Sun May 13 21:06:22 2018
+
+@author: MichaelEK
+"""
+

eto/methods/hargreaves.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Sun May 13 09:45:39 2018
+
+@author: MichaelEK
+"""
+import pandas as pd
+import numpy as np
+
+
+def hargreaves(self, max_ETo=15, min_ETo=0, interp=False, maxgap=15):
+    """
+    Function to estimate Hargreaves ETo using a minimum of T_min and T_max, but optionally utilising the maximum number of available met parameters. The function prioritizes the estimation of specific parameters based on the available input data.
+
+    Parameters
+    ----------
+    max_ETo : float or int
+        The max realistic value of ETo (mm).
+    min_ETo : float or int
+        The min realistic value of ETo (mm).
+    interp : False or str
+        Should missing values be filled by interpolation? Either False if no interpolation should be performed, or a string of the interpolation method. See Pandas interpolate function for methods. Recommended interpolators are 'linear' or 'pchip'.
+    maxgap : int
+        The maximum missing value gap for the interpolation.
+
+    Returns
+    -------
+    DataFrame or Series
+        If fill=False, then the function will return a Series of estimated ETo in mm. If fill is a str, then the function will return a DataFrame with an additional column for the filled ETo value in mm.
+    """
+
+    ######
+    ## ETo equation
+
+    if 'h' in self.freq.lower():
+        raise ValueError('Hargreaves should not be calculated at time frequencies of less than a day.')
+
+    ETo_Har = 0.0023*(self.ts_param['T_mean'] + 17.8)*((self.ts_param['T_max'] - self.ts_param['T_min']) **0.5)*self.ts_param['R_a']*0.408
+
+    ETo_Har.name = 'ETo_Har_mm'
+
+    ## Remove extreme values
+    ETo_Har[ETo_Har > max_ETo] = np.nan
+    ETo_Har[ETo_Har < min_ETo] = np.nan
+
+    ## ETo equation with filled holes using interpolation (use with caution)
+    if isinstance(interp, str):
+        ETo_Har_fill = self.tsreg(ETo_Har, self.freq, interp, maxgap)
+        ETo_Har_fill.name = 'ETo_Har_interp_mm'
+        ETo = pd.concat([ETo_Har, ETo_Har_fill], axis=1).round(2)
+    else:
+        ETo = ETo_Har.round(2)
+
+    return ETo
+
+

eto/param_est.py

@@ -0,0 +1,223 @@
+# -*- coding: utf-8 -*-
+"""
+Function for parameter estimation.
+"""
+import numpy as np
+import pandas as pd
+
+
+def param_est(self, df, freq='D', z_msl=None, lat=None, lon=None, TZ_lon=None, z_u=2, K_rs=0.16, a_s=0.25, b_s=0.5, alb=0.23):
+    """
+    Function to estimate the parameters necessary to calculate reference ET (ETo) from the `FAO 56 paper <http://www.fao.org/docrep/X0490E/X0490E00.htm>`_ [1]_ using a minimum of T_min and T_max for daily estimates and T_mean and RH_mean for hourly, but optionally utilising the maximum number of available met parameters. The function prioritizes the estimation of specific parameters based on the available input data.
+
+    Parameters
+    ----------
+    df : DataFrame
+        Input Metereological data (see Notes section).
+    z_msl : float, int, or None
+        Elevation of the met station above mean sea level (m) (only needed if P is not in df).
+    lat : float, int, or None
+        The latitude of the met station (dec deg) (only needed if R_s or R_n are not in df).
+    lon : float, int, or None
+        The longitude of the met station (dec deg) (only needed if calculating ETo hourly)
+    TZ_lon : float, int, or None
+        The longitude of the center of the time zone (dec deg) (only needed if calculating ETo hourly).
+    z_u : float or int
+        The height of the wind speed measurement (m). Default is 2 m.
+    freq : str
+        The Pandas time frequency string of the input and output. The minimum frequency is hours (H) and the maximum is month (M).
+    K_rs : float
+        Rs calc coefficient (0.16 for inland stations, 0.19 for coastal stations)
+    a_s : float
+        Rs calc coefficient
+    b_s : float
+        Rs calc coefficient
+    alb : float
+        Albedo. Should be 0.23 for the reference crop.
+
+    Returns
+    -------
+    DataFrame
+
+    Notes
+    --------
+    The input data must be a DataFrame with specific column names according to the met parameter. The column names should be a minimum of T_min and T_max for daily estimates and T_mean and RH_mean for hourly, but can contain any/all of the following:
+
+    R_n
+        Net radiation (MJ/m2)
+    R_s
+        Incoming shortwave radiation (MJ/m2)
+    G
+        Net soil heat flux (MJ/m2)
+    T_min
+        Minimum Temperature (deg C)
+    T_max
+        Maximum Temperature (deg C)
+    T_mean
+        Mean Temperature (deg C)
+    T_dew
+        Dew point temperature (deg C)
+    RH_min
+        Minimum relative humidity
+    RH_max
+        Maximum relative humidity
+    RH_mean
+        Mean relative humidity
+    n_sun
+        Number of sunshine hours per day
+    U_z
+        Wind speed at height z (m/s)
+    P
+        Atmospheric pressure (kPa)
+    e_a
+        Actual Vapour pressure derrived from RH
+
+
+    Parameter estimation values refer to the quality level of the input parameters into the ETo equations. Where a 0 (or nothing) refers to no necessary parameter estimation (all measurement data was available), while a 1 refers to parameters that have the best input estimations and up to a value of 3 is the worst. Starting from the right, the first value refers to U_z, the second value refers to G, the third value refers to R_n, the fourth value refers to R_s, the fifth value refers to e_a, the sixth value refers to T_mean, the seventh value refers to P.
+
+    References
+    ----------
+
+    .. [1] Allen, R. G., Pereira, L. S., Raes, D., & Smith, M. (1998). Crop evapotranspiration-Guidelines for computing crop water requirements-FAO Irrigation and drainage paper 56. FAO, Rome, 300(9), D05109.
+    """
+
+    met_names = np.array(['R_n', 'R_s', 'G', 'T_min', 'T_max', 'T_mean', 'T_dew', 'RH_min', 'RH_max', 'RH_mean', 'n_sun', 'U_z', 'P', 'e_a'])
+    self.freq = freq
+
+    ####################################
+    ##### Set up the DataFrame and estimated values series
+    new_cols = met_names[~np.isin(met_names, df.columns)]
+    new_df = pd.DataFrame(np.nan, index=df.index, columns=new_cols)
+    self.ts_param = pd.concat([df, new_df], axis=1).copy()
+
+    self.est_val = pd.Series(0, index=self.ts_param.index, name='est_val')
+
+    ####################################
+    ###### Check to make sure minimum requirements are met
+    if 'h' in freq.lower():
+        T_mean_bool = self.ts_param['T_mean'].isnull().any()
+        RH_mean_bool = self.ts_param['RH_mean'].isnull().any()
+        e_a_bool = self.ts_param['e_a'].isnull().any()
+        if T_mean_bool | (RH_mean_bool & e_a_bool):
+            raise ValueError('Minimum data input was not met. Check your data.')
+    else:
+        T_min_bool = self.ts_param['T_min'].isnull().any()
+        T_max_bool = self.ts_param['T_max'].isnull().any()
+        if T_min_bool | T_max_bool:
+            raise ValueError('Minimum data input was not met. Check your data.')
+
+    ####################################
+    ###### Calculations
+
+    ######
+    ### Time index
+    if type(df.index) is not pd.DatetimeIndex:
+        raise ValueError('DataFrame must have a datetime index!')
+
+    # Create the Day of the year vector
+    Day = df.index.dayofyear
+
+    ######
+    ## Atmospheric components
+
+    # Air Pressure
+    self.est_val.loc[self.ts_param['P'].isnull()] = self.est_val.loc[self.ts_param['P'].isnull()] + 1000000
+    self.ts_param.loc[self.ts_param['P'].isnull(), 'P'] = 101.3*((293 - 0.0065*z_msl)/293)**5.26
+
+    # Psychrometric constant
+    self.ts_param['gamma'] = (0.665*10**-3)*self.ts_param['P']
+
+    ######
+    ## Temperature and humidity components
+    self.est_val.loc[self.ts_param['T_mean'].isnull()] = self.est_val.loc[self.ts_param['T_mean'].isnull()] + 100000
+    self.ts_param.loc[self.ts_param['T_mean'].isnull(), 'T_mean'] = (self.ts_param.loc[self.ts_param['T_mean'].isnull(), 'T_max'] + self.ts_param.loc[self.ts_param['T_mean'].isnull(), 'T_min'])/2
+
+    ## Vapor pressures
+    if 'h' in freq.lower():
+        self.ts_param['e_mean'] = 0.6108*np.exp(17.27*self.ts_param['T_mean']/(self.ts_param['T_mean']+237.3))
+        self.ts_param.loc[self.ts_param['e_a'].isnull(), 'e_a'] = self.ts_param.loc[self.ts_param['e_a'].isnull(), 'e_mean']*self.ts_param.loc[self.ts_param['e_a'].isnull(), 'RH_mean']/100
+    else:
+        self.ts_param['e_max'] = 0.6108*np.exp(17.27*self.ts_param['T_max']/(self.ts_param['T_max']+237.3))
+        self.ts_param['e_min'] = 0.6108*np.exp(17.27*self.ts_param['T_min']/(self.ts_param['T_min']+237.3))
+        self.ts_param['e_s'] = (self.ts_param['e_max']+self.ts_param['e_min'])/2
+
+        # e_a if dewpoint temperature is known
+        self.ts_param.loc[self.ts_param['e_a'].isnull(), 'e_a'] = 0.6108*np.exp(17.27*self.ts_param.loc[self.ts_param['e_a'].isnull(), 'T_dew']/(self.ts_param.loc[self.ts_param['e_a'].isnull(), 'T_dew'] + 237.3))
+
+        # e_a if min and max temperatures and humidities are known
+        self.est_val.loc[self.ts_param['T_dew'].isnull()] = self.est_val.loc[self.ts_param['T_dew'].isnull()] + 10000
+        self.ts_param.loc[self.ts_param['e_a'].isnull(), 'e_a'] = (self.ts_param['e_min'][self.ts_param['e_a'].isnull()] * self.ts_param.loc[self.ts_param['e_a'].isnull(), 'RH_max']/100 + self.ts_param['e_max'][self.ts_param['e_a'].isnull()] * self.ts_param.loc[self.ts_param['e_a'].isnull(), 'RH_min']/100)/2
+
+        # self.ts_param['e_a'] if only mean humidity is known
+        self.est_val.loc[self.ts_param['e_a'].isnull()] = self.est_val.loc[self.ts_param['e_a'].isnull()] + 10000
+        self.ts_param.loc[self.ts_param['e_a'].isnull(), 'e_a'] = self.ts_param.loc[self.ts_param['e_a'].isnull(), 'RH_mean']/100*(self.ts_param['e_max'][self.ts_param['e_a'].isnull()] + self.ts_param['e_min'][self.ts_param['e_a'].isnull()])/2
+
+        # e_a if humidity is not known
+        self.est_val.loc[self.ts_param['e_a'].isnull()] = self.est_val.loc[self.ts_param['e_a'].isnull()] + 10000
+        self.ts_param.loc[self.ts_param['e_a'].isnull(), 'e_a'] = 0.6108*np.exp(17.27*self.ts_param.loc[self.ts_param['e_a'].isnull(), 'T_min']/(self.ts_param.loc[self.ts_param['e_a'].isnull(), 'T_min'] + 237.3))
+
+    # Delta
+    self.ts_param['delta'] = 4098*(0.6108*np.exp(17.27*self.ts_param['T_mean']/(self.ts_param['T_mean'] + 237.3)))/((self.ts_param['T_mean'] + 237.3)**2)
+
+
+    ######
+    ## Raditation components
+
+    # R_a
+    phi = lat*np.pi/180
+    delta = 0.409*np.sin(2*np.pi*Day/365-1.39)
+    d_r = 1+0.033*np.cos(2*np.pi*Day/365)
+    w_s = np.arccos(-np.tan(phi)*np.tan(delta))
+
+    if 'h' in freq.lower():
+        hour_vec = df.index.hour
+        b = (2*np.pi*(Day - 81))/364
+        S_c = 0.1645*np.sin(2*b) - 0.1255*np.cos(b) - 0.025*np.sin(b)
+        w = np.pi/12*(((hour_vec+0.5) + 0.6666667*(TZ_lon - lon) + S_c) - 12)
+        w_1 = w - (np.pi*1)/24  # Need to update one day for different hourly periods
+        w_2 = w + (np.pi*1)/24  # Need to update one day for different hourly periods
+
+        self.ts_param['R_a'] = 12*60/np.pi*0.082*d_r*((w_2 - w_1)*np.sin(phi)*np.sin(delta) + np.cos(phi)*np.cos(delta)*(np.sin(w_2) - np.sin(w_1)))
+    else:
+        self.ts_param['R_a'] = 24*60/np.pi*0.082*d_r*(w_s*np.sin(phi)*np.sin(delta) + np.cos(phi)*np.cos(delta)*np.sin(w_s))
+
+    # Daylight hours
+    N = 24*w_s/np.pi
+
+    # R_s if n_sun is known
+    self.est_val.loc[self.ts_param['R_s'].isnull()] = self.est_val.loc[self.ts_param['R_s'].isnull()] + 1000
+    self.ts_param.loc[self.ts_param['R_s'].isnull(), 'R_s'] = (a_s + b_s*self.ts_param.loc[self.ts_param['R_s'].isnull(), 'n_sun']/N[self.ts_param['R_s'].isnull().values])*self.ts_param['R_a'][self.ts_param['R_s'].isnull().values]
+
+    # R_s if n_sun is not known
+    self.est_val.loc[self.ts_param['R_s'].isnull()] = self.est_val.loc[self.ts_param['R_s'].isnull()] + 1000
+    self.ts_param.loc[self.ts_param['R_s'].isnull(), 'R_s'] = K_rs*((self.ts_param.loc[self.ts_param['R_s'].isnull(), 'T_max'] - self.ts_param.loc[self.ts_param['R_s'].isnull(), 'T_min'])**0.5)*self.ts_param['R_a'][self.ts_param['R_s'].isnull().values]
+
+    # R_so
+    R_so = (0.75 + 2*10**(-5)*z_msl)*self.ts_param['R_a']
+
+    # R_ns from R_s
+    R_ns = (1 - alb)*self.ts_param['R_s']
+
+    # R_nl
+    if 'h' in freq.lower():
+        R_nl = (2.043*10**(-10))*((self.ts_param['T_mean'] + 273.16)**4)*(0.34-0.14*(self.ts_param['e_a']) **0.5)*((1.35*self.ts_param['R_s']/R_so) - 0.35)
+    else:
+        R_nl = (4.903*10**(-9))*(((self.ts_param['T_max'] + 273.16)**4 + (self.ts_param['T_min'] + 273.16) **4)/2)*(0.34-0.14*(self.ts_param['e_a']) **0.5)*((1.35*self.ts_param['R_s']/R_so) - 0.35)
+
+    # R_n
+    self.est_val.loc[self.ts_param['R_n'].isnull()] = self.est_val.loc[self.ts_param['R_n'].isnull()] + 100
+    self.ts_param.loc[self.ts_param['R_n'].isnull(), 'R_n'] = R_ns[self.ts_param['R_n'].isnull()] - R_nl[self.ts_param['R_n'].isnull()]
+
+    # G
+    self.est_val.loc[self.ts_param['G'].isnull()] = self.est_val.loc[self.ts_param['G'].isnull()] + 10
+    self.ts_param.loc[self.ts_param['G'].isnull(), 'G'] = 0
+
+
+    ######
+    ## Wind component
+
+    self.ts_param['U_2'] = self.ts_param['U_z']*4.87/(np.log(67.8*z_u - 5.42))
+
+    # or use 2 if wind speed is not known
+    self.est_val.loc[self.ts_param['U_z'].isnull()] = self.est_val.loc[self.ts_param['U_z'].isnull()] + 1
+    self.ts_param.loc[self.ts_param['U_z'].isnull(), 'U_2'] = 2

eto/tests/__init__.py

@@ -0,0 +1,3 @@
+# the inclusion of the tests module is not meant to offer best practices for
+# testing in general, but rather to support the `find_packages` example in
+# setup.py that excludes installing the "tests" package

eto/tests/test_eto.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Wed May  9 15:12:14 2018
+
+@author: MichaelEK
+"""
+import pandas as pd
+import os
+from eto import ETo, datasets
+import pytest
+
+###############################
+### Parameters
+
+# _module_path = os.path.dirname(__file__)
+# example_csv = 'example_daily.csv'
+# results_csv = 'example_daily_results.csv'
+
+# example1 = os.path.join(_module_path, example_csv)
+# results1 = os.path.join(_module_path, results_csv)
+
+example1 = datasets.get_path('example_daily')
+results1 = datasets.get_path('example_daily_results')
+
+z_msl=500
+lat=-43.6
+lon=172
+TZ_lon=173
+
+###############################
+### Tests
+
+tsdata = pd.read_csv(example1, parse_dates=True, index_col='date', compression='zip')
+
+tsresults = pd.read_csv(results1, parse_dates=True, index_col='date', compression='zip')
+
+
+def test_eto_fao_daily():
+    et1 = ETo(tsdata, 'D', z_msl, lat, lon, TZ_lon)
+    eto1 = et1.eto_fao().sum()
+    res1 = tsresults['ETo_FAO_mm'].sum()
+
+    assert eto1 == res1
+
+et1 = ETo(tsdata, 'D', z_msl, lat, lon, TZ_lon)
+
+def test_eto_har_daily():
+    eto2 = et1.eto_hargreaves().sum()
+    res1 = tsresults['ETo_Har_mm'].sum()
+
+    assert eto2 == res1
+
+def test_eto_fao_hourly():
+    tsdata2 = et1.ts_param[['R_s', 'T_mean', 'e_a']]
+    tsdata3 = et1.tsreg(tsdata2, 'h', 'time')
+    et2 = ETo(tsdata3, 'h', z_msl, lat, lon, TZ_lon)
+    eto3 = et2.eto_fao().sum()
+
+    res1 = tsresults['ETo_FAO_mm'].sum()
+
+    assert eto3 > res1
+
+
+
+
+
+
+
+
+
+
+
+
+
+

eto/tests/utest_eto.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Wed May  9 15:12:14 2018
+
+@author: MichaelEK
+"""
+import pandas as pd
+import os
+from eto import ETo
+
+###############################
+### Parameters
+
+# _module_path = os.path.dirname(__file__)
+file_path = '/media/sdb1/Projects/eto/issues/mendosa'
+example_csv = 'alnarp.csv'
+results_csv = 'example_daily_results.csv'
+
+example1 = os.path.join(file_path, example_csv)
+# results1 = os.path.join(_module_path, results_csv)
+
+z_msl=12
+lat=55.6689
+lon=13.10
+TZ_lon=15
+
+###############################
+### Tests
+
+tsdata1 = pd.read_table(example1, sep=';', parse_dates=True, infer_datetime_format=True, index_col='DATUM').drop('STATION', axis=1)
+
+# tsresults = pd.read_csv(results1, parse_dates=True, infer_datetime_format=True, index_col='date')
+
+et1 = ETo(tsdata1, 'H', z_msl, lat, lon, TZ_lon, K_rs=0.16)
+eto1 = et1.eto_fao()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

eto/util.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+"""
+Utility functions.
+"""
+import pandas as pd
+
+
+def tsreg(ts, freq=None, interp=False, maxgap=None):
+    """
+    Function to regularize a time series object (pandas).
+    The first three indeces must be regular for freq=None!!!
+
+    Parameters
+    ----------
+    ts : DataFrame
+        pandas time series dataframe.
+    freq : str
+        Either specify the known frequency of the data or use None and
+    determine the frequency from the first three indices.
+    interp : str
+        Pandas Interpolation method.
+
+    Returns
+    -------
+    DataFrame
+    """
+
+    if freq is None:
+        freq = pd.infer_freq(ts.index[:3])
+    ts1 = ts.resample(freq).mean()
+    if isinstance(interp, str):
+        ts1 = ts1.interpolate(interp, limit=maxgap)
+
+    return ts1

eto-1.1.1.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.3
+Name: ETo
+Version: 1.1.1
+Summary: Class and functions to estimate reference ET
+Project-URL: Homepage, https://github.com/mullenkamp/ETo
+Author-email: Mike Kittridge <mullenkamp1@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: et,reference
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.8
+Requires-Dist: pandas
+Description-Content-Type: text/x-rst
+
+ETo - A Python package for calculating reference evapotranspiration
+===================================================================
+
+The ETo package contains a class and associated functions to calculate reference evapotranspiration (ETo) using the `UN-FAO 56 paper <http://www.fao.org/docrep/X0490E/X0490E00.htm>`_. Additional functions have been added to calculate historic ETo or potential evapotranspiration (PET) for comparison purposes.
+
+A parameter estimation function has also been added to the base class to convert most any variety of meterological parameter inputs to the necessary parameters needed to calculate ETo.
+
+Documentation
+--------------
+The primary documentation for the package can be found `here <http://eto.readthedocs.io>`_.
+
+Installation
+------------
+ETo can be installed via pip or conda::
+
+  pip install eto
+
+or::
+
+  conda install -c mullenkamp eto
+
+The core dependency is `Pandas <http://pandas.pydata.org/pandas-docs/stable/>`_.

eto-1.1.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+eto/__init__.py,sha256=Ute6xvEj-KycEGlrqwDtZLCYa2NDh7VoOK3Ktqj493c,87
+eto/core.py,sha256=w8iGiDlUe1cgrOffMGL16h-I5ayYbBAqFHIA98rDzY4,2161
+eto/param_est.py,sha256=uhjSLjjk6dEnYH6DrLCQolbAJ6V6YX78bYdFyrm215E,11152
+eto/util.py,sha256=IGN7u42MogzsAQ6pI7SR9i-XwOqMBJbgAtzq0blIvU0,786
+eto/datasets/__init__.py,sha256=3dU3tFJRdmV3QYBgdfQmWaxEdIcT4nk0-y_VKD8kcDY,678
+eto/datasets/example_daily.csv.zip,sha256=1b0TJ92PmULBugV2kkY-HTBqBxlQsFJvETpCQTAHkJo,63188
+eto/datasets/example_daily_results.csv.zip,sha256=QJyerR4W1VuVfJx0Qpil447FaGHQ2iHiWDw7ARLWtAI,34584
+eto/methods/ETo.py,sha256=1bYcpQO8YinCfTuOFVH-s3eAFWtg1QAXCtGCzAg_Lu0,2952
+eto/methods/__init__.py,sha256=PLjhQ_wdf_PFfxzV-NmzUdYvzzs5CUA1VSy1Z1-0Pw0,89
+eto/methods/hargreaves.py,sha256=mArwfs-tEFbFju3QT0L0KDGXSQPz3lVKTyftfBi1jdg,2049
+eto/tests/__init__.py,sha256=38pdDhEZk2RiT5kga2DPbhTYeDHdsCXNaEr7HH1-k20,208
+eto/tests/test_eto.py,sha256=tDVKYB1aL2NSxOKdho1nMdHaRfKq7JXkT5qIH2rCVQs,1450
+eto/tests/utest_eto.py,sha256=RlPRgwb3HJ9WmsDegig47IQXG0NWxN9i2nC7XIxSq-4,873
+eto-1.1.1.dist-info/METADATA,sha256=hscImgKNnbIoxIffn5nVXSh2bl6o5vDLQ83wVFkfdv0,1842
+eto-1.1.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+eto-1.1.1.dist-info/licenses/LICENSE.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+eto-1.1.1.dist-info/RECORD,,

eto-1.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

eto-1.1.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.