Merge branch 'JPL-Evapotranspiration-Algorithms:main' into main

Author: gregory-halverson-jpl

BESS_JPL/BESS_JPL.py

@@ -51,3 +51,4 @@
 from .generate_input_dataset import *
 from .generate_BESS_inputs_table import *
 from .generate_output_dataset import *
+from .exceptions import *

BESS_JPL/ECOv002-cal-val-BESS-JPL-GEOS5FP-inputs.csv

@@ -0,0 +1,3 @@
+class MissingOfflineParameter(Exception):
+    """Exception raised when a required parameter is missing in offline mode."""
+    pass

BESS_JPL/exceptions.py

@@ -7,7 +7,7 @@
     sys.path.insert(0, dirname(dirname(__file__)))
     __package__ = "BESS_JPL"
 
-from ECOv002_calval_tables import load_times_locations
+from ECOv002_calval_tables import load_times_locations, load_calval_table
 from GEOS5FP import GEOS5FP
 from BESS_JPL import GEOS5FP_INPUTS
 
@@ -24,16 +24,24 @@ def generate_BESS_GEOS5FP_inputs(
 
     # Load sample times and locations
     targets_df = load_times_locations()
+    calval_table_df = load_calval_table()
 
     if sample_size is not None:
         targets_df = targets_df.sample(n=sample_size).reset_index(drop=True)
 
     # Create GEOS5FP connection
     GEOS5FP_connection = GEOS5FP()
+    
+    target_variables = [
+        variable
+        for variable
+        in GEOS5FP_INPUTS
+        if variable not in calval_table_df.columns
+    ]
 
     # Query for FLiESANN GEOS5FP input variables
     results_df = GEOS5FP_connection.query(
-        target_variables=GEOS5FP_INPUTS,
+        target_variables=target_variables,
         targets_df=targets_df
     )
 

BESS_JPL/generate_BESS_GEOS5FP_inputs.py

@@ -82,7 +82,7 @@ def BESS_JPL(
         carbon_uptake_efficiency: Union[Raster, np.ndarray] = None,  # intrinsic quantum efficiency for carbon uptake
         kn: np.ndarray = None,
         ball_berry_intercept_C3: np.ndarray = None,  # Ball-Berry intercept for C3 plants
-        ball_berry_intercept_C4: Union[np.ndarray, float] = BALL_BERRY_INTERCEPT_C4, # Ball-Berry intercept for C4 plants
+        ball_berry_intercept_C4: Union[np.ndarray, float] = None, # Ball-Berry intercept for C4 plants
         ball_berry_slope_C3: np.ndarray = None,  # Ball-Berry slope for C3 plants
         ball_berry_slope_C4: np.ndarray = None,  # Ball-Berry slope for C4 plants
         peakVCmax_C3_μmolm2s1: np.ndarray = None,  # peak maximum carboxylation rate for C3 plants
@@ -105,6 +105,9 @@ def BESS_JPL(
 
     if geometry is None and isinstance(ST_C, Raster):
         geometry = ST_C.geometry
+        
+    if ball_berry_intercept_C4 is None:
+        ball_berry_intercept_C4 = BALL_BERRY_INTERCEPT_C4
 
     if GEOS5FP_connection is None:
             GEOS5FP_connection = GEOS5FP()

BESS_JPL/model.py

@@ -18,6 +18,7 @@
 from NASADEM import NASADEMConnection
 
 from .constants import *
+from .exceptions import *
 from .colors import *
 from .C3_photosynthesis import *
 from .C4_photosynthesis import *
@@ -118,18 +119,26 @@ def retrieve_BESS_inputs(ST_C: Union[Raster, np.ndarray],  # surface temperature
 
 
     if CI is None and geometry is not None:
+        if offline_mode:
+            raise MissingOfflineParameter("CI not provided in offline mode")
+        
         if MODISCI_connection is None:
             MODISCI_connection = MODISCI()
 
+        logger.info("loading clumping index")
         CI = MODISCI_connection.CI(geometry=geometry, resampling=resampling)
 
     check_distribution(CI, "CI")
     results["CI"] = CI
 
     if elevation_m is None and geometry is not None:
+        if offline_mode:
+            raise MissingOfflineParameter("elevation_m not provided in offline mode")
+        
         if NASADEM_connection is None:
             NASADEM_connection = NASADEMConnection()
 
+        logger.info("loading elevation")  
         elevation_m = NASADEM_connection.elevation_m(geometry=geometry)
 
     check_distribution(elevation_m, "elevation_m")
@@ -138,20 +147,23 @@ def retrieve_BESS_inputs(ST_C: Union[Raster, np.ndarray],  # surface temperature
 
     # load minimum NDVI if not provided
     if NDVI_minimum is None and geometry is not None:
+        logger.info("loading minimum NDVI")
         NDVI_minimum = load_NDVI_minimum(geometry=geometry, resampling=resampling)
 
     check_distribution(NDVI_minimum, "NDVI_minimum")
     results["NDVI_minimum"] = NDVI_minimum
 
     # load maximum NDVI if not provided
     if NDVI_maximum is None and geometry is not None:
+        logger.info("loading maximum NDVI")
         NDVI_maximum = load_NDVI_maximum(geometry=geometry, resampling=resampling)
 
     check_distribution(NDVI_maximum, "NDVI_maximum")
     results["NDVI_maximum"] = NDVI_maximum
 
     # load C4 fraction if not provided
     if C4_fraction is None:
+        logger.info("loading C4 fraction")
         C4_fraction = load_C4_fraction(
             geometry=geometry, 
             resampling=resampling,
@@ -163,62 +175,71 @@ def retrieve_BESS_inputs(ST_C: Union[Raster, np.ndarray],  # surface temperature
 
     # load carbon uptake efficiency if not provided
     if carbon_uptake_efficiency is None:
+        logger.info("loading carbon uptake efficiency")
         carbon_uptake_efficiency = load_carbon_uptake_efficiency(geometry=geometry, resampling=resampling)
 
     check_distribution(carbon_uptake_efficiency, "carbon_uptake_efficiency")
     results["carbon_uptake_efficiency"] = carbon_uptake_efficiency
 
     # load kn if not provided
     if kn is None:
+        logger.info("loading kn")
         kn = load_kn(geometry=geometry, resampling=resampling)
 
     check_distribution(kn, "kn")
     results["kn"] = kn
 
     # load peak VC max for C3 plants if not provided
     if peakVCmax_C3_μmolm2s1 is None:
+        logger.info("loading peak VCmax for C3 plants")
         peakVCmax_C3_μmolm2s1 = load_peakVCmax_C3(geometry=geometry, resampling=resampling)
 
     check_distribution(peakVCmax_C3_μmolm2s1, "peakVCmax_C3_μmolm2s1")
     results["peakVCmax_C3_μmolm2s1"] = peakVCmax_C3_μmolm2s1
 
     # load peak VC max for C4 plants if not provided
     if peakVCmax_C4_μmolm2s1 is None:
+        logger.info("loading peak VCmax for C4 plants")
         peakVCmax_C4_μmolm2s1 = load_peakVCmax_C4(geometry=geometry, resampling=resampling)
 
     check_distribution(peakVCmax_C4_μmolm2s1, "peakVCmax_C4_μmolm2s1")
     results["peakVCmax_C4_μmolm2s1"] = peakVCmax_C4_μmolm2s1
 
     # load Ball-Berry slope for C3 plants if not provided
     if ball_berry_slope_C3 is None:
+        logger.info("loading Ball-Berry slope for C3 plants")
         ball_berry_slope_C3 = load_ball_berry_slope_C3(geometry=geometry, resampling=resampling)
 
     check_distribution(ball_berry_slope_C3, "ball_berry_slope_C3")
     results["ball_berry_slope_C3"] = ball_berry_slope_C3
 
     # load Ball-Berry slope for C4 plants if not provided
     if ball_berry_slope_C4 is None:
+        logger.info("loading Ball-Berry slope for C4 plants")
         ball_berry_slope_C4 = load_ball_berry_slope_C4(geometry=geometry, resampling=resampling)
 
     check_distribution(ball_berry_slope_C4, "ball_berry_slope_C4")
     results["ball_berry_slope_C4"] = ball_berry_slope_C4
 
     # load Ball-Berry intercept for C3 plants if not provided
     if ball_berry_intercept_C3 is None:
+        logger.info("loading Ball-Berry intercept for C3 plants")
         ball_berry_intercept_C3 = load_ball_berry_intercept_C3(geometry=geometry, resampling=resampling)
 
     check_distribution(ball_berry_intercept_C3, "ball_berry_intercept_C3")
     results["ball_berry_intercept_C3"] = ball_berry_intercept_C3
 
     # load koppen geiger climate classification if not provided
     if KG_climate is None:
+        logger.info("loading Koppen-Geiger climate classification")
         KG_climate = load_koppen_geiger(geometry=geometry)
 
     check_distribution(np.float32(KG_climate), "KG_climate")
     results["KG_climate"] = KG_climate
 
     # load canopy height in meters if not provided
     if canopy_height_meters is None:
+        logger.info("loading canopy height")
         canopy_height_meters = load_canopy_height(
             geometry=geometry, 
             resampling=resampling,

BESS_JPL/retrieve_BESS_inputs.py

@@ -3,7 +3,7 @@ requires = ["setuptools>=60", "setuptools-scm>=8.0", "wheel"]
 
 [project]
 name = "BESS-JPL"
-version = "1.25.0"
+version = "1.27.0"
 description = "Breathing Earth System Simulator (BESS) Gross Primary Production (GPP) and Evapotranspiration (ET) Model Python"
 readme = "README.md"
 authors = [