Merge branch 'native_grids_viz' of github.com:E3SM-Project/e3sm_diags into native_grids_viz

Author: chengzhuzhang

.github/workflows/build_workflow.yml

@@ -29,17 +29,17 @@ jobs:
         uses: actions/checkout@v3
 
       - if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
-        name: Set up Python 3.11
+        name: Set up Python 3.13
         uses: actions/setup-python@v3
         with:
-          python-version: "3.11"
+          python-version: "3.13"
 
       - if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
         # Run all pre-commit hooks on all the files.
         # Getting only staged files can be tricky in case a new PR is opened
         # since the action is run on a branch in detached head state
         name: Install and Run Pre-commit
-        uses: pre-commit/[email protected].0
+        uses: pre-commit/[email protected].1
 
   build:
     name: Build (Python ${{ matrix.python-version }})
@@ -50,7 +50,7 @@ jobs:
         shell: bash -l {0}
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13"]
     container:
       image: ghcr.io/e3sm-project/containers-e3sm-diags-test-data:e3sm-diags-test-data-0.0.2
     steps:

auxiliary_tools/cdat_regression_testing/940-xesmf-diffs/fix-polar-plots/25_08_27_regression_png.ipynb

@@ -1,10 +1,10 @@
 """
-Source: /lcrc/group/e3sm/public_html/diagnostic_output/ac.forsyth2/zppy_weekly_comprehensive_v2_www/test_pr651_both_commits_20250117/v2.LR.historical_0201/e3sm_diags/atm_monthly_180x360_aave/model_vs_obs_1982-1983/prov/e3sm.py
+Source: /lcrc/group/e3sm/public_html/diagnostic_output/ac.forsyth2/zppy_weekly_comprehensive_v2_www/test_weekly_20250825/v2.LR.historical_0201/e3sm_diags/atm_monthly_180x360_aave/model_vs_obs_1982-1983/prov/e3sm.py
 
-Webpage: https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/ac.forsyth2/zppy_weekly_comprehensive_v2_www/test_pr651_both_commits_20250117/v2.LR.historical_0201/e3sm_diags/atm_monthly_180x360_aave/model_vs_obs_1982-1983/prov/e3sm.py
+Webpage: https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/ac.forsyth2/zppy_weekly_comprehensive_v2_www/test_weekly_20250825/v2.LR.historical_0201/e3sm_diags/atm_monthly_180x360_aave/model_vs_obs_1982-1983/prov/e3sm.py
 
 Diffs: https://github.com/E3SM-Project/zppy/pull/651#issuecomment-2628445196
- /lcrc/group/e3sm/public_html/diagnostic_output/ac.forsyth2/zppy_weekly_comprehensive_v2_www/test_pr651_both_commits_20250117/v2.LR.historical_0201/image_check_failures_comprehensive_v2/e3sm_diags/atm_monthly_180x360_aave/model_vs_obs_1982-1983
+ /lcrc/group/e3sm/public_html/diagnostic_output/ac.forsyth2/zppy_weekly_comprehensive_v2_www/test_weekly_20250825/v2.LR.historical_0201/image_check_failures_comprehensive_v2/e3sm_diags/atm_monthly_180x360_aave/model_vs_obs_1982-1983
 
 ERA5-TREFHT-ANN-land.png
 ERA5_ext-QREFHT-ANN-global.png
@@ -44,7 +44,7 @@
 from e3sm_diags.run import runner
 
 short_name = 'v2.LR.historical_0201'
-test_ts = '/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_pr651_both_commits_20250117/v2.LR.historical_0201/post/atm/180x360_aave/ts/monthly/2yr'
+test_ts = '/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_weekly_20250825/v2.LR.historical_0201/post/atm/180x360_aave/ts/monthly/2yr'
 start_yr = int('1982')
 end_yr = int('1983')
 num_years = end_yr - start_yr + 1
@@ -54,7 +54,7 @@
 
 # Model
 # param.test_data_path = 'climo'
-param.test_data_path = "/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_pr651_both_commits_20250117/v2.LR.historical_0201/post/atm/180x360_aave/clim/2yr"
+param.test_data_path = "/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_weekly_20250825/v2.LR.historical_0201/post/atm/180x360_aave/clim/2yr"
 param.test_name = 'v2.LR.historical_0201'
 param.short_test_name = short_name
 
@@ -66,7 +66,7 @@
 
 # Output dir
 # param.results_dir = 'model_vs_obs_1982-1983'
-param.results_dir = "/lcrc/group/e3sm/public_html/cdat-migration-fy24/25-02-18-branch-939-polar"
+param.results_dir = "/lcrc/group/e3sm/public_html/cdat-migration-fy24/25-08-27-branch-945-xesmf-bnds"
 
 # Additional settings
 param.run_type = 'model_vs_obs'
@@ -92,7 +92,7 @@
 
 params.append(enso_param)
 trop_param = TropicalSubseasonalParameter()
-trop_param.test_data_path = '/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_pr651_both_commits_20250117/v2.LR.historical_0201/post/atm/180x360_aave/ts/daily/2yr'
+trop_param.test_data_path = '/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_weekly_20250825/v2.LR.historical_0201/post/atm/180x360_aave/ts/daily/2yr'
 trop_param.test_name = short_name
 trop_param.test_start_yr = f'{start_yr:04}'
 trop_param.test_end_yr = f'{end_yr:04}'
@@ -130,7 +130,7 @@
 
 params.append(dc_param)
 streamflow_param = StreamflowParameter()
-streamflow_param.test_data_path = '/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_pr651_both_commits_20250117/v2.LR.historical_0201/post/rof/native/ts/monthly/2yr'
+streamflow_param.test_data_path = '/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_weekly_20250825/v2.LR.historical_0201/post/rof/native/ts/monthly/2yr'
 streamflow_param.test_name = short_name
 streamflow_param.test_start_yr = start_yr
 streamflow_param.test_end_yr = end_yr
@@ -142,7 +142,7 @@
 
 params.append(streamflow_param)
 tc_param = TCAnalysisParameter()
-tc_param.test_data_path = "/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_pr651_both_commits_20250117/v2.LR.historical_0201/post/atm/tc-analysis_1982_1983"
+tc_param.test_data_path = "/lcrc/group/e3sm/ac.forsyth2/zppy_weekly_comprehensive_v2_output/test_weekly_20250825/v2.LR.historical_0201/post/atm/tc-analysis_1982_1983"
 tc_param.short_test_name = short_name
 tc_param.test_start_yr = "1982"
 tc_param.test_end_yr = "1983"

auxiliary_tools/cdat_regression_testing/940-xesmf-diffs/fix-polar-plots/v2_run_script.py

@@ -0,0 +1,47 @@
+#%%
+"""
+This script compares the latitude bounds generated by two different Python libraries, xCDAT and CDAT,
+when working with a NetCDF dataset. The purpose is to ensure consistency between the bounds added
+by xCDAT's `add_bounds` method and CDAT's `getBounds` method. The script performs the following steps:
+
+1. Opens a NetCDF dataset containing climatological data using xCDAT and CDAT.
+2. Adds latitude bounds to the dataset using xCDAT.
+3. Retrieves latitude bounds from the dataset using CDAT.
+4. Compares the latitude bounds from both libraries using NumPy to verify their equality.
+
+This comparison is useful for debugging and validating the behavior of the xCDAT library in handling
+latitude bounds, ensuring compatibility with CDAT's established functionality.
+
+# conda create -n xcdat_cdat_latest python xcdat=0.8.0 cdms2=3.1.5 ipykernel
+"""
+import xcdat as xc
+import cdms2
+import numpy as np
+
+filepath = (
+    "/global/cfs/cdirs/e3sm/diagnostics/observations/Atm/climatology/"
+    "GPCP_v3.2/GPCP_v3.2_ANN_198301_202112_climo.nc"
+)
+
+#%%
+# Open the dataset using xCDAT and add bounds.
+ds_xc = xc.open_dataset(filepath, add_bounds=None)
+ds_xc_bnds = ds_xc.bounds.add_bounds(axis="Y")
+lat_bnds_xc = ds_xc_bnds["lat_bnds"]
+
+# Open the dataset using CDAT and add bounds.
+ds_cd = cdms2.open(filepath)
+var = ds_cd["gauge_precip"]
+lat_bnds_cd = var.getLatitude().getBounds()
+
+# %%
+# Compare the latitude bounds using numpy
+are_bounds_equal = np.allclose(lat_bnds_xc, lat_bnds_cd)
+
+print("Are the latitude bounds equal?", are_bounds_equal)
+np.testing.assert_equal(lat_bnds_xc, lat_bnds_cd)  # True
+
+#%%
+print(lat_bnds_xc)
+print(lat_bnds_cd)
+# %%

auxiliary_tools/cdat_regression_testing/940-xesmf-diffs/fix-polar-plots/debug_diffs.py renamed to auxiliary_tools/cdat_regression_testing/940-xesmf-diffs/fix-polar-plots/xesmf-isolation-tests/debug_diffs.py

@@ -0,0 +1,34 @@
+#%%
+import numpy as np
+import xarray as xr
+import xcdat as xc
+
+ds_b = xr.open_dataset("/lcrc/group/e3sm/diagnostics/observations/Atm/climatology/GPCP_v3.2/GPCP_v3.2_ANN_198301_202112_climo.nc")
+
+# Check for existing lat bounds -- False
+print("lat_bnds" in ds_b)  # False
+
+# Add lat bounds and check the orientation
+ds_b = ds_b.bounds.add_bounds(axis="Y")
+
+#%%
+# Print the first 5 latitude coordinates of ds_b
+latitudes = ds_b["lat"].values
+print("\nLatitude Coordinates (First 5):")
+print(latitudes[:5])
+
+# Check if latitude coordinates are ascending or descending
+lat_order = "ascending" if np.all(latitudes[:-1] <= latitudes[1:]) else "descending"
+print(f"Latitude coordinates are {lat_order}.")
+
+# Print the first 5 latitude bounds of ds_b
+lat_bnds = ds_b["lat_bnds"].values
+print("\nLatitude Bounds (First 5):")
+for i, bounds in enumerate(lat_bnds[:5]):
+    print(f"Bounds {i + 1}: {bounds}")
+
+# Check if latitude bounds are ascending or descending
+bnds_order = "ascending" if np.all(lat_bnds[:, 0] <= lat_bnds[:, 1]) else "descending"
+print(f"Latitude bounds are {bnds_order}.")
+
+# %%

auxiliary_tools/cdat_regression_testing/940-xesmf-diffs/fix-polar-plots/debug_diffs_min.py renamed to auxiliary_tools/cdat_regression_testing/940-xesmf-diffs/fix-polar-plots/xesmf-isolation-tests/debug_diffs_min.py

@@ -0,0 +1,82 @@
+"""
+This script demonstrates the behavior of the `cdms2` library in handling axis bounds,
+specifically for latitude axes. It includes tests to verify the automatic generation
+and preservation of bounds under different scenarios. The findings are summarized below:
+
+1. **Automatic Bounds Generation**:
+    - When a latitude axis is created without explicitly setting bounds,
+      `cdms2` automatically generates bounds for the axis.
+
+2. **Preservation of Existing Bounds**:
+    - If bounds are explicitly set for a latitude axis, `cdms2` preserves
+      these bounds without overwriting them.
+
+3. **Bounds Preservation in NetCDF Files**:
+    - When a latitude axis with explicitly set bounds is written to a NetCDF file
+      and subsequently read back, the bounds are preserved as expected.
+
+The script includes three tests:
+- **Test 1**: Verifies that bounds are auto-generated for a latitude axis.
+- **Test 2**: Confirms that explicitly set bounds for a latitude axis are preserved.
+- **Test 3**: Ensures that bounds for a latitude axis are preserved when written
+  to and read from a NetCDF file.
+
+cdms2.setAutoBounds(mode) controls automatic generation of bounds for axes:
+0 or 'off'   = No bounds are generated automatically.
+1 or 'on'    = Bounds are auto-generated for all 1D axes (if missing).
+2 or 'grid'  = Bounds are auto-generated only for lat/lon axes (default).
+Use cdms2.getAutoBounds() to check the current setting.
+"""
+
+# %%x
+import cdms2
+import numpy as np
+
+# Check the current setting for auto bounds generation
+print(cdms2.getAutoBounds())
+# Expected output: 2 (default setting for lat/lon axes)
+
+# %%
+# Test 1: Check if lat bounds are auto-generated with no bounds existing (True)
+# -----------------------------------------------------------------------------
+axis = cdms2.createAxis([0, 1, 2])
+axis.id = "lat"  # Identify the axis as latitude
+
+print(axis.getBounds())  # These are the auto-generated ones, not manually set.
+# [[0.  0.5]
+#  [0.5 1.5]
+#  [1.5 2.5]]
+
+# %%
+# Test 2: Check if existing lat bounds are preserved (True)
+# -----------------------------------------------------------------------------
+axis = cdms2.createAxis([0, 1, 2])
+axis.id = "lat"  # Identify the axis as latitude
+axis.setBounds(np.array([[0, 0.2], [0.5, 1.5], [1.5, 2.5]]))
+
+print(axis.getBounds())  # These are the manually set ones.
+# [[0.  0.2]
+#  [0.5 1.5]
+#  [1.5 2.5]]
+
+# %%
+# Test 3: Create a dummy netCDF file with lat axis, read it, and check bounds are preserved (True)
+# -----------------------------------------------------------------------------
+# Create a dummy netCDF file
+with cdms2.open("dummy.nc", "w") as f:
+    lat = cdms2.createAxis([0, 1, 2])
+    lat.id = "lat"
+    lat.setBounds(np.array([[0, 0.2], [0.5, 1.5], [1.5, 2.5]]))
+
+    var = cdms2.createVariable([0, 1, 2], id="var", axes=[lat])
+    f.write(var)
+
+obj = cdms2.open("dummy.nc")["var"]
+
+# %%
+print(obj.getLatitude().getBounds())  # These are the manually set ones.
+# [[0.  0.2]
+#  [0.5 1.5]
+#  [1.5 2.5]]
+
+# %%