Merge pull request NCAR#302 from wwieder/climo_ldf

enable different time ranges for ts and climo files in LDF

Author: TeaganKing

examples/external_diag_packages/config.yml

@@ -43,11 +43,17 @@ computation_config:
 global_params:
   case_name: 'b.e23_alpha17f.BLT1850.ne30_t232.092'
   base_case_name: 'b.e30_beta02.BLT1850.ne30_t232.104'
+  case_nickname: 'BLT1850_92'
+  base_case_nickname: 'BLT1850_104'
   CESM_output_dir: /glade/campaign/cesm/development/cross-wg/diagnostic_framework/CESM_output_for_testing
   start_date: '0001-01-01'
   end_date: '0021-01-01'
+  climo_start_date: '0001-01-01'
+  climo_end_date: '0021-01-01'
   base_start_date: '0001-01-01'
   base_end_date: '0045-01-01'
+  base_climo_start_date: '0001-01-01'
+  base_climo_end_date: '0021-01-01'
   obs_data_dir: '/glade/campaign/cesm/development/cross-wg/diagnostic_framework/CUPiD_obs_data'
   ts_dir: null # If this is set to null, it will default to CESM_output_dir; if you don't have permissions to write to CESM_output_dir, you can specify a directory such as your scratch arcive directory
   lc_kwargs:

examples/key_metrics/config.yml

@@ -43,11 +43,17 @@ computation_config:
 global_params:
   case_name: 'b.e30_alpha07c_cesm.B1850C_LTso.ne30_t232_wgx3.232'
   base_case_name: 'b.e30_alpha07c_cesm.B1850C_LTso.ne30_t232_wgx3.228'
+  case_nickname: 'BLT1850_232'
+  base_case_nickname: 'BLT1850_228'
   CESM_output_dir: /glade/campaign/cesm/development/cross-wg/diagnostic_framework/CESM_output_for_testing
   start_date: '0001-01-01'
   end_date: '0021-01-01'
+  climo_start_year: 11
+  climo_end_year: 21
   base_start_date: '0001-01-01'
   base_end_date: '0045-01-01'
+  base_climo_start_year: 36
+  base_climo_end_year: 45
   obs_data_dir: '/glade/campaign/cesm/development/cross-wg/diagnostic_framework/CUPiD_obs_data'
   ts_dir: null # If this is set to null, it will default to CESM_output_dir; if you don't have permissions to write to CESM_output_dir, you can specify a directory such as your scratch arcive directory
   lc_kwargs:
@@ -237,6 +243,7 @@ compute_notebooks:
                         'Amazonia','Central Africa','Indonesia',
                         'Brazil','Sahel','Southern Africa','India']
           defaults_file: ../../externals/LDF/lib/ldf_variable_defaults.yaml
+          regions_file: ../../externals/LDF/lib/regions_lnd.yaml
 #    ocn:
 #      ocean_surface:
 #        parameter_groups:

externals/LDF

@@ -54,8 +54,14 @@ def generate_adf_config(
     # Set case names for ADF config
     a_dict["diag_cam_climo"]["cam_case_name"] = test_case_name
     a_dict["diag_cam_baseline_climo"]["cam_case_name"] = base_case_name
-    a_dict["diag_cam_climo"]["case_nickname"] = test_case_name
-    a_dict["diag_cam_baseline_climo"]["case_nickname"] = base_case_name
+    a_dict["diag_cam_climo"]["case_nickname"] = c_dict["global_params"].get(
+        "case_nickname",
+        test_case_name,
+    )
+    a_dict["diag_cam_baseline_climo"]["case_nickname"] = c_dict["global_params"].get(
+        "base_case_nickname",
+        base_case_name,
+    )
 
     # TEST CASE HISTORY FILE PATH
     a_dict["diag_cam_climo"]["cam_hist_loc"] = os.path.join(

helper_scripts/generate_adf_config_file.py

@@ -46,8 +46,19 @@ def generate_ldf_config(cupid_config_loc, ldf_template, out_file):
     # Set case names for LDF config
     a_dict["diag_cam_climo"]["cam_case_name"] = test_case_name
     a_dict["diag_cam_baseline_climo"]["cam_case_name"] = base_case_name
-    a_dict["diag_cam_climo"]["case_nickname"] = test_case_name
-    a_dict["diag_cam_baseline_climo"]["case_nickname"] = base_case_name
+    a_dict["diag_cam_climo"]["case_nickname"] = c_dict["global_params"].get(
+        "case_nickname",
+        test_case_name,
+    )
+    a_dict["diag_cam_baseline_climo"]["case_nickname"] = c_dict["global_params"].get(
+        "base_case_nickname",
+        base_case_name,
+    )
+    # Set hist strings for test & baseline climo
+    a_dict["diag_cam_climo"]["hist_str"] = c_dict["timeseries"]["lnd"]["hist_str"]
+    a_dict["diag_cam_baseline_climo"]["hist_str"] = c_dict["timeseries"]["lnd"][
+        "hist_str"
+    ]
 
     # TEST CASE HISTORY FILE PATH
     a_dict["diag_cam_climo"]["cam_hist_loc"] = os.path.join(
@@ -99,7 +110,15 @@ def generate_ldf_config(cupid_config_loc, ldf_template, out_file):
     )
     start_date = get_date_from_ts(c_ts["lnd"], "start_years", test_case_cupid_ts_index)
     end_date = get_date_from_ts(c_ts["lnd"], "end_years", test_case_cupid_ts_index)
+    a_dict["diag_cam_climo"]["climo_start_year"] = c_dict["global_params"].get(
+        "climo_start_year",
+        start_date,
+    )
     a_dict["diag_cam_climo"]["start_year"] = start_date
+    a_dict["diag_cam_climo"]["climo_end_year"] = c_dict["global_params"].get(
+        "climo_end_year",
+        end_date,
+    )
     a_dict["diag_cam_climo"]["end_year"] = end_date
 
     # Set values for BASELINE
@@ -165,11 +184,24 @@ def generate_ldf_config(cupid_config_loc, ldf_template, out_file):
             )
     except:  # noqa: E722
         pass
+
+    a_dict["diag_cam_baseline_climo"]["climo_start_year"] = c_dict["global_params"].get(
+        "base_climo_start_year",
+        base_start_date,
+    )
     a_dict["diag_cam_baseline_climo"]["start_year"] = base_start_date
+    a_dict["diag_cam_baseline_climo"]["climo_end_year"] = c_dict["global_params"].get(
+        "base_climo_end_year",
+        base_end_date,
+    )
     a_dict["diag_cam_baseline_climo"]["end_year"] = base_end_date
+
     a_dict["diag_basic_info"]["defaults_file"] = c_dict["compute_notebooks"]["lnd"][
         "LDF"
     ]["external_tool"]["defaults_file"]
+    a_dict["diag_basic_info"]["regions_file"] = c_dict["compute_notebooks"]["lnd"][
+        "LDF"
+    ]["external_tool"]["regions_file"]
     a_dict["diag_basic_info"]["hist_str"] = c_dict["timeseries"]["lnd"]["hist_str"]
     a_dict["diag_basic_info"]["num_procs"] = c_dict["timeseries"].get("num_procs", 1)
     a_dict["diag_basic_info"]["cam_regrid_loc"] = os.path.join(