Add arm_diags and merra2 debug scripts

- Constraint `dask <2024.12.0`

Author: tomvothecoder

auxiliary_tools/cdat_regression_testing/906-v3_complete_run/debug-missing-arm-files/complete_run_script.py

@@ -0,0 +1,206 @@
+"""
+This script sets up and runs a series of diagnostics for the E3SM model output.
+
+The diagnostics include:
+- ENSO diagnostics
+- Tropical subseasonal variability diagnostics
+- QBO diagnostics
+- Diurnal cycle diagnostics
+- Streamflow diagnostics
+- Tropical cyclone analysis
+- ARM diagnostics
+
+The script configures the parameters for each diagnostic, including paths to
+model output and observational data, time periods for analysis, and output
+settings. It then runs the diagnostics using the e3sm_diags package.
+
+Parameters:
+- case: The name of the model case.
+- short_name: A short name for the model case.
+- results_dir: Directory where the results will be saved.
+- test_climo: Path to the model climatology data.
+- test_ts: Path to the model time-series data.
+- test_ts_daily_dir: Path to the model daily time-series data.
+- ref_climo: Path to the reference climatology data.
+- ref_ts: Path to the reference time-series data.
+- start_yr: Start year for the analysis.
+- end_yr: End year for the analysis.
+
+The script uses multiprocessing to speed up the diagnostics computation.
+
+Example usage:
+    python complete_run_script.py
+"""
+import sys
+
+from e3sm_diags.parameter.arm_diags_parameter import ARMDiagsParameter
+from e3sm_diags.parameter.core_parameter import CoreParameter
+from e3sm_diags.parameter.diurnal_cycle_parameter import DiurnalCycleParameter
+from e3sm_diags.parameter.enso_diags_parameter import EnsoDiagsParameter
+from e3sm_diags.parameter.qbo_parameter import QboParameter
+from e3sm_diags.parameter.streamflow_parameter import StreamflowParameter
+from e3sm_diags.parameter.tc_analysis_parameter import TCAnalysisParameter
+from e3sm_diags.parameter.tropical_subseasonal_parameter import (
+    TropicalSubseasonalParameter,
+)
+from e3sm_diags.run import runner
+
+case = "extendedOutput.v3.LR.historical_0101"
+short_name = "v3.LR.historical_0101"
+
+# TODO: Update MAIN_DIR to match the current directory name.
+MAIN_DIR = "25-01-06-branch-907-debug-arm_diags"
+results_dir = f"/global/cfs/cdirs/e3sm/www/e3sm_diags/complete_run/{MAIN_DIR}/"
+
+test_climo = "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/atm/180x360_aave/clim/15yr"
+test_ts = "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/atm/180x360_aave/ts/monthly/15yr"
+test_ts_daily_dir = "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/atm/180x360_aave/ts/daily/15yr"
+
+ref_climo = "/global/cfs/cdirs/e3sm/diagnostics/observations/Atm/climatology/"
+ref_ts = "/global/cfs/cdirs/e3sm/diagnostics/observations/Atm/time-series"
+
+start_yr = "2000"
+end_yr = "2014"
+
+param = CoreParameter()
+
+# Model
+param.test_data_path = test_climo
+param.test_name = case
+param.short_test_name = short_name
+
+# Ref/Obs
+param.reference_data_path = ref_climo
+
+# Output dir
+param.results_dir = results_dir
+
+# Additional settings
+param.run_type = "model_vs_obs"
+param.diff_title = "Model - Observations"
+param.output_format = ["png"]
+param.output_format_subplot = []
+param.multiprocessing = True
+param.num_workers = 24
+param.save_netcdf = True
+param.seasons = ["ANN"]
+params = [param]
+
+# Model
+enso_param = EnsoDiagsParameter()
+enso_param.test_data_path = test_ts
+# enso_param.test_name = short_name
+enso_param.test_start_yr = start_yr
+enso_param.test_end_yr = end_yr
+
+# Obs
+enso_param.reference_data_path = ref_ts
+enso_param.ref_start_yr = start_yr
+enso_param.ref_end_yr = end_yr
+
+enso_param.save_netcdf = True
+params.append(enso_param)
+
+trop_param = TropicalSubseasonalParameter()
+trop_param.test_data_path = test_ts_daily_dir
+# trop_param.test_name = short_name
+trop_param.test_start_yr = start_yr
+trop_param.test_end_yr = end_yr
+
+# Obs
+trop_param.reference_data_path = ref_ts
+trop_param.ref_start_yr = "2001"
+trop_param.ref_end_yr = "2010"
+
+trop_param.save_netcdf = True
+params.append(trop_param)
+
+qbo_param = QboParameter()
+qbo_param.test_data_path = test_ts
+# qbo_param.test_name = short_name
+qbo_param.test_start_yr = start_yr
+qbo_param.test_end_yr = end_yr
+qbo_param.ref_start_yr = start_yr
+qbo_param.ref_end_yr = end_yr
+
+# Obs
+qbo_param.reference_data_path = ref_ts
+
+qbo_param.save_netcdf = True
+params.append(qbo_param)
+
+dc_param = DiurnalCycleParameter()
+dc_param.test_data_path = "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/atm/180x360_aave/clim_diurnal_8xdaily/"
+# dc_param.short_test_name = short_name
+# Plotting diurnal cycle amplitude on different scales. Default is True
+dc_param.normalize_test_amp = False
+
+# Obs
+dc_param.reference_data_path = ref_climo
+
+dc_param.save_netcdf = True
+params.append(dc_param)
+
+streamflow_param = StreamflowParameter()
+streamflow_param.reference_data_path = ref_ts
+streamflow_param.test_data_path = "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/rof/native/ts/monthly/15yr/"
+# streamflow_param.test_name = short_name
+streamflow_param.test_start_yr = start_yr
+streamflow_param.test_end_yr = end_yr
+
+# Obs
+streamflow_param.reference_data_path = ref_ts
+streamflow_param.ref_start_yr = (
+    "1986"  # Streamflow gauge station data range from year 1986 to 1995
+)
+streamflow_param.ref_end_yr = "1995"
+
+streamflow_param.save_netcdf = True
+params.append(streamflow_param)
+
+tc_param = TCAnalysisParameter()
+tc_param.test_data_path = "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/atm/tc-analysis_2000_2014"
+# tc_param.short_test_name = short_name
+tc_param.test_start_yr = start_yr
+tc_param.test_end_yr = end_yr
+
+# Obs
+tc_param.reference_data_path = (
+    "/global/cfs/cdirs/e3sm/diagnostics/observations/Atm/tc-analysis/"
+)
+# For model vs obs, the ref start and end year can be any four digit strings
+# For now, use all available years from obs by default
+tc_param.ref_start_yr = "1979"
+tc_param.ref_end_yr = "2018"
+
+tc_param.save_netcdf = True
+params.append(tc_param)
+
+arm_param = ARMDiagsParameter()
+arm_param.reference_data_path = (
+    "/global/cfs/cdirs/e3sm/diagnostics/observations/Atm/arm-diags-data"
+)
+arm_param.ref_name = "armdiags"
+arm_param.test_data_path = (
+    "/global/cfs/cdirs/e3sm/chengzhu/tutorial2024/v3.LR.historical_0101/post/atm/site"
+)
+arm_param.test_name = short_name
+arm_param.test_start_yr = start_yr
+arm_param.test_end_yr = end_yr
+# For model vs obs, the ref start and end year can be any four digit strings.
+# For now, will use all available years form obs
+arm_param.ref_start_yr = "0001"
+arm_param.ref_end_yr = "0001"
+
+arm_param.save_netcdf = True
+params.append(arm_param)
+
+# Run
+runner.sets_to_run = [
+    "arm_diags",
+]
+
+cfg_path = "auxiliary_tools/cdat_regression_testing/906-v3_complete_run/debug-missing-arm-files/debug-missing.cfg"
+sys.arv.extend(["--diags", cfg_path])
+
+runner.run_diags(params)

auxiliary_tools/cdat_regression_testing/906-v3_complete_run/debug-missing-arm-files/debug-missing.cfg

@@ -0,0 +1,9 @@
+[#]
+sets = ["lat_lon"]
+case_id = "MERRA2"
+variables = ["LHFLX"]
+ref_name = "MERRA2"
+reference_name = "MERRA2 Reanalysis"
+seasons = ["ANN", "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "DJF", "MAM", "JJA", "SON"]
+contour_levels = [0,5, 15, 30, 60, 90, 120, 150, 180, 210, 240, 270, 300]
+diff_levels = [-150, -120, -90, -60, -30, -20, -10, -5, 5, 10, 20, 30, 60, 90, 120, 150]

auxiliary_tools/cdat_regression_testing/906-v3_complete_run/debug-missing-arm-files/get_diff_arm_diags.py

@@ -0,0 +1,47 @@
+import os
+import filecmp
+
+def get_png_files(directory):
+    """Get a list of .png files in the given directory."""
+    png_files = []
+    for root, _, files in os.walk(directory):
+        for file in files:
+            if file.endswith(".png"):
+                png_files.append(os.path.join(root, file))
+    return png_files
+
+def compare_directories(dir1, dir2):
+    """Compare .png files between two directories."""
+    png_files_dir1 = get_png_files(dir1)
+    png_files_dir2 = get_png_files(dir2)
+
+    # Create a dictionary with relative paths as keys
+    png_files_dict1 = {os.path.relpath(file, dir1): file for file in png_files_dir1}
+    png_files_dict2 = {os.path.relpath(file, dir2): file for file in png_files_dir2}
+
+    # Find common files
+    common_files = set(png_files_dict1.keys()).intersection(set(png_files_dict2.keys()))
+
+    # Compare common files
+    for file in common_files:
+        if not filecmp.cmp(png_files_dict1[file], png_files_dict2[file], shallow=False):
+            print(f"Difference found in file: {file}")
+
+    # Find files only in dir1
+    only_in_dir1 = sorted(set(png_files_dict1.keys()) - set(png_files_dict2.keys()))
+    if only_in_dir1:
+        print(f"Files only in {dir1}:")
+        for file in only_in_dir1:
+            print(file)
+
+    # Find files only in dir2
+    only_in_dir2 = sorted(set(png_files_dict2.keys()) - set(png_files_dict1.keys()))
+    if only_in_dir2:
+        print(f"Files only in {dir2}:")
+        for file in only_in_dir2:
+            print(file)
+
+if __name__ == "__main__":
+    dir1 = "/global/cfs/cdirs/e3sm/www/e3sm_diags/complete_run/25-01-06-branch-907-arm-diags-only/arm_diags"
+    dir2 = "/global/cfs/cdirs/e3sm/www/e3sm_diags/complete_run/v2.12.1v2/arm_diags"
+    compare_directories(dir1, dir2)