PM-JPL 1.2.1__tar.gz → 1.3.0__tar.gz

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PM-JPL
-Version: 1.2.1
+Version: 1.3.0
 Summary: JPL implementation of the MOD16 evapotranspiration algorithm for high resolution instantaneous remote sensing imagery
 Author-email: Gregory Halverson <gregory.h.halverson@jpl.nasa.gov>, Qiaozhen Mu <qiaozhen@ntsg.umt.edu>, Maosheng Zhao <zhao@ntsg.umt.edu>, "Steven W. Running" <swr@ntsg.umt.edu>, "Claire S. Villanueva-Weeks" <claire.s.villanueva-weeks@jpl.gov>
 Project-URL: Homepage, https://github.com/JPL-Evapotranspiration-Algorithms/PM-JPL
@@ -9,28 +9,19 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: affine
-Requires-Dist: astropy
-Requires-Dist: geopandas
-Requires-Dist: h5py
-Requires-Dist: keras
-Requires-Dist: matplotlib
+Requires-Dist: check-distribution
+Requires-Dist: ECOv002-CMR>=1.0.5
+Requires-Dist: ECOv002-granules>=1.0.3
+Requires-Dist: ECOv003-granules
+Requires-Dist: GEOS5FP>=1.1.1
+Requires-Dist: MCD12C1_2019_v006
+Requires-Dist: NASADEM
 Requires-Dist: numpy
 Requires-Dist: pandas
-Requires-Dist: pillow
-Requires-Dist: pygeos
-Requires-Dist: pyproj
-Requires-Dist: pyresample
-Requires-Dist: rasterio
-Requires-Dist: rasters
-Requires-Dist: requests
-Requires-Dist: scikit-image
-Requires-Dist: scipy
-Requires-Dist: shapely
-Requires-Dist: six
+Requires-Dist: rasters>=1.4.6
+Requires-Dist: SEBAL-soil-heat-flux
 Requires-Dist: sun-angles
-Requires-Dist: tensorflow
-Requires-Dist: urllib3
+Requires-Dist: verma-net-radiation
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest>=6.0; extra == "dev"

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/PMJPL.py

@@ -7,29 +7,28 @@ https://landweb.nascom.nasa.gov/QA_WWW/forPage/user_guide/MOD16UsersGuide2016.pd
 Developed by Gregory Halverson in the Jet Propulsion Laboratory Year-Round Internship Program (Columbus Technologies and Services), in coordination with the ECOSTRESS mission and master's thesis studies at California State University, Northridge.
 """
 import logging
-from typing import Callable, Dict, Union
+from typing import Dict, Union
 from datetime import datetime
-from os.path import join, abspath, dirname, expanduser
 
 import numpy as np
-import pandas as pd
-from numpy import where, nan, exp, array, isnan, logical_and, clip, float32
-import warnings
-
-import rasters as rt 
-
+import rasters as rt
 from rasters import Raster, RasterGrid, RasterGeometry
 
-from .MCD12C1.MCD12C1 import load_MCD12C1_IGBP
+from check_distribution import check_distribution
+from GEOS5FP import GEOS5FP
+from NASADEM import NASADEM
+from verma_net_radiation import process_verma_net_radiation
+from SEBAL_soil_heat_flux import calculate_SEBAL_soil_heat_flux
+from MCD12C1_2019_v006 import load_MCD12C1_IGBP
+
 from .parameters import MOD16_parameter_from_IGBP
 from .evapotranspiration_conversion.evapotranspiration_conversion import lambda_Jkg_from_Ta_C
-from .meteorology_conversion.meteorology_conversion import SVP_Pa_from_Ta_C, calculate_specific_heat, calculate_surface_pressure, celcius_to_kelvin
+from .meteorology_conversion.meteorology_conversion import SVP_Pa_from_Ta_C, calculate_specific_heat, \
+    calculate_surface_pressure, celcius_to_kelvin
 from .penman_monteith.penman_monteith import calculate_gamma
-from .priestley_taylor.priestley_taylor import delta_Pa_from_Ta_C, delta_kPa_from_Ta_C
+from .priestley_taylor.priestley_taylor import delta_Pa_from_Ta_C
 
-from .soil_heat_flux import calculate_soil_heat_flux
-from .evapotranspiration_conversion import daily_ET_from_daily_LE
-from .meteorology_conversion import kelvin_to_celsius, calculate_specific_humidity, calculate_air_density
+from .meteorology_conversion import calculate_specific_humidity, calculate_air_density
 from .vegetation_conversion.vegetation_conversion import FVC_from_NDVI, LAI_from_NDVI
 
 from .constants import *
@@ -66,24 +65,110 @@ DEFAULT_OUTPUT_VARIABLES = [
     'ET_daily_kg'
 ]
 
+
 def PMJPL(
-        Rn: Union[Raster, np.ndarray],
-        G: Union[Raster, np.ndarray],
         NDVI: Union[Raster, np.ndarray],
-        Ta_C: Union[Raster, np.ndarray],
-        Tmin_C: Union[Raster, np.ndarray],
-        RH: Union[Raster, np.ndarray],
-        IGBP: Union[Raster, np.ndarray],
+        ST_C: Union[Raster, np.ndarray] = None,
+        emissivity: Union[Raster, np.ndarray] = None,
+        albedo: Union[Raster, np.ndarray] = None,
+        Rn: Union[Raster, np.ndarray] = None,
+        G: Union[Raster, np.ndarray] = None,
+        Ta_C: Union[Raster, np.ndarray] = None,
+        Tmin_C: Union[Raster, np.ndarray] = None,
+        RH: Union[Raster, np.ndarray] = None,
+        IGBP: Union[Raster, np.ndarray] = None,
+        FVC: Union[Raster, np.ndarray] = None,
+        geometry: RasterGeometry = None,
+        time_UTC: datetime = None,
+        GEOS5FP_connection: GEOS5FP = None,
+        resampling: str = "nearest",
         Ps_Pa: Union[Raster, np.ndarray] = None,
-        elevation_m: Union[Raster, np.ndarray] = None,
+        elevation_km: Union[Raster, np.ndarray] = None,
         delta_Pa: Union[Raster, np.ndarray] = None,
+        lambda_Jkg: Union[Raster, np.ndarray] = None,
         gamma_Jkg: Union[Raster, np.ndarray, float] = None) -> Dict[str, Raster]:
     results = {}
 
-    # calculate leaf area index if it's not given
-    if LAI is None:
-        # calculate leaf area index from NDVI
-        LAI = LAI_from_NDVI(NDVI)
+    if geometry is None and isinstance(NDVI, Raster):
+        geometry = NDVI.geometry
+
+    if GEOS5FP_connection is None:
+        GEOS5FP_connection = GEOS5FP()
+
+    if Ta_C is None and geometry is not None and time_UTC is not None:
+        Ta_C = GEOS5FP_connection.Ta_C(
+            time_UTC=time_UTC,
+            geometry=geometry,
+            resampling=resampling
+        )
+
+    if Ta_C is None:
+        raise ValueError("air temperature (Ta_C) not given")
+
+    if Tmin_C is None and geometry is not None and time_UTC is not None:
+        Tmin_K = GEOS5FP_connection.Tmin_K(
+            time_UTC=time_UTC,
+            geometry=geometry,
+            resampling=resampling
+        )
+
+        Tmin_C = Tmin_K - 273.15
+
+    if Tmin_C is None:
+        raise ValueError("minimum temperature (Tmin_C) not given")
+
+    if RH is None and geometry is not None and time_UTC is not None:
+        RH = GEOS5FP_connection.RH(
+            time_UTC=time_UTC,
+            geometry=geometry,
+            resampling=resampling
+        )
+
+    if RH is None:
+        raise ValueError("relative humidity (RH) not given")
+
+    if elevation_km is None and geometry is not None:
+        elevation_km = NASADEM.elevation_km(geometry=geometry)
+
+    elevation_m = elevation_km * 1000.0
+
+    if IGBP is None and geometry is not None:
+        IGBP = load_MCD12C1_IGBP(geometry=geometry)
+
+    if Rn is None and albedo is not None and ST_C is not None and emissivity is not None:
+        if SWin is None and geometry is not None and time_UTC is not None:
+            SWin = GEOS5FP_connection.SWin(
+                time_UTC=time_UTC,
+                geometry=geometry,
+                resampling=resampling
+            )
+
+        Rn_results = process_verma_net_radiation(
+            SWin=SWin,
+            albedo=albedo,
+            ST_C=ST_C,
+            emissivity=emissivity,
+            Ta_C=Ta_C,
+            RH=RH
+        )
+
+        Rn = Rn_results["Rn"]
+
+    if Rn is None:
+        raise ValueError("net radiation (Rn) not given")
+
+    if G is None and Rn is not None and ST_C is not None and NDVI is not None and albedo is not None:
+        G = calculate_SEBAL_soil_heat_flux(
+            Rn=Rn,
+            ST_C=ST_C,
+            NDVI=NDVI,
+            albedo=albedo
+        )
+
+    if G is None:
+        raise ValueError("soil heat flux (G) not given")
+
+    LAI = LAI_from_NDVI(NDVI)
 
     # calculate fraction of vegetation cover if it's not given
     if FVC is None:
@@ -131,7 +216,7 @@ def PMJPL(
     # from specific heat of water vapor (CPW)
     # and specific heat of dry air (CPD)
     Cp_Jkg = calculate_specific_heat(specific_humidity)
-    results["Cp"] = Cp_Jkg    
+    results["Cp"] = Cp_Jkg
 
     # calculate delta term if it's not given
     if delta_Pa is None:
@@ -161,7 +246,7 @@ def PMJPL(
 
     # query leaf conductance to sensible heat (gl_sh) in seconds per meter
     gl_sh = MOD16_parameter_from_IGBP(
-        variable="gl_sh", 
+        variable="gl_sh",
         IGBP=IGBP
     )
 
@@ -173,19 +258,19 @@ def PMJPL(
     results['rhc'] = rhc
 
     # calculate resistance to radiative heat transfer through air (rrc)
-    rrc = float32(rho_kgm3 * Cp_Jkg / (4.0 * SIGMA * Ta_K ** 3.0))
+    rrc = np.float32(rho_kgm3 * Cp_Jkg / (4.0 * SIGMA * Ta_K ** 3.0))
     results['rrc'] = rrc
 
     # calculate aerodynamic resistance (rhrc)
     # in seconds per meter
     # from wet canopy resistance to sensible heat
     # and resistance to radiative heat transfer through air
-    rhrc = float32((rhc * rrc) / (rhc + rrc))
+    rhrc = np.float32((rhc * rrc) / (rhc + rrc))
     results['rhrc'] = rhrc
 
     # calculate leaf conductance to evaporated water vapor (gl_e_wv)
     gl_e_wv = MOD16_parameter_from_IGBP(
-        variable="gl_e_wv", 
+        variable="gl_e_wv",
         IGBP=IGBP
     )
 
@@ -203,18 +288,18 @@ def PMJPL(
     # calculate wet latent heat flux (LEi)
     # in watts per square meter
     LEi = calculate_interception(
-        delta_Pa=delta_Pa, 
-        Ac=Ac, 
-        rho=rho_kgm3, 
-        Cp=Cp_Jkg, 
-        VPD_Pa=VPD_Pa, 
-        FVC=FVC, 
-        rhrc=rhrc, 
-        fwet=fwet, 
+        delta_Pa=delta_Pa,
+        Ac=Ac,
+        rho=rho_kgm3,
+        Cp=Cp_Jkg,
+        VPD_Pa=VPD_Pa,
+        FVC=FVC,
+        rhrc=rhrc,
+        fwet=fwet,
         rvc=rvc,
-        gamma_Jkg=gamma_Jkg
+        # gamma_Jkg=gamma_Jkg
     )
-    
+
     results['LEi'] = LEi
 
     # calculate correctance factor (rcorr)
@@ -225,7 +310,7 @@ def PMJPL(
 
     # query biome-specific mean potential stomatal conductance per unit leaf area
     CL = MOD16_parameter_from_IGBP(
-        variable="CL", 
+        variable="cl",
         IGBP=IGBP
     )
 
@@ -233,7 +318,7 @@ def PMJPL(
 
     # query open minimum temperature by land-cover
     tmin_open = MOD16_parameter_from_IGBP(
-        variable="tmin_open", 
+        variable="tmin_open",
         IGBP=IGBP
     )
 
@@ -241,19 +326,23 @@ def PMJPL(
 
     # query closed minimum temperature by land-cover
     tmin_close = MOD16_parameter_from_IGBP(
-        variable="tmin_close", 
+        variable="tmin_close",
         IGBP=IGBP
     )
 
     results['tmin_close'] = tmin_close
 
+    check_distribution(Tmin_C, "Tmin_C")
+    check_distribution(tmin_open, "tmin_open")
+    check_distribution(tmin_close, "tmin_close")
+
     # calculate minimum temperature factor for stomatal conductance
-    mTmin = calculate_tmin_factor(Tmin_C, tmin_open, tmin_close, IGBP)
+    mTmin = calculate_tmin_factor(Tmin_C, tmin_open, tmin_close)
     results['mTmin'] = mTmin
 
     # query open vapor pressure deficit by land-cover
     VPD_open = MOD16_parameter_from_IGBP(
-        variable="VPD_open", 
+        variable="vpd_open",
         IGBP=IGBP
     )
 
@@ -261,7 +350,7 @@ def PMJPL(
 
     # query closed vapor pressure deficit by land-cover
     VPD_close = MOD16_parameter_from_IGBP(
-        variable="VPD_close", 
+        variable="vpd_close",
         IGBP=IGBP
     )
 
@@ -303,32 +392,32 @@ def PMJPL(
 
     # calculate transpiration
     LEc = calculate_transpiration(
-        delta_Pa=delta_Pa, 
-        Ac=Ac, 
-        rho=rho_kgm3, 
-        Cp_Jkg=Cp_Jkg, 
-        VPD_Pa=VPD_Pa, 
-        FVC=FVC, 
-        ra=ra, 
-        fwet=fwet, 
+        delta_Pa=delta_Pa,
+        Ac=Ac,
+        rho_kgm3=rho_kgm3,
+        Cp_Jkg=Cp_Jkg,
+        VPD_Pa=VPD_Pa,
+        FVC=FVC,
+        ra=ra,
+        fwet=fwet,
         rs=rs,
-        gamma_Jkg=gamma_Jkg
+        # gamma_Jkg=gamma_Jkg
     )
-    
+
     results['LEc'] = LEc
 
     # soil evaporation
 
     # query aerodynamic resistant constraints from land-cover
     rbl_max = MOD16_parameter_from_IGBP(
-        variable="rbl_max", 
+        variable="rbl_max",
         IGBP=IGBP
     )
 
     results['rbl_max'] = rbl_max
 
     rbl_min = MOD16_parameter_from_IGBP(
-        variable="rbl_min", 
+        variable="rbl_min",
         IGBP=IGBP
     )
 
@@ -343,7 +432,7 @@ def PMJPL(
     results['rtot'] = rtot
 
     # calculate resistance to radiative heat transfer through air
-    rrs = float32(rho_kgm3 * Cp_Jkg / (4.0 * SIGMA * Ta_K ** 3))
+    rrs = np.float32(rho_kgm3 * Cp_Jkg / (4.0 * SIGMA * Ta_K ** 3))
     results['rrs'] = rrs
 
     # calculate aerodynamic resistance at the soil surface
@@ -358,34 +447,34 @@ def PMJPL(
 
     # calculate wet soil evaporation
     LE_soil_wet = calculate_wet_soil_evaporation(
-        delta_Pa=delta_Pa, 
-        Asoil=Asoil, 
-        rho=rho_kgm3, 
-        Cp_Jkg=Cp_Jkg, 
-        FVC=FVC, 
-        VPD_Pa=VPD_Pa, 
-        ras=ras, 
-        fwet=fwet, 
+        delta_Pa=delta_Pa,
+        Asoil=Asoil,
+        rho_kgm3=rho_kgm3,
+        Cp_Jkg=Cp_Jkg,
+        FVC=FVC,
+        VPD_Pa=VPD_Pa,
+        ras=ras,
+        fwet=fwet,
         rtot=rtot,
-        gamma_Jkg=gamma_Jkg
+        # gamma_Jkg=gamma_Jkg
     )
-    
+
     results['LE_soil_wet'] = LE_soil_wet
 
     # calculate potential soil evaporation
     LE_soil_pot = calculate_potential_soil_evaporation(
-        delta_Pa=delta_Pa, 
-        Asoil=Asoil, 
-        rho=rho_kgm3, 
-        Cp_Jkg=Cp_Jkg, 
-        FVC=FVC, 
-        VPD_Pa=VPD_Pa, 
-        ras=ras, 
-        fwet=fwet, 
+        delta_Pa=delta_Pa,
+        Asoil=Asoil,
+        rho=rho_kgm3,
+        Cp_Jkg=Cp_Jkg,
+        FVC=FVC,
+        VPD_Pa=VPD_Pa,
+        ras=ras,
+        fwet=fwet,
         rtot=rtot,
-        gamma_Jkg=gamma_Jkg
+        # gamma_Jkg=gamma_Jkg
     )
-    
+
     results['LE_soil_pot'] = LE_soil_pot
 
     # calculate soil moisture constraint
@@ -396,7 +485,7 @@ def PMJPL(
     LEs = rt.clip(LE_soil_wet + LE_soil_pot * fSM, 0.0, None)
 
     # fill soil evaporation with zero
-    LEs = rt.where(isnan(LEs), 0.0, LEs)
+    LEs = rt.where(np.isnan(LEs), 0.0, LEs)
     results['LEs'] = LEs
 
     # sum partitions into total latent heat flux

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/VPD_factor.py

@@ -20,7 +20,7 @@ def calculate_VPD_factor(
     """
     # calculate VPD factor using queried open and closed VPD
     mVPD = rt.where(VPD <= VPD_open, 1.0, np.nan)
-    mVPD = rt.where(rt.logical_and(VPD_open < VPD, VPD < VPD_close), (VPD_close - VPD) / (VPD_close - VPD_open), mVPD)
+    mVPD = rt.where(np.logical_and(VPD_open < VPD, VPD < VPD_close), (VPD_close - VPD) / (VPD_close - VPD_open), mVPD)
     mVPD = rt.where(VPD >= VPD_close, 0.0, mVPD)
 
     return mVPD

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/canopy_aerodynamic_resistance.py

@@ -23,7 +23,7 @@ def calculate_rtotc(
     rtotc = rt.where(VPD >= vpd_close, rbl_min, rtotc)
 
     rtotc = rt.where(
-        rt.logical_and(vpd_open < VPD, VPD < vpd_close),
+        np.logical_and(vpd_open < VPD, VPD < vpd_close),
         rbl_min + (rbl_max - rbl_min) * (vpd_close - VPD) / (vpd_close - vpd_open),
         rtotc
     )

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/canopy_conductance.py

@@ -26,7 +26,7 @@ def calculate_canopy_conductance(
     """
     # noinspection PyTypeChecker
     Cc = rt.where(
-        rt.logical_and(LAI > 0.0, (1.0 - fwet) > 0.0),
+        np.logical_and(LAI > 0.0, (1.0 - fwet) > 0.0),
         gl_sh * (gs1 + Gcu) / (gs1 + gl_sh + Gcu) * LAI * (1.0 - fwet),
         0.0
     )

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/evapotranspiration_conversion/evapotranspiration_conversion.py

@@ -6,8 +6,10 @@ from rasters import Raster
 import numpy as np
 import pandas as pd
 
+from verma_net_radiation import daily_Rn_integration_verma
+
 from ..meteorology_conversion.meteorology_conversion import celcius_to_kelvin
-from ..verma_net_radiation.verma_net_radiation import daily_Rn_integration_verma
+
 
 # latent heat of vaporization for water at 20 Celsius in Joules per kilogram
 LAMBDA_JKG_WATER_20C = 2450000.0

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/interception.py

@@ -4,7 +4,7 @@ import rasters as rt
 from rasters import Raster
 
 from .constants import GAMMA_PA
-
+    
 def calculate_interception(
         delta_Pa: Union[Raster, np.ndarray],
         Ac: Union[Raster, np.ndarray],
@@ -15,7 +15,6 @@ def calculate_interception(
         rhrc: Union[Raster, np.ndarray],
         fwet: Union[Raster, np.ndarray],
         rvc: Union[Raster, np.ndarray],
-        water: Union[Raster, np.ndarray],
         gamma_Pa: Union[Raster, np.ndarray, float] = GAMMA_PA) -> Union[Raster, np.ndarray]:
     """
     Calculates the wet evaporation partition of the latent heat flux using the MOD16 method.
@@ -29,7 +28,6 @@ def calculate_interception(
     :param rhrc: aerodynamic resistance in seconds per meter
     :param fwet: relative surface wetness
     :param rvc: wet canopy resistance
-    :param water: water content in the canopy
     :param gamma_Pa: psychrometric constant for atmospheric pressure in Pascal (default: GAMMA_PA)
 
     :return: wet evaporation in watts per square meter

pm_jpl-1.3.0/PMJPL/mod16.csv

@@ -0,0 +1 @@
+LC,gl_sh,gl_e_wv,rbl_min,rbl_max,cl,tmin_open,tmin_close,vpd_close,vpd_open

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/parameters.py

@@ -5,7 +5,7 @@ import pandas as pd
 
 from rasters import Raster, RasterGeometry
 
-from .MCD12C1.MCD12C1 import load_MCD12C1_IGBP
+from MCD12C1_2019_v006 import load_MCD12C1_IGBP
 
 LUT = pd.read_csv(join(abspath(dirname(__file__)), 'mod16.csv'))
 

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/penman_monteith/penman_monteith.py

@@ -1,7 +1,6 @@
 from typing import Union
 import numpy as np
 from ..evapotranspiration_conversion.evapotranspiration_conversion import lambda_Jkg_from_Ta_C
-from ..meteorology_conversion.meteorology_conversion import celcius_to_kelvin
 
 from rasters import Raster
 

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/potential_soil_evaporation.py

@@ -11,7 +11,7 @@ def calculate_potential_soil_evaporation(
         rho: float,
         Cp_Jkg: float,
         FVC: float,
-        VPD: float,
+        VPD_Pa: float,
         ras: float,
         fwet: float,
         rtot: float,
@@ -39,7 +39,7 @@ def calculate_potential_soil_evaporation(
     - The Penman-Monteith equation takes into account various factors such as radiation, air density, heat capacity, vegetation cover, vapor pressure deficit, aerodynamic resistance, soil wetness, and total resistance.
     - The function returns the potential soil evaporation as either a Raster object or a NumPy array, depending on the input data type.
     """
-    numerator = (delta_Pa * Asoil + rho * Cp_Jkg * (1.0 - FVC) * VPD / ras) * (1.0 - fwet)
+    numerator = (delta_Pa * Asoil + rho * Cp_Jkg * (1.0 - FVC) * VPD_Pa / ras) * (1.0 - fwet)
     denominator = delta_Pa + gamma_Pa * rtot / ras
     LE_soil_pot = numerator / denominator
 

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/tmin_factor.py

@@ -32,7 +32,7 @@ def calculate_tmin_factor(
     mTmin = rt.where(Tmin >= tmin_open, 1.0, np.nan)
 
     mTmin = rt.where(
-        rt.logical_and(
+        np.logical_and(
             tmin_close < Tmin,
             Tmin < tmin_open
         ),

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/transpiration.py

@@ -8,8 +8,8 @@ from .constants import GAMMA_PA
 def calculate_transpiration(
         delta_Pa: Union[Raster, np.ndarray],
         Ac: Union[Raster, np.ndarray],
-        rho: Union[Raster, np.ndarray], 
-        Cp: Union[Raster, np.ndarray], 
+        rho_kgm3: Union[Raster, np.ndarray], 
+        Cp_Jkg: Union[Raster, np.ndarray], 
         VPD_Pa: Union[Raster, np.ndarray], 
         FVC: Union[Raster, np.ndarray], 
         ra: Union[Raster, np.ndarray], 
@@ -34,11 +34,11 @@ def calculate_transpiration(
     Returns:
         Union[Raster, np.ndarray]: transpiration (LEc) in mm/day.
     """
-    numerator = (delta_Pa * Ac + (rho * Cp * FVC * VPD_Pa / ra)) * (1.0 - fwet)
+    numerator = (delta_Pa * Ac + (rho_kgm3 * Cp_Jkg * FVC * VPD_Pa / ra)) * (1.0 - fwet)
     denominator = delta_Pa + gamma_Pa * (1.0 + (rs / ra))
     LEc = numerator / denominator
 
     # fill transpiration with zero
-    LEc = rt.where(rt.isnan(LEc), 0.0, LEc)
+    LEc = rt.where(np.isnan(LEc), 0.0, LEc)
 
     return LEc

pm_jpl-1.3.0/PMJPL/version.txt

@@ -0,0 +1 @@
+1.3.0

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/wet_canopy_resistance.py

@@ -18,4 +18,5 @@ def calculate_wet_canopy_resistance(
     :param fwet: relative surface wetness
     :return: wet canopy resistance
     """
+    # print(f"conductance: {conductance.shape}, LAI: {LAI.shape}, fwet: {fwet.shape}")
     return rt.clip(1.0 / rt.clip(conductance * LAI * fwet, 1.0 / max_resistance, None), min_resistance, max_resistance)

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PMJPL/wet_soil_evaporation.py

@@ -7,10 +7,10 @@ from .constants import GAMMA_PA
 def calculate_wet_soil_evaporation(
         delta_Pa: Union[Raster, np.ndarray], 
         Asoil: Union[Raster, np.ndarray], 
-        rho: Union[Raster, np.ndarray], 
-        Cp: Union[Raster, np.ndarray], 
+        rho_kgm3: Union[Raster, np.ndarray], 
+        Cp_Jkg: Union[Raster, np.ndarray], 
         FVC: Union[Raster, np.ndarray], 
-        VPD: Union[Raster, np.ndarray], 
+        VPD_Pa: Union[Raster, np.ndarray], 
         ras: Union[Raster, np.ndarray], 
         fwet: Union[Raster, np.ndarray], 
         rtot: Union[Raster, np.ndarray],
@@ -29,7 +29,7 @@ def calculate_wet_soil_evaporation(
     :param gamme: gamma constant (default: GAMMA)
     :return: wet soil evaporation in watts per square meter
     """
-    numerator = (delta_Pa * Asoil + rho * Cp * (1.0 - FVC) * VPD / ras) * fwet
+    numerator = (delta_Pa * Asoil + rho_kgm3 * Cp_Jkg * (1.0 - FVC) * VPD_Pa / ras) * fwet
     denominator = delta_Pa + gamma_Pa * rtot / ras
     LE_soil_wet = numerator / denominator
 

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PM_JPL.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PM-JPL
-Version: 1.2.1
+Version: 1.3.0
 Summary: JPL implementation of the MOD16 evapotranspiration algorithm for high resolution instantaneous remote sensing imagery
 Author-email: Gregory Halverson <gregory.h.halverson@jpl.nasa.gov>, Qiaozhen Mu <qiaozhen@ntsg.umt.edu>, Maosheng Zhao <zhao@ntsg.umt.edu>, "Steven W. Running" <swr@ntsg.umt.edu>, "Claire S. Villanueva-Weeks" <claire.s.villanueva-weeks@jpl.gov>
 Project-URL: Homepage, https://github.com/JPL-Evapotranspiration-Algorithms/PM-JPL
@@ -9,28 +9,19 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: affine
-Requires-Dist: astropy
-Requires-Dist: geopandas
-Requires-Dist: h5py
-Requires-Dist: keras
-Requires-Dist: matplotlib
+Requires-Dist: check-distribution
+Requires-Dist: ECOv002-CMR>=1.0.5
+Requires-Dist: ECOv002-granules>=1.0.3
+Requires-Dist: ECOv003-granules
+Requires-Dist: GEOS5FP>=1.1.1
+Requires-Dist: MCD12C1_2019_v006
+Requires-Dist: NASADEM
 Requires-Dist: numpy
 Requires-Dist: pandas
-Requires-Dist: pillow
-Requires-Dist: pygeos
-Requires-Dist: pyproj
-Requires-Dist: pyresample
-Requires-Dist: rasterio
-Requires-Dist: rasters
-Requires-Dist: requests
-Requires-Dist: scikit-image
-Requires-Dist: scipy
-Requires-Dist: shapely
-Requires-Dist: six
+Requires-Dist: rasters>=1.4.6
+Requires-Dist: SEBAL-soil-heat-flux
 Requires-Dist: sun-angles
-Requires-Dist: tensorflow
-Requires-Dist: urllib3
+Requires-Dist: verma-net-radiation
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest>=6.0; extra == "dev"

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/PM_JPL.egg-info/SOURCES.txt

@@ -10,17 +10,15 @@ PMJPL/constants.py
 PMJPL/correctance_factor.py
 PMJPL/fwet.py
 PMJPL/interception.py
+PMJPL/mod16.csv
 PMJPL/parameters.py
 PMJPL/potential_soil_evaporation.py
 PMJPL/soil_moisture_constraint.py
 PMJPL/tmin_factor.py
 PMJPL/transpiration.py
+PMJPL/version.txt
 PMJPL/wet_canopy_resistance.py
 PMJPL/wet_soil_evaporation.py
-PMJPL/MCD12C1/MCD12C1.py
-PMJPL/MCD12C1/__init__.py
-PMJPL/SEBAL/SEBAL.py
-PMJPL/SEBAL/__init__.py
 PMJPL/downscaling/__init__.py
 PMJPL/downscaling/downscaling.py
 PMJPL/downscaling/linear_downscale.py
@@ -34,12 +32,8 @@ PMJPL/priestley_taylor/__init__.py
 PMJPL/priestley_taylor/priestley_taylor.py
 PMJPL/santanello/__init__.py
 PMJPL/santanello/santanello.py
-PMJPL/soil_heat_flux/__init__.py
-PMJPL/soil_heat_flux/soil_heat_flux.py
 PMJPL/vegetation_conversion/__init__.py
 PMJPL/vegetation_conversion/vegetation_conversion.py
-PMJPL/verma_net_radiation/__init__.py
-PMJPL/verma_net_radiation/verma_net_radiation.py
 PM_JPL.egg-info/PKG-INFO
 PM_JPL.egg-info/SOURCES.txt
 PM_JPL.egg-info/dependency_links.txt

pm_jpl-1.3.0/PM_JPL.egg-info/requires.txt

@@ -0,0 +1,21 @@
+check-distribution
+ECOv002-CMR>=1.0.5
+ECOv002-granules>=1.0.3
+ECOv003-granules
+GEOS5FP>=1.1.1
+MCD12C1_2019_v006
+NASADEM
+numpy
+pandas
+rasters>=1.4.6
+SEBAL-soil-heat-flux
+sun-angles
+verma-net-radiation
+
+[dev]
+build
+pytest>=6.0
+pytest-cov
+jupyter
+pytest
+twine

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "PM-JPL"
-version = "1.2.1"
+version = "1.3.0"
 description = "JPL implementation of the MOD16 evapotranspiration algorithm for high resolution instantaneous remote sensing imagery"
 readme = "README.md"
 authors = [
@@ -18,28 +18,19 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "affine",
-    "astropy",
-    "geopandas",
-    "h5py",
-    "keras",
-    "matplotlib",
+    "check-distribution",
+    "ECOv002-CMR>=1.0.5",
+    "ECOv002-granules>=1.0.3",
+    "ECOv003-granules",
+    "GEOS5FP>=1.1.1",
+    "MCD12C1_2019_v006",
+    "NASADEM",
     "numpy",
     "pandas",
-    "pillow",
-    "pygeos",
-    "pyproj",
-    "pyresample",
-    "rasterio",
-    "rasters",
-    "requests",
-    "scikit-image",
-    "scipy",
-    "shapely",
-    "six",
+    "rasters>=1.4.6",
+    "SEBAL-soil-heat-flux",
     "sun-angles",
-    "tensorflow",
-    "urllib3",
+    "verma-net-radiation"
 ]
 
 requires-python = ">=3.10"
@@ -55,7 +46,7 @@ dev = [
 ]
 
 [tool.setuptools.package-data]
-PM_JPL = ["*.txt", "*.csv", "*.tif"]
+PMJPL = ["*.txt", "*.csv", "*.tif"]
 
 [project.urls]
 "Homepage" = "https://github.com/JPL-Evapotranspiration-Algorithms/PM-JPL"

{pm_jpl-1.2.1 → pm_jpl-1.3.0}/tests/test_import_dependencies.py

@@ -2,26 +2,15 @@ import pytest
 
 # List of dependencies
 dependencies = [
-    "affine",
-    "astropy",
-    "geopandas",
-    "h5py",
-    "keras",
-    "matplotlib",
+    "ECOv002_CMR",
+    "ECOv002_granules",
+    "GEOS5FP",
+    "NASADEM",
     "numpy",
-    "PIL",
     "pandas",
-    "pyproj",
-    "pyresample",
-    "rasterio",
-    "requests",
-    "scipy",
-    "shapely",
-    "six",
-    "skimage",
+    "rasters",
     "sun_angles",
-    "tensorflow",
-    "urllib3"
+    "verma_net_radiation"
 ]
 
 # Generate individual test functions for each dependency

pm_jpl-1.2.1/PMJPL/MCD12C1/MCD12C1.py

@@ -1,10 +0,0 @@
-from os.path import join, abspath, dirname
-import numpy as np
-import rasters as rt
-from rasters import Raster, RasterGeometry
-
-def load_MCD12C1_IGBP(geometry: RasterGeometry = None) -> Raster:
-    filename = join(abspath(dirname(__file__)), "MCD12C1.A2019001.006.2020220162300.tif")
-    image = rt.Raster.open(filename, geometry=geometry, resampling="nearest")
-
-    return image

pm_jpl-1.2.1/PMJPL/MCD12C1/__init__.py

@@ -1 +0,0 @@
-from .MCD12C1 import *

pm_jpl-1.2.1/PMJPL/SEBAL/SEBAL.py

@@ -1,45 +0,0 @@
-import numpy as np
-import pandas as pd
-import rasters as rt
-
-def calculate_soil_heat_flux(Rn: np.ndarray, ST_C: np.ndarray, NDVI: np.ndarray, albedo: np.ndarray) -> np.ndarray:
-    """
-    This function calculates the soil heat flux (G) in the Surface Energy Balance Algorithm for Land (SEBAL) model.
-    The formula used in the function is a simplification of the more complex relationship between these variables in the energy balance at the surface.
-    
-    Parameters:
-    Rn (np.ndarray): Net radiation at the surface.
-    ST_C (np.ndarray): Surface temperature in Celsius.
-    NDVI (np.ndarray): Normalized Difference Vegetation Index, indicating the presence and condition of vegetation.
-    albedo (np.ndarray): Measure of the diffuse reflection of solar radiation.
-    
-    Returns:
-    np.ndarray: The soil heat flux (G), a key component in the energy balance.
-    
-    Reference:
-    "Evapotranspiration Estimation Based on Remote Sensing and the SEBAL Model in the Bosten Lake Basin of China" [^1^][1]
-    """
-    # Empirical coefficients used in the calculation
-    coeff1 = 0.0038
-    coeff2 = 0.0074
-    
-    # Vegetation cover correction factor
-    NDVI_correction = 1 - 0.98 * NDVI ** 4
-    
-    # Calculation of the soil heat flux (G)
-    G = Rn * ST_C * (coeff1 + coeff2 * albedo) * NDVI_correction
-    
-    G = rt.clip(G, 0, None)
-
-    return G
-
-def process_SEBAL_G_table(input_df: pd.DataFrame) -> pd.DataFrame:
-    Rn = input_df.Rn
-    ST_C = input_df.ST_C
-    NDVI = input_df.NDVI
-    albedo = input_df.albedo
-    G = calculate_soil_heat_flux(Rn=Rn, ST_C=ST_C, NDVI=NDVI, albedo=albedo)
-    output_df = input_df.copy()
-    output_df["G"] = G
-
-    return output_df

pm_jpl-1.2.1/PMJPL/SEBAL/__init__.py

@@ -1 +0,0 @@
-from .SEBAL import *

pm_jpl-1.2.1/PMJPL/soil_heat_flux/__init__.py

@@ -1 +0,0 @@
-from .soil_heat_flux import *

pm_jpl-1.2.1/PMJPL/soil_heat_flux/soil_heat_flux.py

@@ -1,62 +0,0 @@
-from typing import Union
-import numpy as np
-
-import rasters as rt
-from rasters import Raster
-
-from ..santanello import calculate_soil_heat_flux as santanello_G
-from ..SEBAL import calculate_soil_heat_flux as SEBAL_G
-
-DEFAULT_G_METHOD = "santanello"
-
-def calculate_soil_heat_flux(
-        seconds_of_day: Union[Raster, np.ndarray] = None,
-        ST_C: Union[Raster, np.ndarray] = None,
-        NDVI: Union[Raster, np.ndarray] = None,
-        albedo: Union[Raster, np.ndarray] = None,
-        Rn: Union[Raster, np.ndarray] = None, 
-        SM: Union[Raster, np.ndarray] = None, 
-        method: str = DEFAULT_G_METHOD) -> Union[Raster, np.ndarray]:
-    """
-    The method estimates soil heat flux (G) as a function of time of day, net radiation (Rn), soil moisture (SM), 
-    surface temperature (ST_C), Normalized Difference Vegetation Index (NDVI), and albedo. The method used for 
-    calculation can be specified.
-
-    Parameters:
-    seconds_of_day (np.ndarray): Time in seconds of the day since midnight.
-    ST_C (np.ndarray): Surface temperature in Celsius.
-    NDVI (np.ndarray): Normalized Difference Vegetation Index.
-    albedo (np.ndarray): Albedo of the surface.
-    Rn (np.ndarray): Net radiation in W/m^2.
-    SM (np.ndarray): Soil moisture in m^3/m^3.
-    method (str, optional): Method to be used for calculation. Defaults to "santanello".
-
-    Returns:
-    G (np.ndarray): Soil heat flux in W/m^2.
-    """
-
-    # FIXME make sure G doesn't drop to extreme negative values
-
-    if method == "santanello":
-        G = santanello_G(
-            seconds_of_day=seconds_of_day,
-            Rn=Rn,
-            SM=SM
-        )
-    elif method == "SEBAL":
-        G = SEBAL_G(
-            Rn=Rn,
-            ST_C=ST_C,
-            NDVI=NDVI,
-            albedo=albedo
-        )
-    elif method == "MOD16":
-        G = (-0.276 * NDVI + 0.35) * Rn
-    elif method == "PTJPL":
-        G = rt.clip(Rn * (0.05 + (1 - rt.clip(NDVI, 0, 1)) * 0.265), 0, 0.35 * Rn)
-    else:
-        raise ValueError(f"invalid soil heat flux method: {method}")
-    
-    G = rt.clip(G, 0, None)
-
-    return G

pm_jpl-1.2.1/PMJPL/verma_net_radiation/__init__.py

@@ -1 +0,0 @@
-from .verma_net_radiation import *

pm_jpl-1.2.1/PMJPL/verma_net_radiation/verma_net_radiation.py

@@ -1,108 +0,0 @@
-from typing import Union, Dict
-import warnings
-import numpy as np
-from sun_angles import daylight_from_SHA
-from sun_angles import sunrise_from_SHA
-from sun_angles import SHA_deg_from_DOY_lat
-from rasters import Raster
-
-STEFAN_BOLTZMAN_CONSTANT = 5.67036713e-8  # SI units watts per square meter per kelvin to the fourth
-
-
-def process_verma_net_radiation(
-        SWin: np.ndarray,
-        albedo: np.ndarray,
-        ST_C: np.ndarray,
-        emissivity: np.ndarray,
-        Ta_C: np.ndarray,
-        RH: np.ndarray,
-        cloud_mask: np.ndarray = None) -> Dict:
-    results = {}
-
-    # Convert surface temperature from Celsius to Kelvin
-    ST_K = ST_C + 273.15
-
-    # Convert air temperature from Celsius to Kelvin
-    Ta_K = Ta_C + 273.15
-
-    # Calculate water vapor pressure in Pascals using air temperature and relative humidity
-    Ea_Pa = (RH * 0.6113 * (10 ** (7.5 * (Ta_K - 273.15) / (Ta_K - 35.85)))) * 1000
-    
-    # constrain albedo between 0 and 1
-    albedo = np.clip(albedo, 0, 1)
-
-    # calculate outgoing shortwave from incoming shortwave and albedo
-    SWout = np.clip(SWin * albedo, 0, None)
-    results["SWout"] = SWout
-
-    # calculate instantaneous net radiation from components
-    SWnet = np.clip(SWin - SWout, 0, None)
-
-    # calculate atmospheric emissivity
-    eta1 = 0.465 * Ea_Pa / Ta_K
-    # atmospheric_emissivity = (1 - (1 + eta1) * np.exp(-(1.2 + 3 * eta1) ** 0.5))
-    eta2 = -(1.2 + 3 * eta1) ** 0.5
-    eta2 = eta2.astype(float)
-    eta3 = np.exp(eta2)
-    atmospheric_emissivity = np.where(eta2 != 0, (1 - (1 + eta1) * eta3), np.nan)
-
-    if cloud_mask is None:
-        # calculate incoming longwave for clear sky
-        LWin = atmospheric_emissivity * STEFAN_BOLTZMAN_CONSTANT * Ta_K ** 4
-    else:
-        # calculate incoming longwave for clear sky and cloudy
-        LWin = np.where(
-            ~cloud_mask,
-            atmospheric_emissivity * STEFAN_BOLTZMAN_CONSTANT * Ta_K ** 4,
-            STEFAN_BOLTZMAN_CONSTANT * Ta_K ** 4
-        )
-    
-    results["LWin"] = LWin
-
-    # constrain emissivity between 0 and 1
-    emissivity = np.clip(emissivity, 0, 1)
-
-    # calculate outgoing longwave from land surface temperature and emissivity
-    LWout = emissivity * STEFAN_BOLTZMAN_CONSTANT * ST_K ** 4
-    results["LWout"] = LWout
-
-    # LWnet = np.clip(LWin - LWout, 0, None)
-    LWnet = np.clip(LWin - LWout, 0, None)
-
-    # constrain negative values of instantaneous net radiation
-    Rn = np.clip(SWnet + LWnet, 0, None)
-    results["Rn"] = Rn
-
-    return results
-
-def daily_Rn_integration_verma(
-        Rn: Union[Raster, np.ndarray],
-        hour_of_day: Union[Raster, np.ndarray],
-        DOY: Union[Raster, np.ndarray] = None,
-        lat: Union[Raster, np.ndarray] = None,
-        sunrise_hour: Union[Raster, np.ndarray] = None,
-        daylight_hours: Union[Raster, np.ndarray] = None) -> Raster:
-    """
-    calculate daily net radiation using solar parameters
-    this is the average rate of energy transfer from sunrise to sunset
-    in watts per square meter
-    watts are joules per second
-    to get the total amount of energy transferred, factor seconds out of joules
-    the number of seconds for which this average is representative is (daylight_hours * 3600)
-    documented in verma et al, bisht et al, and lagouARDe et al
-    :param Rn:
-    :param hour_of_day:
-    :param sunrise_hour:
-    :param daylight_hours:
-    :return:
-    """
-    if daylight_hours is None or sunrise_hour is None and DOY is not None and lat is not None:
-        sha_deg = SHA_deg_from_DOY_lat(DOY=DOY, latitude=lat)
-        daylight_hours = daylight_from_SHA(sha_deg)
-        sunrise_hour = sunrise_from_SHA(sha_deg)
-
-    with warnings.catch_warnings():
-        warnings.filterwarnings("ignore")
-        Rn_daily = 1.6 * Rn / (np.pi * np.sin(np.pi * (hour_of_day - sunrise_hour) / (daylight_hours)))
-    
-    return Rn_daily

pm_jpl-1.2.1/PM_JPL.egg-info/requires.txt

@@ -1,30 +0,0 @@
-affine
-astropy
-geopandas
-h5py
-keras
-matplotlib
-numpy
-pandas
-pillow
-pygeos
-pyproj
-pyresample
-rasterio
-rasters
-requests
-scikit-image
-scipy
-shapely
-six
-sun-angles
-tensorflow
-urllib3
-
-[dev]
-build
-pytest>=6.0
-pytest-cov
-jupyter
-pytest
-twine