ECOv002-calval-tables 1.5.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

ECOv002_calval_tables/ECOv002_calval_tables.py

@@ -3,3 +3,4 @@ from .error_funcs import *
 from .plot_funcs import *
 from .ec_lib import *
 from .plot_single_model import *
+from .upscale_to_daylight import *

ECOv002_calval_tables/load_tables.py

@@ -6,6 +6,8 @@ import geopandas as gpd
 
 from shapely.geometry import Point
 
+from .upscale_to_daylight import upscale_to_daylight
+
 def load_combined_eco_flux_ec_filtered() -> pd.DataFrame:
     """
     Load the filtered eddy covariance (EC) flux dataset used for ECOSTRESS Collection 2 ET product validation.
@@ -64,4 +66,6 @@ def load_calval_table() -> gpd.GeoDataFrame:
     # Convert merged DataFrame to GeoDataFrame
     gdf = gpd.GeoDataFrame(merged_df, geometry=merged_df["geometry"], crs="EPSG:4326")
     
+    gdf = upscale_to_daylight(gdf)
+
     return gdf

ECOv002_calval_tables/plot_single_model.py

@@ -3,28 +3,51 @@ import matplotlib.pyplot as plt
 import numpy as np
 import matplotlib.lines as mlines
 import os
+from . import error_funcs
+
 import pandas as pd
 from typing import Optional
-from . import error_funcs
 
 def quick_look_plot_single_model(
-    big_df_ss: pd.DataFrame,
-    time: str,
-    model_col: str,
+    calval_table_df: pd.DataFrame,
+    model_output_variable_name: str,
     model_name: str,
-    LE_var: str = 'LEcorr50',
-    output_filename: Optional[str] = None
-) -> None:
+    insitu_variable_name: str = 'LEcorr50'
+) -> plt.Figure:
     """
-    Plots the results for a single model against flux tower LE.
-    Parameters:
-        big_df_ss: pd.DataFrame containing all data
-        time: string for output file naming
-        model_col: column name for model output
-        model_name: display name for the model
-        LE_var: column name for flux tower LE (default 'LEcorr50')
-        output_filename: Optional path for output figure file. If None, figure is not saved.
+    Generate a scatter plot comparing model output to flux tower latent energy (LE) measurements, color-coded by vegetation type, with error bars and annotated performance metrics.
+
+    This function is designed for visual evaluation of model performance against observed data, and is suitable for use in Jupyter notebooks (returns a matplotlib Figure object for direct display).
+
+    Parameters
+    ----------
+    calval_table_df : pd.DataFrame
+        DataFrame containing all relevant data for plotting and analysis. Must include columns for vegetation type, model output, flux tower LE, and optionally uncertainty/error columns.
+    model_output_variable_name : str
+        Column name in `calval_table_df` for the model output to be plotted on the y-axis.
+    model_name : str
+        Display name for the model, used as the plot title.
+    insitu_variable_name : str, optional
+        Column name for the flux tower LE values to be plotted on the x-axis (default is 'LEcorr50').
+
+    Returns
+    -------
+    matplotlib.figure.Figure
+        The generated matplotlib Figure object, ready for display in a Jupyter notebook or further customization.
+
+    Notes
+    -----
+    - Points are color-coded by vegetation type using a predefined color map.
+    - Error bars are included if uncertainty columns are present in the DataFrame.
+    - The plot includes a 1:1 reference line, a regression line, and annotations for RMSE, bias, and R².
+    - A legend for vegetation types is included below the plot.
+
+    Example
+    -------
+    >>> fig = quick_look_plot_single_model(df, 'model_output', 'My Model')
+    >>> fig.show()
     """
+    # Define colors for each vegetation type for scatter plot visualization
     colors = {
         'CRO': '#FFEC8B', 'CSH': '#AB82FF', 'CVM': '#8B814C', 
         'DBF': '#98FB98', 'EBF': '#7FFF00', 'ENF': '#006400', 
@@ -32,38 +55,60 @@ def quick_look_plot_single_model(
         'SAV': '#FFD700', 'WAT': '#98F5FF', 'WET': '#4169E1', 
         'WSA': '#CDAA7D'
     }
-    scatter_colors = [colors.get(veg, 'gray') for veg in big_df_ss['vegetation']]
+    # Assign a color to each data point based on its vegetation type
+    scatter_colors = [colors.get(veg, 'gray') for veg in calval_table_df['vegetation']]
+    # Create a reference 1:1 line for the plot (where model output equals flux tower measurement)
     one2one = np.arange(-250, 1200, 5)
-    def calculate_metrics(x, y):
+    # Helper function to calculate performance metrics between model and observed data
+    def calculate_metrics(x: np.ndarray, y: np.ndarray) -> tuple[float, float, float, float, float]:
+        # RMSE: Root Mean Square Error
         rmse = error_funcs.rmse(y, x)
+        # R2: Coefficient of Determination
         r2 = error_funcs.R2_fun(y, x)
+        # Slope and intercept from linear regression
         slope, intercept = error_funcs.lin_regress(y, x)
+        # Bias: Mean difference between model and observed
         bias = error_funcs.BIAS_fun(y,x)
         return rmse, r2, slope, intercept, bias
-    x = big_df_ss[LE_var].to_numpy()
-    y = big_df_ss[model_col].to_numpy()
-    err = big_df_ss['ETinstUncertainty'].to_numpy() if 'ETinstUncertainty' in big_df_ss.columns else None
-    xerr = big_df_ss[['LE_filt', 'LEcorr50', 'LEcorr_ann']].std(axis=1).to_numpy() if all(col in big_df_ss.columns for col in ['LE_filt', 'LEcorr50', 'LEcorr_ann']) else None
+    # Extract flux tower LE values and model output values from DataFrame
+    x = calval_table_df[insitu_variable_name].to_numpy()
+    y = calval_table_df[model_output_variable_name].to_numpy()
+    # Extract uncertainty in model output if available
+    err = calval_table_df['ETinstUncertainty'].to_numpy() if 'ETinstUncertainty' in calval_table_df.columns else None
+    # Calculate standard deviation across three LE columns for x error bars if all columns are present
+    xerr = calval_table_df[['LE_filt', 'LEcorr50', 'LEcorr_ann']].std(axis=1).to_numpy() if all(col in calval_table_df.columns for col in ['LE_filt', 'LEcorr50', 'LEcorr_ann']) else None
+    # Compute performance metrics for the plot annotation
     rmse, r2, slope, intercept, bias = calculate_metrics(x, y)
+    # Count number of valid (non-NaN) data points
     number_of_points = np.sum(~np.isnan(y) & ~np.isnan(x))
+    # Create the matplotlib figure and axis
     fig, ax = plt.subplots(figsize=(6, 6))
+    # Plot error bars if uncertainty data is available
     if err is not None and xerr is not None:
-        ax.errorbar(x, y, yerr=err, xerr=xerr, fmt='none', ecolor='lightgray')
+        ax.errorbar(x, y, yerr=err, xerr=xerr, fmt='', ecolor='lightgray')
+    # Plot the scatter points, colored by vegetation type
     ax.scatter(x, y, c=scatter_colors, marker='o', s=6, zorder=4)
+    # Plot the 1:1 reference line (ideal fit)
     ax.plot(one2one, one2one, '--', c='k')
+    # Plot the regression line (actual fit)
     ax.plot(one2one, one2one * slope + intercept, '--', c='gray')
+    # Set plot title and axis limits
     ax.set_title(model_name)
     ax.set_xlim([-250, 1200])
     ax.set_ylim([-250, 1200])
+    # Set axis labels
     ax.set_ylabel('Model LE Wm$^{-2}$',fontsize=14)
     ax.set_xlabel('Flux Tower LE Wm$^{-2}$',fontsize=14)
+    # Add subplot label
     ax.text(-0.1, 1.1, 'a)', transform=ax.transAxes, fontsize=16, fontweight='bold', va='top', ha='right')
+    # Annotate plot with regression equation, RMSE, bias, and R2
     ax.text(500, -200, f'y = {slope:.1f}x + {intercept:.1f} \nRMSE: {rmse:.1f} Wm$^-$² \nbias: {bias:.1f} Wm$^-$² \nR$^2$: {r2:.2f}', fontsize=12)
+    # Create legend handles for each vegetation type
     scatter_handles = [mlines.Line2D([], [], color=color, marker='o', linestyle='None', markersize=6, label=veg) for veg, color in colors.items()]
+    # Add legend to the figure
     fig.legend(handles=scatter_handles, loc='lower center', bbox_to_anchor=(0.5, -0.05), ncol=7, title='Vegetation Type',fontsize=10)
-    fig.subplots_adjust(bottom=0.2)
+    # Adjust layout for better appearance
     fig.tight_layout()
-    if output_filename is not None:
-        fig.savefig(output_filename, dpi=600, bbox_inches='tight')
-    # Return the figure object for notebook display
+    # Prevent automatic display in Jupyter by closing the figure before returning
+    plt.close(fig)
     return fig

ECOv002_calval_tables/upscale_to_daylight.py

@@ -0,0 +1,18 @@
+import pandas as pd
+from daylight_evapotranspiration import daylight_ET_from_instantaneous_LE
+
+def upscale_to_daylight(df: pd.DataFrame, prefix: str = "insitu_") -> pd.DataFrame:
+    daylight_results = daylight_ET_from_instantaneous_LE(
+        LE_instantaneous_Wm2=df.LEcorr50,
+        Rn_instantaneous_Wm2=df.NETRAD_filt,
+        G_instantaneous_Wm2=df.G_filt,
+        time_UTC=df.time_UTC,
+        geometry=df.geometry
+    )
+    
+    daylight_results_prefixed = {f"{prefix}{k}": v for k, v in daylight_results.items()}
+    
+    for key, value in daylight_results_prefixed.items():
+        df[key] = value
+
+    return df

{ecov002_calval_tables-1.5.0.dist-info → ecov002_calval_tables-1.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ECOv002-calval-tables
-Version: 1.5.0
+Version: 1.7.1
 Summary: Priestley-Taylor Jet Propulsion Laboratory Soil Moisutre Evapotranspiration Model
 Author-email: Gregory Halverson <gregory.h.halverson@jpl.nasa.gov>, Zoe Pierrat <zoe.a.pierrat@jpl.nasa.gov>
 Project-URL: Homepage, https://github.com/gregory-halverson/ECOv002-calval-tables
@@ -9,6 +9,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: daylight-evapotranspiration>=v1.3.4
 Requires-Dist: pandas
 Requires-Dist: geopandas
 Requires-Dist: numpy

ecov002_calval_tables-1.7.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+ECOv002_calval_tables/ECOv002_calval_tables.py,sha256=6yW19Mvgg94O9rZVCRRjiefjG-a6rwRSyFt-RqiXcIo,170
+ECOv002_calval_tables/__init__.py,sha256=oO0pVascuJs247UwpXq2o23wQPThM1bWEwUhSYiNzMY,60
+ECOv002_calval_tables/combined_eco_flux_EC_filtered.csv,sha256=uSRv1CBMJKUWBgtMlRHB1359kiUFUL1ez2c4m7C4DxU,745225
+ECOv002_calval_tables/ec_lib.py,sha256=0k7CldHMFrcq77OqsXdreJQNEVUHVMCAHmUWNo-63fA,24676
+ECOv002_calval_tables/error_funcs.py,sha256=WFsoYvZyJVF-ppBn0BV2JJADPZN48OJBG2QZ6Lt3uCk,11275
+ECOv002_calval_tables/load_tables.py,sha256=mm41qAMhq7OUpzVeEnEbb2zX240RVOFr3rUe2qhmHqU,2775
+ECOv002_calval_tables/metadata_ebc_filt.csv,sha256=74AeCH5DG2Zu8ZFBXUZAW95hlsCjK9K3t6BWRRReR3s,13975
+ECOv002_calval_tables/plot_funcs.py,sha256=asu43YEtWhNehBRKx5ujIiqNn6iePbXW6fC_8Tl8yzI,23988
+ECOv002_calval_tables/plot_single_model.py,sha256=NDCGmY5SfjhTzoH9NKa3uSH_QLvqdWdM-J7QMxKFkpo,5890
+ECOv002_calval_tables/upscale_to_daylight.py,sha256=LrnZ0loI0o30bpT4coET7fmWMzHFVpaylZTfrdv4OqE,622
+ECOv002_calval_tables/version.py,sha256=DOnf2BIAf7HAp9SIUIetrDgRoZDL0o7JuKSiC7_ZT_I,87
+ecov002_calval_tables-1.7.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tests/test_import_ECOv002_calval_tables.py,sha256=aGFA47BrECJroPH92aO5lT53TPNSd6TI1A9uNVT8pRY,74
+tests/test_import_dependencies.py,sha256=zrPUyx8ikAIdpKVESnanD57T_ttXGE2lca9VoVCSBnM,339
+tests/test_load_calval_table.py,sha256=1ioR2yzv8EfWEU2fSqNZv0yaJPgIn03IAOtacF1td3M,499
+tests/test_load_metadata_ebc_filt.py,sha256=PrBxmR85Q_TgWHZx2sBrtvrlsoCm9FMkGFwSU1ySIVc,561
+ecov002_calval_tables-1.7.1.dist-info/METADATA,sha256=F72ebTYBgNLbegVh7QGyXL9UIq2IP1CRbgrUhyibyt8,3363
+ecov002_calval_tables-1.7.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ecov002_calval_tables-1.7.1.dist-info/top_level.txt,sha256=Ps10Nh0VWk-CGqZd2xXwmvGGQ-MEhNaWT0BFGId_M3I,28
+ecov002_calval_tables-1.7.1.dist-info/RECORD,,

{ecov002_calval_tables-1.5.0.dist-info → ecov002_calval_tables-1.7.1.dist-info}/top_level.txt

@@ -1 +1,2 @@
 ECOv002_calval_tables
+tests

tests/test_import_ECOv002_calval_tables.py

@@ -0,0 +1,2 @@
+def test_import_ECOv002_calval_tables():
+    import ECOv002_calval_tables

tests/test_import_dependencies.py

@@ -0,0 +1,17 @@
+import pytest
+
+# List of dependencies
+dependencies = [
+    "pandas",
+    "geopandas",
+    "numpy",
+    "sklearn",
+    "scipy",
+    "matplotlib",
+    "shapely"
+]
+
+# Generate individual test functions for each dependency
+@pytest.mark.parametrize("dependency", dependencies)
+def test_dependency_import(dependency):
+    __import__(dependency)

tests/test_load_calval_table.py

@@ -0,0 +1,14 @@
+import unittest
+import geopandas as gpd
+from ECOv002_calval_tables import load_calval_table
+
+class TestLoadCalvalTable(unittest.TestCase):
+    def test_returns_geodataframe_with_valid_geometry(self):
+        gdf = load_calval_table()
+        self.assertIsInstance(gdf, gpd.GeoDataFrame)
+        self.assertIn('geometry', gdf.columns)
+        self.assertTrue(all(gdf.geometry.geom_type == 'Point'))
+        self.assertTrue(gdf.geometry.is_valid.all())
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_load_metadata_ebc_filt.py

@@ -0,0 +1,15 @@
+import unittest
+import geopandas as gpd
+from ECOv002_calval_tables import load_metadata_ebc_filt
+
+class TestLoadMetadataEbcFilt(unittest.TestCase):
+    def test_returns_geodataframe_with_valid_geometry(self):
+        gdf = load_metadata_ebc_filt()
+        self.assertIsInstance(gdf, gpd.GeoDataFrame)
+        self.assertIn('geometry', gdf.columns)
+        # Check all geometries are valid Points
+        self.assertTrue(all(gdf.geometry.geom_type == 'Point'))
+        self.assertTrue(gdf.geometry.is_valid.all())
+
+if __name__ == "__main__":
+    unittest.main()

ecov002_calval_tables-1.5.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-ECOv002_calval_tables/ECOv002_calval_tables.py,sha256=k8y7TEevSX3Y6NhEU1qg_CySd-f_T4omNNJFc7ZxXcY,135
-ECOv002_calval_tables/__init__.py,sha256=oO0pVascuJs247UwpXq2o23wQPThM1bWEwUhSYiNzMY,60
-ECOv002_calval_tables/combined_eco_flux_EC_filtered.csv,sha256=uSRv1CBMJKUWBgtMlRHB1359kiUFUL1ez2c4m7C4DxU,745225
-ECOv002_calval_tables/ec_lib.py,sha256=0k7CldHMFrcq77OqsXdreJQNEVUHVMCAHmUWNo-63fA,24676
-ECOv002_calval_tables/error_funcs.py,sha256=WFsoYvZyJVF-ppBn0BV2JJADPZN48OJBG2QZ6Lt3uCk,11275
-ECOv002_calval_tables/load_tables.py,sha256=m9UEz07yIrM-m2PaYv2g_TnBLN5Wjg7yUuMzs-T25Gk,2685
-ECOv002_calval_tables/metadata_ebc_filt.csv,sha256=74AeCH5DG2Zu8ZFBXUZAW95hlsCjK9K3t6BWRRReR3s,13975
-ECOv002_calval_tables/plot_funcs.py,sha256=asu43YEtWhNehBRKx5ujIiqNn6iePbXW6fC_8Tl8yzI,23988
-ECOv002_calval_tables/plot_single_model.py,sha256=9OyyqU3IsiuV20yFSULQFaec87xdZhbZevMTIG83xBg,3279
-ECOv002_calval_tables/version.py,sha256=DOnf2BIAf7HAp9SIUIetrDgRoZDL0o7JuKSiC7_ZT_I,87
-ecov002_calval_tables-1.5.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-ecov002_calval_tables-1.5.0.dist-info/METADATA,sha256=3E1QUMG0_d2o-n2Bs_rGo0ZwmF6fvufK7xrQU44h7qI,3312
-ecov002_calval_tables-1.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ecov002_calval_tables-1.5.0.dist-info/top_level.txt,sha256=ePbA84g_XQHWQUAQEVo6gmyuW0WLUzPg2IfHyoGqUqg,22
-ecov002_calval_tables-1.5.0.dist-info/RECORD,,