STIC-JPL 1.1.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

STIC_JPL/meteorology_conversion/meteorology_conversion.py

@@ -1,123 +0,0 @@
-from typing import Union
-import numpy as np
-import rasters as rt
-from rasters import Raster
-
-# gas constant for dry air in joules per kilogram per kelvin
-RD = 286.9
-
-# gas constant for moist air in joules per kilogram per kelvin
-RW = 461.5
-
-# specific heat of water vapor in joules per kilogram per kelvin
-CPW = 1846.0
-
-# specific heat of dry air in joules per kilogram per kelvin
-CPD = 1005.0
-
-def kelvin_to_celsius(T_K: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    convert temperature in kelvin to celsius.
-    :param T_K: temperature in kelvin
-    :return: temperature in celsius
-    """
-    return T_K - 273.15
-
-def celcius_to_kelvin(T_C: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    convert temperature in celsius to kelvin.
-    :param T_C: temperature in celsius
-    :return: temperature in kelvin
-    """
-    return T_C + 273.15
-
-def calculate_specific_humidity(
-        Ea_Pa: Union[Raster, np.ndarray], 
-        Ps_Pa: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    Calculate the specific humidity of air as a ratio of kilograms of water to kilograms of air.
-    
-    Args:
-        Ea_Pa (Union[Raster, np.ndarray]): Actual water vapor pressure in Pascal.
-        surface_pressure_Pa (Union[Raster, np.ndarray]): Surface pressure in Pascal.
-    
-    Returns:
-        Union[Raster, np.ndarray]: Specific humidity in kilograms of water per kilograms of air.
-    """
-    return ((0.622 * Ea_Pa) / (Ps_Pa - (0.387 * Ea_Pa)))
-
-def calculate_specific_heat(specific_humidity: Union[Raster, np.ndarray]):
-    # calculate specific heat capacity of the air (Cp)
-    # in joules per kilogram per kelvin
-    # from specific heat of water vapor (CPW)
-    # and specific heat of dry air (CPD)
-    Cp_Jkg = specific_humidity * CPW + (1 - specific_humidity) * CPD
-
-    return Cp_Jkg
-
-def calculate_air_density(
-        surface_pressure_Pa: Union[Raster, np.ndarray], 
-        Ta_K: Union[Raster, np.ndarray], 
-        specific_humidity: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    Calculate air density.
-
-    Parameters:
-    surface_pressure_Pa (Union[Raster, np.ndarray]): Surface pressure in Pascal.
-    Ta_K (Union[Raster, np.ndarray]): Air temperature in Kelvin.
-    specific_humidity (Union[Raster, np.ndarray]): Specific humidity.
-
-    Returns:
-    Union[Raster, np.ndarray]: Air density in kilograms per cubic meter.
-    """
-    # numerator: Pa(N / m ^ 2 = kg * m / s ^ 2); denominator: J / kg / K * K)
-    rhoD = surface_pressure_Pa / (RD * Ta_K)
-
-    # calculate air density (rho) in kilograms per cubic meter
-    rho = rhoD * ((1.0 + specific_humidity) / (1.0 + specific_humidity * (RW / RD)))
-
-    return rho
-
-def SVP_kPa_from_Ta_C(Ta_C: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    Calculate the saturation vapor pressure in kiloPascal (kPa) from air temperature in Celsius.
-
-    Parameters:
-    Ta_C (Union[Raster, np.ndarray]): Air temperature in Celsius.
-
-    Returns:
-    Union[Raster, np.ndarray]: Saturation vapor pressure in kPa.
-
-    """
-    SVP_kPa = np.clip(0.611 * np.exp((Ta_C * 17.27) / (Ta_C + 237.7)), 1, None)
-
-    return SVP_kPa
-
-def SVP_Pa_from_Ta_C(Ta_C: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    Calculate the saturation vapor pressure in Pascal (Pa) from the air temperature in Celsius (Ta_C).
-
-    Parameters:
-        Ta_C (Union[Raster, np.ndarray]): Air temperature in Celsius.
-
-    Returns:
-        Union[Raster, np.ndarray]: Saturation vapor pressure in Pascal (Pa).
-    """
-    return SVP_kPa_from_Ta_C(Ta_C) * 1000
-
-def calculate_surface_pressure(elevation_m: Union[Raster, np.ndarray], Ta_C: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
-    """
-    Calculate surface pressure using elevation and air temperature.
-
-    Parameters:
-        elevation_m (Union[Raster, np.ndarray]): Elevation in meters.
-        Ta_K (Union[Raster, np.ndarray]): Air temperature in Kelvin.
-
-    Returns:
-        Union[Raster, np.ndarray]: Surface pressure in Pascal (Pa).
-    """
-    Ta_K = kelvin_to_celsius(Ta_C)
-    Ps_Pa = 101325.0 * (1.0 - 0.0065 * elevation_m / Ta_K) ** (9.807 / (0.0065 * 287.0))  # [Pa]
-
-    return Ps_Pa
-

STIC_JPL/soil_heat_flux/__init__.py

@@ -1 +0,0 @@
-from .calculate_SEBAL_soil_heat_flux import calculate_SEBAL_soil_heat_flux

STIC_JPL/soil_heat_flux/calculate_SEBAL_soil_heat_flux.py

@@ -1,40 +0,0 @@
-from typing import Union
-
-import numpy as np
-import rasters as rt
-from rasters import Raster
-
-def calculate_SEBAL_soil_heat_flux(
-        Rn: Union[Raster, np.ndarray], 
-        ST_C: Union[Raster, np.ndarray], 
-        NDVI: Union[Raster, np.ndarray], 
-        albedo: Union[Raster, np.ndarray]) -> Union[Raster, 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

STIC_JPL/timer/__init__.py

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

STIC_JPL/timer/timer.py

@@ -1,77 +0,0 @@
-"""
-This is a minimalistic performance timer.
-"""
-import time
-
-__author__ = "Gregory Halverson"
-
-DEFAULT_FORMAT = "0.2f"
-
-class Timer(object):
-    """
-    This is a minimalistic performance timer.
-    """
-
-    def __init__(self):
-        self._start_time = None
-        self._end_time = None
-        self.start()
-
-    def __enter__(self, *args, **kwargs):
-        self.start()
-        return self
-
-    def __exit__(self, *args, **kwargs):
-        self.end()
-
-    def __repr__(self):
-        # print("Timer.__repr__")
-        return self.__format__(format_string=DEFAULT_FORMAT)
-
-    def __str__(self):
-        # print("Timer.__str__")
-        return self.__repr__()
-
-    def __format__(self, format_string=DEFAULT_FORMAT):
-        if format_string is None or format_string == "":
-            format_string = DEFAULT_FORMAT
-
-        return format(self.duration, format_string)
-
-    @property
-    def now(self):
-        # return datetime.now()
-        return time.perf_counter()
-
-    def start(self):
-        self._start_time = self.now
-
-        return self.start_time
-
-    @property
-    def start_time(self):
-        return self._start_time
-
-    def end(self):
-        self._end_time = self.now
-
-        return self.end_time
-
-    @property
-    def end_time(self):
-        return self._end_time
-
-    @property
-    def duration(self):
-        if self.start_time is None:
-            raise Exception("timer never started")
-
-        if self.end_time is None:
-            end_time = self.now
-        else:
-            end_time = self.end_time
-
-        duration = end_time - self.start_time
-
-        return duration
-

STIC_JPL/vegetation_conversion/__init__.py

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

STIC_JPL/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

stic_jpl-1.1.0.dist-info/RECORD

@@ -1,28 +0,0 @@
-STIC_JPL/STIC_JPL.py,sha256=a0EpRTX6Sd75RPIqAzWckIuj9-KwbCE8T1aSEDpLM-c,17434
-STIC_JPL/__init__.py,sha256=FmTp-Ir0Wbae0SbZgxlNIxq48TDrWCev17Gv1hWskxU,216
-STIC_JPL/canopy_air_stream.py,sha256=UYp3l7mt0XH4SqvCGZhRzCIL-v7-Rvxxfm-C81lheSU,1637
-STIC_JPL/closure.py,sha256=AzWoLnpoZ1MlQAKq0CgpmCMfDGVsp8-hYZ50ry33cic,4031
-STIC_JPL/constants.py,sha256=xIVTsdc3_Rf3EPSgSk1QPjWiojFGn4lf1Swffov3oTM,595
-STIC_JPL/diagnostic.py,sha256=RXjtZbCEJMiTyRuiMGUvekDgO_GcrhXVXvorR0WlAsk,2613
-STIC_JPL/initialize_with_solar.py,sha256=6DUUHdVfeKvDk1pf_bOteSW8qd-n9pU4dowO1sMYOpw,3825
-STIC_JPL/initialize_without_solar.py,sha256=M_7QfP2pr2w5sQO7UOW1GPqxpmQkjmsQ526BgYVVALk,4675
-STIC_JPL/iterate_with_solar.py,sha256=WKySvuIJ4HzcDni0UYafmk5lXex2lJfde82kGnGUDI8,6368
-STIC_JPL/iterate_without_solar.py,sha256=09RERpN6tdZr6ORDhMwEFXwx8941vyn1HMJQ-Q_bY6s,6140
-STIC_JPL/net_radiation.py,sha256=Uwudsazul8V-x5t8KQLi3wpYi-wjMwT__eqZCRV2bIw,1187
-STIC_JPL/root_zone_initialization.py,sha256=3JVKNDt3ebIiGVfuhBawjKs-BicNwkbfMprkzSxd4Cg,1581
-STIC_JPL/root_zone_iteration.py,sha256=1XOMFE3-TdJZzUU5vouflUO4NKaZwAW6s1KJrNez3Es,3787
-STIC_JPL/soil_moisture_initialization.py,sha256=YF0GcHkpH5amABNPpxD8f1lLPRyIAkG2dYJTfEuIX4g,5599
-STIC_JPL/soil_moisture_iteration.py,sha256=QJXOPMxxwIIskpx9zLkXUPfuhWgFPUBcRnGhZo2UjAw,6493
-STIC_JPL/version.txt,sha256=rqWtvvV0eFJzxPOcG3aHz4AZk-DLa_Z4GkFonk7bsgw,5
-STIC_JPL/meteorology_conversion/__init__.py,sha256=dLF40imqJCC_l8_QMetbsj1YzkXZuFt9tQ2fsd7Wcdw,38
-STIC_JPL/meteorology_conversion/meteorology_conversion.py,sha256=8vzx71FLLNhR5v6EQBL8OSgAmupQcgdLX2c9tL9TPxA,4202
-STIC_JPL/soil_heat_flux/__init__.py,sha256=bN0dHUfqR9ob68M1TqdjQTK3kmaL5S4P08yK0Thub6k,74
-STIC_JPL/soil_heat_flux/calculate_SEBAL_soil_heat_flux.py,sha256=PZylUGET5-Uj6BGfhOeqS4tp2pGE__gdc5X1nidLjxw,1516
-STIC_JPL/timer/__init__.py,sha256=I_MQKp_aamBLUzZv0psEbRgs6GZLOJd4mmJ7bli0Ikc,21
-STIC_JPL/timer/timer.py,sha256=tn5e3NQmsh55Jp9Fstjf-8KJW4F8UIJs-d_ZLooFYE8,1610
-STIC_JPL/vegetation_conversion/__init__.py,sha256=8gnz0yK_euCV0TtVGDrSGaVfx4g0EJCG2J68ppuA5oc,37
-STIC_JPL/vegetation_conversion/vegetation_conversion.py,sha256=-K3FLV6pXkpxtRxQvimqqkXAgkn9mUUlHQ8FIscq1Zg,1306
-stic_jpl-1.1.0.dist-info/METADATA,sha256=sDO9vRDdU6d-qTxHfk-0ZoCLX5ZyT1o1F086M0hbqWA,5348
-stic_jpl-1.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-stic_jpl-1.1.0.dist-info/top_level.txt,sha256=9NkchxttzACJcGcAaWzMaZarzX40OXQ216hERNA9LIo,9
-stic_jpl-1.1.0.dist-info/RECORD,,