Merge pull request #8 from gregory-halverson-jpl/main

fixing `daily_ET_from_instantaneous`

Author: gregory-halverson-jpl

daily_evapotranspiration_upscaling/daily_evapotranspiration_upscaling.py

@@ -1,4 +1,5 @@
 import datetime
+from datetime import datetime
 from typing import Union
 from sun_angles import SHA_deg_from_DOY_lat, daylight_from_SHA, sunrise_from_SHA, calculate_daylight
 from dateutil import parser
@@ -75,12 +76,12 @@ def daily_ET_from_instantaneous(
         LE_instantaneous_Wm2: Union[Raster, np.ndarray, float],
         Rn_instantaneous_Wm2: Union[Raster, np.ndarray, float],
         G_instantaneous_Wm2: Union[Raster, np.ndarray, float],
-        DOY: Union[Raster, np.ndarray, int] = None,
+        day_of_year: Union[Raster, np.ndarray, int] = None,
         lat: Union[Raster, np.ndarray, float] = None,
         hour_of_day: Union[Raster, np.ndarray, float] = None,
         sunrise_hour: Union[Raster, np.ndarray, float] = None,
         daylight_hours: Union[Raster, np.ndarray, float] = None,
-        datetime_UTC: datetime = None,
+        time_UTC: Union[datetime, str, np.ndarray, list] = None,
         geometry: SpatialGeometry = None,
         lambda_Jkg: Union[Raster, np.ndarray, float] = LAMBDA_JKG_WATER_20C
     ) -> Union[Raster, np.ndarray]:
@@ -96,6 +97,9 @@ def daily_ET_from_instantaneous(
     Returns:
         Union[Raster, np.ndarray]: Daily evapotranspiration in kilograms.
     """
+    if lat is None and geometry is not None:
+        lat = geometry.lat
+
     # Calculate evaporative fraction
     EF = calculate_evaporative_fraction(
         LE=LE_instantaneous_Wm2,
@@ -106,21 +110,21 @@ def daily_ET_from_instantaneous(
     # Calculate daylight hours if not provided
     if daylight_hours is None:
         daylight_hours = calculate_daylight(
-            DOY=DOY,
+            day_of_year=day_of_year,
             lat=lat,
-            datetime_UTC=datetime_UTC,
+            time_UTC=time_UTC,
             geometry=geometry
         )
 
     # Calculate sunrise hour if not provided
     if sunrise_hour is None:
-        sunrise_hour = sunrise_from_SHA(SHA_deg_from_DOY_lat(DOY, lat))
+        sunrise_hour = sunrise_from_SHA(SHA_deg_from_DOY_lat(day_of_year, lat))
 
     # Integrate net radiation over the day
     Rn_daylight = daily_Rn_integration_verma(
         Rn=Rn_instantaneous_Wm2,
         hour_of_day=hour_of_day,
-        DOY=DOY,
+        DOY=day_of_year,
         lat=lat,
         sunrise_hour=sunrise_hour,
         daylight_hours=daylight_hours
@@ -130,6 +134,6 @@ def daily_ET_from_instantaneous(
     LE_daylight = EF * Rn_daylight
 
     # Calculate daily ET
-    ET = daily_ET_from_daily_LE(LE_daylight, daylight_hours=daylight_hours, DOY=DOY, lat=lat, datetime_UTC=datetime_UTC, geometry=geometry, lambda_Jkg=lambda_Jkg)
+    ET = daily_ET_from_daily_LE(LE_daylight, daylight_hours=daylight_hours, DOY=day_of_year, lat=lat, datetime_UTC=time_UTC, geometry=geometry, lambda_Jkg=lambda_Jkg)
 
     return ET

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=60", "setuptools-scm>=8.0", "wheel"]
 
 [project]
 name = "daily-evapotranspiration-upscaling"
-version = "1.0.6"
+version = "1.1.0"
 description = "Instantaneous/Daily Evapotranspiration Upscaling Utilities Python Package"
 readme = "README.md"
 authors = [
@@ -19,7 +19,7 @@ dependencies = [
     "python-dateutil",
     "rasters",
     "solar-apparent-time",
-    "sun-angles>=1.3.0",
+    "sun-angles>=1.4.0",
     "verma-net-radiation"
 ]
 

tests/test_daily_ET_from_instantaneous.py

@@ -0,0 +1,70 @@
+import unittest
+import numpy as np
+from datetime import datetime
+from daily_evapotranspiration_upscaling.daily_evapotranspiration_upscaling import daily_ET_from_instantaneous
+
+class TestDailyETFromInstantaneous(unittest.TestCase):
+    def test_scalar_inputs_datetime(self):
+        # Simple test with scalar values and datetime
+        LE = 100.0  # W/m^2
+        Rn = 200.0  # W/m^2
+        G = 20.0    # W/m^2
+        day_of_year = 180
+        lat = 35.0
+        hour_of_day = 12.0
+        time_UTC = datetime(2023, 6, 29, 12, 0, 0)
+        # Should run without error and return a float or np.ndarray
+        result = daily_ET_from_instantaneous(
+            LE_instantaneous_Wm2=LE,
+            Rn_instantaneous_Wm2=Rn,
+            G_instantaneous_Wm2=G,
+            day_of_year=day_of_year,
+            lat=lat,
+            hour_of_day=hour_of_day,
+            time_UTC=time_UTC
+        )
+        self.assertIsInstance(result, (float, np.floating, np.ndarray))
+
+    def test_scalar_inputs_string_time(self):
+        # Test with time as string
+        LE = 100.0
+        Rn = 200.0
+        G = 20.0
+        day_of_year = 180
+        lat = 35.0
+        hour_of_day = 12.0
+        time_UTC = '2023-06-29T12:00:00'
+        result = daily_ET_from_instantaneous(
+            LE_instantaneous_Wm2=LE,
+            Rn_instantaneous_Wm2=Rn,
+            G_instantaneous_Wm2=G,
+            day_of_year=day_of_year,
+            lat=lat,
+            hour_of_day=hour_of_day,
+            time_UTC=time_UTC
+        )
+        self.assertIsInstance(result, (float, np.floating, np.ndarray))
+
+    def test_array_inputs(self):
+        # Test with numpy arrays
+        LE = np.array([100.0, 110.0])
+        Rn = np.array([200.0, 210.0])
+        G = np.array([20.0, 25.0])
+        day_of_year = np.array([180, 181])
+        lat = np.array([35.0, 36.0])
+        hour_of_day = np.array([12.0, 13.0])
+        time_UTC = [datetime(2023, 6, 29, 12, 0, 0), datetime(2023, 6, 30, 13, 0, 0)]
+        result = daily_ET_from_instantaneous(
+            LE_instantaneous_Wm2=LE,
+            Rn_instantaneous_Wm2=Rn,
+            G_instantaneous_Wm2=G,
+            day_of_year=day_of_year,
+            lat=lat,
+            hour_of_day=hour_of_day,
+            time_UTC=time_UTC
+        )
+        self.assertIsInstance(result, np.ndarray)
+        self.assertEqual(result.shape, (2,))
+
+if __name__ == '__main__':
+    unittest.main()