PM-JPL 1.2.1__py3-none-any.whl → 1.7.0__py3-none-any.whl

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

PMJPL/vegetation_conversion/__init__.py

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

PMJPL/vegetation_conversion/vegetation_conversion.py

@@ -1,47 +0,0 @@
-from typing import Union
-import numpy as np
-import rasters as rt
-from rasters import Raster
-
-KPAR = 0.5
-MIN_FIPAR = 0.0
-MAX_FIPAR = 1.0
-MIN_LAI = 0.0
-MAX_LAI = 10.0
-
-def FVC_from_NDVI(NDVI: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    Convert Normalized Difference Vegetation Index (NDVI) to Fractional Vegetation Cover (FVC).
-
-    Parameters:
-        NDVI (Union[Raster, np.ndarray]): Input NDVI data.
-
-    Returns:
-        Union[Raster, np.ndarray]: Converted FVC data.
-    """
-    NDVIv = 0.52  # +- 0.03
-    NDVIs = 0.04  # +- 0.03
-    FVC = rt.clip((NDVI - NDVIs) / (NDVIv - NDVIs), 0.0, 1.0)
-
-    return FVC
-
-def LAI_from_NDVI(
-        NDVI: Union[Raster, np.ndarray],
-        min_fIPAR: float = MIN_FIPAR,
-        max_fIPAR: float = MAX_FIPAR,
-        min_LAI: float = MIN_LAI,
-        max_LAI: float = MAX_LAI) -> Union[Raster, np.ndarray]:
-    """
-    Convert Normalized Difference Vegetation Index (NDVI) to Leaf Area Index (LAI).
-
-    Parameters:
-        NDVI (Union[Raster, np.ndarray]): Input NDVI data.
-
-    Returns:
-        Union[Raster, np.ndarray]: Converted LAI data.
-    """
-    fIPAR = rt.clip(NDVI - 0.05, min_fIPAR, max_fIPAR)
-    fIPAR = np.where(fIPAR == 0, np.nan, fIPAR)
-    LAI = rt.clip(-np.log(1 - fIPAR) * (1 / KPAR), min_LAI, max_LAI)
-
-    return LAI

PMJPL/verma_net_radiation/__init__.py

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

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.dist-info/RECORD

@@ -1,44 +0,0 @@
-PMJPL/PMJPL.py,sha256=QXhLgqeOiLCFjtYHr_01hUfusVL_iOqeK_PXANeKdsU,12819
-PMJPL/VPD_factor.py,sha256=mEi3qXClc07QT2wlfCgzaFkERbm_D8JqWKmB86pJMVk,970
-PMJPL/__init__.py,sha256=rqFqtI2rLgIxSN3i2J8wZVoT2EpHYgVizfZt8ctwqsc,213
-PMJPL/canopy_aerodynamic_resistance.py,sha256=ejcmjGNimv2aja6WFRC_2D_48YD2fVHE3ndWHbGbxfM,1217
-PMJPL/canopy_conductance.py,sha256=1e2KwFGiRrXMJvG0iHwP3cpQ68HFB44eQ0CXsv1mQ-A,1367
-PMJPL/constants.py,sha256=Az7hftY_CIibJdvRdQcDisRdKqJYm8khktakCcNZtXU,787
-PMJPL/correctance_factor.py,sha256=V93rZcv5DM3LfujhEK8mRgJ-GHk868hDbTmcg8VoOAo,582
-PMJPL/fwet.py,sha256=-5GEGC1ohKBzsuYGLNiCaVe10DQLm82rsZTZGVxb4WY,616
-PMJPL/interception.py,sha256=lJ_kAa_Xkr21iWcVtSmLoNPfHEzCuiFSVRxB4-NUs9k,1689
-PMJPL/parameters.py,sha256=hiMXIafFkS4rqDQVvPhCFuiLc-WXTwlRyS-eIK9vQuk,1973
-PMJPL/potential_soil_evaporation.py,sha256=Xq-cvOqOa9W1FFHMmPKGtZs18tiDRUDOQ86-8rONO_Y,1823
-PMJPL/soil_moisture_constraint.py,sha256=URUGsE1_p2P1dVQ8qKRcKb93hahYWtAmYqoassRu-PI,667
-PMJPL/tmin_factor.py,sha256=BqSPM3Y8eB2fekSxUf9dzmAT_5UPNz0eY_wWnlvn1Xg,1595
-PMJPL/transpiration.py,sha256=8wxCsXURWabn8ARUDnekG3-igdygtlX9SgLrQu_RMaA,1980
-PMJPL/wet_canopy_resistance.py,sha256=q1RBq6SePklb-XLmv3zPbLX5rxtZ4uxvEecB9faJlyE,792
-PMJPL/wet_soil_evaporation.py,sha256=1lZ0qokBffZTCKuuh0M3jYtR2nbJyVLe15gFzXRlBU0,1416
-PMJPL/MCD12C1/MCD12C1.py,sha256=2zq6QW9SJGnADwbExZ7JvAaUcBrHeBSDiRS46RrumAY,378
-PMJPL/MCD12C1/__init__.py,sha256=4_gn1pQK9nuh7ZuUTFpaFhT6ypSvsIxBwIpOYmw5Vfg,23
-PMJPL/SEBAL/SEBAL.py,sha256=IBKKYbZzk0WOND6eRVdgTyqnsLriwOFECGBKIf0nOFk,1688
-PMJPL/SEBAL/__init__.py,sha256=IK_eHynpUb_XvECuLOfE0h3Js-4vdeXqCEe9y5oeKWw,21
-PMJPL/downscaling/__init__.py,sha256=xvhP4rHzx-nK_R6HSarJ-WF1bMPXYZGvvr8Hk84-q40,27
-PMJPL/downscaling/downscaling.py,sha256=VuhFbK92llJbtkOtJpah_51sM5ctFJ9oNUaH4aaNO7g,8447
-PMJPL/downscaling/linear_downscale.py,sha256=Yi0d2rb1XVSlBJoL2Arq9RtU5FH1RJ98MHLngJIYUjM,2466
-PMJPL/evapotranspiration_conversion/__init__.py,sha256=21wYXP8FJT63MpUTbHu0wGntyFFeiGDRneGMKCNAu8Q,45
-PMJPL/evapotranspiration_conversion/evapotranspiration_conversion.py,sha256=kwxLb_Vli_Tfal4lWBHMkEMmpCV7Kha_0wgqk8HjlXs,2754
-PMJPL/meteorology_conversion/__init__.py,sha256=dLF40imqJCC_l8_QMetbsj1YzkXZuFt9tQ2fsd7Wcdw,38
-PMJPL/meteorology_conversion/meteorology_conversion.py,sha256=8vzx71FLLNhR5v6EQBL8OSgAmupQcgdLX2c9tL9TPxA,4202
-PMJPL/penman_monteith/__init__.py,sha256=vcfkNo6BLDCfSF9HZFDvRMAKCx49F9idN7iNTKQCpcA,31
-PMJPL/penman_monteith/penman_monteith.py,sha256=2rSFP9_DBz1vMSbVyBQGhW-VXXb5XT8a7ls8sCstfXU,819
-PMJPL/priestley_taylor/__init__.py,sha256=E0SiG_DNAsMz_8A3342UPwbDyrMOgd35AZ-plaJar5s,32
-PMJPL/priestley_taylor/priestley_taylor.py,sha256=Rj168jfWHSBhGeUkDs6ePrVsHhFbmUujzQaA8z0fCXE,1126
-PMJPL/santanello/__init__.py,sha256=HXZS1p3sp4mDJCXkdq___ZIJ9etu7-B8yauJcFvQFgQ,26
-PMJPL/santanello/santanello.py,sha256=lvgskYrirQz0t1m4XNSj8hLzrESS-oVZzMvAnVPyt3g,1521
-PMJPL/soil_heat_flux/__init__.py,sha256=bES8bWQhwRLmyJPsaFB190yiuz2mHyJM1X8Q1KbwwEE,30
-PMJPL/soil_heat_flux/soil_heat_flux.py,sha256=wg5h6FmIxGFYDFRyQ_0D3GaL5PIiYonuz8u4o8MPaKw,2092
-PMJPL/vegetation_conversion/__init__.py,sha256=8gnz0yK_euCV0TtVGDrSGaVfx4g0EJCG2J68ppuA5oc,37
-PMJPL/vegetation_conversion/vegetation_conversion.py,sha256=-K3FLV6pXkpxtRxQvimqqkXAgkn9mUUlHQ8FIscq1Zg,1306
-PMJPL/verma_net_radiation/__init__.py,sha256=5TzlqNWajiVxbQdUqjWuu17oBrTmjIeaF40nQPnVzWo,35
-PMJPL/verma_net_radiation/verma_net_radiation.py,sha256=Y4OxcuBXTY6IZzZ6cXjxp2xTyeSAfYQ_itws0PcSc-I,3869
-pm_jpl-1.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pm_jpl-1.2.1.dist-info/METADATA,sha256=RxFlP8a66o37oND4TnqyInBGyVzslenurjZy-zZvz2w,4260
-pm_jpl-1.2.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pm_jpl-1.2.1.dist-info/top_level.txt,sha256=YaAFwdYHUxfUW08hiuFquUEdDGrsYn1duuMMjJKh0Ws,6
-pm_jpl-1.2.1.dist-info/RECORD,,