Merge pull request #974 from PCMDI/acordonez-patch-1

Update target grid help in parser
PCMDI · Nov 30, 2023 · 5aa8015 · 5aa8015
2 parents a90ed96 + 96d650f
commit 5aa8015
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/metrics_mean-clim.rst b/docs/metrics_mean-clim.rst
@@ -80,7 +80,7 @@ where the list of variables (vars) to run the analysis on includes 'rlut' (outgo
 * **test_data_path**: the path/template where the test_data resides, e.g.: 
 * **reference_data_set**: a python list that specifies 'default', 'alternate1', 'alternate2' or 'all', e.g., ['default']
 * **reference_data_path**: the root path to the observational climatology database, e.g., '~/demo_data/PCMDIobs2_clims/'
-* **target_grid**: '2.5x2.5' or an actual cdms2 grid object
+* **target_grid**: a string giving the desired horizontal resolution in degrees following the form 'LATxLON', e.g. '2.5x2.5'
 * **regrid_tool**: options include 'esmf' and 'regrid2' 
 * **metric_output_path**: the full path to the metrics output in JSON files, e.g., '~/demo_data/PMP_metrics/' 
 

diff --git a/pcmdi_metrics/mean_climate/lib/create_mean_climate_parser.py b/pcmdi_metrics/mean_climate/lib/create_mean_climate_parser.py
@@ -96,7 +96,7 @@ def create_mean_climate_parser():
  parser.add_argument(
  "--target_grid",
  dest="target_grid",
- help='Options are "2.5x2.5" or an actual cdms2 grid object',
+ help='Set to "LATxLON" resolution in degrees. Default is "2.5x2.5"',
  required=False,
  default="2.5x2.5",
  )