From 649aa8b60098df2ff7ede919ff212ba70bc9ff71 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 12 Oct 2022 17:41:22 +0000 Subject: [PATCH 1/5] Update hera script comments for new data sources. Fixes #702. --- driver_scripts/driver_grid.hera.sh | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/driver_scripts/driver_grid.hera.sh b/driver_scripts/driver_grid.hera.sh index 82c9ad1c9..ef157d3a4 100755 --- a/driver_scripts/driver_grid.hera.sh +++ b/driver_scripts/driver_grid.hera.sh @@ -84,7 +84,9 @@ export veg_type_src="modis.igbp.0.05" # veg type data. # For the modis-based data, set to: # 1) "modis.igbp.0.05" for global 5km data # 2) "modis.igbp.0.03" for global 3km data - # 3) "modis.igbp.conus.0.01" for regional 1km data + # 3) "modis.igbp.conus.30s" for CONUS 30s data + # 4) "modis.igbp.nh.30s" for N Hemis 30s data + # 5) "modis.igbp.30s" for global 30s data if [ $gtype = uniform ]; then export res=96 From 9e738feb36bcb7df7f8bdfbfebc53e72f68c655b Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 13 Oct 2022 12:40:04 +0000 Subject: [PATCH 2/5] Update ./ush/sfc_climo_gen.sh to allow user to choose which soil type data to use. Update all driver script comments. Fixes #702. --- driver_scripts/driver_grid.hera.sh | 26 +++++++++++++++--------- driver_scripts/driver_grid.jet.sh | 30 ++++++++++++++++++---------- driver_scripts/driver_grid.orion.sh | 30 ++++++++++++++++++---------- driver_scripts/driver_grid.wcoss2.sh | 30 ++++++++++++++++++---------- ush/sfc_climo_gen.sh | 6 +++++- 5 files changed, 82 insertions(+), 40 deletions(-) diff --git a/driver_scripts/driver_grid.hera.sh b/driver_scripts/driver_grid.hera.sh index ef157d3a4..6dfa13042 100755 --- a/driver_scripts/driver_grid.hera.sh +++ b/driver_scripts/driver_grid.hera.sh @@ -52,10 +52,11 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) Check settings for 'make_gsl_orog' and 'veg_type_src' -# below. -# 10) Submit script: "sbatch $script". -# 11) All files will be placed in "out_dir". +# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 10) Set 'soil_veg_src' and 'veg_type_src' to choose the +# soil type and vegetation type data. +# 11) Submit script: "sbatch $script". +# 12) All files will be placed in "out_dir". # #----------------------------------------------------------------------- @@ -77,17 +78,24 @@ export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL # orographic drag suite export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: - # 1) "viirs.igbp.0.05" for global 5km data - # 2) "viirs.igbp.0.1" for global 10km data - # 3) "viirs.igbp.0.03" for global 3km data + # 1) "viirs.igbp.0.05" for global 0.05-deg data + # 2) "viirs.igbp.0.1" for global 0.1-deg data + # 3) "viirs.igbp.0.03" for global 0.03-deg data # 4) "viirs.igbp.conus.0.01" for regional 1km data # For the modis-based data, set to: - # 1) "modis.igbp.0.05" for global 5km data - # 2) "modis.igbp.0.03" for global 3km data + # 1) "modis.igbp.0.05" for global 0.05-deg data + # 2) "modis.igbp.0.03" for global 0.03-deg data # 3) "modis.igbp.conus.30s" for CONUS 30s data # 4) "modis.igbp.nh.30s" for N Hemis 30s data # 5) "modis.igbp.30s" for global 30s data +export soil_type_src="statsgo.0.05" # Soil type data. Choices are: + # 1) "statsgo.0.03" for global 0.03-deg data + # 2) "statsgo.0.05" for global 0.05-deg data + # 3) "statsgo.conus.30s" for CONUS 30s data + # 4) "statsgo.nh.30s" for NH 30s data + # 5) "statsgo.30s" for global 30s data + if [ $gtype = uniform ]; then export res=96 export add_lake=false # Add lake frac and depth to orography data. diff --git a/driver_scripts/driver_grid.jet.sh b/driver_scripts/driver_grid.jet.sh index df8f87b13..639de66c2 100755 --- a/driver_scripts/driver_grid.jet.sh +++ b/driver_scripts/driver_grid.jet.sh @@ -53,10 +53,11 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) Check settings for 'make_gsl_orog' and 'veg_type_src' -# below. -# 10) Submit script: "sbatch $script". -# 11) All files will be placed in "out_dir". +# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 10) Set 'soil_veg_src' and 'veg_type_src' to choose the +# soil type and vegetation type data. +# 11) Submit script: "sbatch $script". +# 12) All files will be placed in "out_dir". # #----------------------------------------------------------------------- @@ -77,14 +78,23 @@ export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL # orographic drag suite export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: - # 1) "viirs.igbp.0.05" for global 5km data - # 2) "viirs.igbp.0.1" for global 10km data - # 3) "viirs.igbp.0.03" for global 3km data + # 1) "viirs.igbp.0.05" for global 0.05-deg data + # 2) "viirs.igbp.0.1" for global 0.1-deg data + # 3) "viirs.igbp.0.03" for global 0.03-deg data # 4) "viirs.igbp.conus.0.01" for regional 1km data # For the modis-based data, set to: - # 1) "modis.igbp.0.05" for global 5km data - # 2) "modis.igbp.0.03" for global 3km data - # 3) "modis.igbp.conus.0.01" for regional 1km data + # 1) "modis.igbp.0.05" for global 0.05-deg data + # 2) "modis.igbp.0.03" for global 0.03-deg data + # 3) "modis.igbp.conus.30s" for CONUS 30s data + # 4) "modis.igbp.nh.30s" for N Hemis 30s data + # 5) "modis.igbp.30s" for global 30s data + +export soil_type_src="statsgo.0.05" # Soil type data. Choices are: + # 1) "statsgo.0.03" for global 0.03-deg data + # 2) "statsgo.0.05" for global 0.05-deg data + # 3) "statsgo.conus.30s" for CONUS 30s data + # 4) "statsgo.nh.30s" for NH 30s data + # 5) "statsgo.30s" for global 30s data if [ $gtype = uniform ]; then export res=96 diff --git a/driver_scripts/driver_grid.orion.sh b/driver_scripts/driver_grid.orion.sh index dd5b58e99..ce90cb3f9 100755 --- a/driver_scripts/driver_grid.orion.sh +++ b/driver_scripts/driver_grid.orion.sh @@ -52,10 +52,11 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) Check settings for 'make_gsl_orog' and 'veg_type_src' -# below. -# 10) Submit script: "sbatch $script". -# 11) All files will be placed in "out_dir". +# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 10) Set 'soil_veg_src' and 'veg_type_src' to choose the +# soil type and vegetation type data. +# 11) Submit script: "sbatch $script". +# 12) All files will be placed in "out_dir". # #----------------------------------------------------------------------- @@ -78,14 +79,23 @@ export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: - # 1) "viirs.igbp.0.05" for global 5km data - # 2) "viirs.igbp.0.1" for global 10km data - # 3) "viirs.igbp.0.03" for global 3km data + # 1) "viirs.igbp.0.05" for global 0.05-deg data + # 2) "viirs.igbp.0.1" for global 0.1-deg data + # 3) "viirs.igbp.0.03" for global 0.03-deg data # 4) "viirs.igbp.conus.0.01" for regional 1km data # For the modis-based data, set to: - # 1) "modis.igbp.0.05" for global 5km data - # 2) "modis.igbp.0.03" for global 3km data - # 3) "modis.igbp.conus.0.01" for regional 1km data + # 1) "modis.igbp.0.05" for global 0.05-deg data + # 2) "modis.igbp.0.03" for global 0.03-deg data + # 3) "modis.igbp.conus.30s" for CONUS 30s data + # 4) "modis.igbp.nh.30s" for N Hemis 30s data + # 5) "modis.igbp.30s" for global 30s data + +export soil_type_src="statsgo.0.05" # Soil type data. Choices are: + # 1) "statsgo.0.03" for global 0.03-deg data + # 2) "statsgo.0.05" for global 0.05-deg data + # 3) "statsgo.conus.30s" for CONUS 30s data + # 4) "statsgo.nh.30s" for NH 30s data + # 5) "statsgo.30s" for global 30s data if [ $gtype = uniform ]; then export res=96 diff --git a/driver_scripts/driver_grid.wcoss2.sh b/driver_scripts/driver_grid.wcoss2.sh index b3c160f76..b12466ba6 100755 --- a/driver_scripts/driver_grid.wcoss2.sh +++ b/driver_scripts/driver_grid.wcoss2.sh @@ -51,10 +51,11 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) Check settings for 'make_gsl_orog' and 'veg_type_src' -# below. -# 10) Submit script: "cat $script | bsub". -# 11) All files will be placed in "out_dir". +# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 10) Set 'soil_veg_src' and 'veg_type_src' to choose the +# soil type and vegetation type data. +# 11) Submit script: "qsub $script". +# 12) All files will be placed in "out_dir". # #----------------------------------------------------------------------- @@ -75,14 +76,23 @@ export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL # orographic drag suite export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: - # 1) "viirs.igbp.0.05" for global 5km data - # 2) "viirs.igbp.0.1" for global 10km data - # 3) "viirs.igbp.0.03" for global 3km data + # 1) "viirs.igbp.0.05" for global 0.05-deg data + # 2) "viirs.igbp.0.1" for global 0.1-deg data + # 3) "viirs.igbp.0.03" for global 0.03-deg data # 4) "viirs.igbp.conus.0.01" for regional 1km data # For the modis-based data, set to: - # 1) "modis.igbp.0.05" for global 5km data - # 2) "modis.igbp.0.03" for global 3km data - # 3) "modis.igbp.conus.0.01" for regional 1km data + # 1) "modis.igbp.0.05" for global 0.05-deg data + # 2) "modis.igbp.0.03" for global 0.03-deg data + # 3) "modis.igbp.conus.30s" for CONUS 30s data + # 4) "modis.igbp.nh.30s" for N Hemis 30s data + # 5) "modis.igbp.30s" for global 30s data + +export soil_type_src="statsgo.0.05" # Soil type data. Choices are: + # 1) "statsgo.0.03" for global 0.03-deg data + # 2) "statsgo.0.05" for global 0.05-deg data + # 3) "statsgo.conus.30s" for CONUS 30s data + # 4) "statsgo.nh.30s" for NH 30s data + # 5) "statsgo.30s" for global 30s data if [ $gtype = uniform ]; then export res=96 diff --git a/ush/sfc_climo_gen.sh b/ush/sfc_climo_gen.sh index ddd2bc939..f3113122f 100755 --- a/ush/sfc_climo_gen.sh +++ b/ush/sfc_climo_gen.sh @@ -23,6 +23,8 @@ # res Resolution of cubed-sphere grid # SAVE_DIR Directory where output is saved # WORK_DIR Temporary working directory +# SOIL_TYPE_FILE Path/name of input soil type data. +# VEG_TYPE_FILE Path/name of input vegetation type data. #------------------------------------------------------------------------- set -eux @@ -39,6 +41,8 @@ mosaic_file=${mosaic_file:-$FIX_FV3/C${res}_mosaic.nc} HALO=${HALO:-0} veg_type_src=${veg_type_src:-"modis.igbp.0.05"} VEG_TYPE_FILE=${VEG_TYPE_FILE:-${input_sfc_climo_dir}/vegetation_type.${veg_type_src}.nc} +soil_type_src=${soil_type_src:-"statsgo.0.05"} +SOIL_TYPE_FILE=${SOIL_TYPE_FILE:-${input_sfc_climo_dir}/soil_type.${soil_type_src}.nc} if [ ! -d $SAVE_DIR ]; then mkdir -p $SAVE_DIR @@ -65,7 +69,7 @@ input_substrate_temperature_file="${input_sfc_climo_dir}/substrate_temperature.2 input_maximum_snow_albedo_file="${input_sfc_climo_dir}/maximum_snow_albedo.0.05.nc" input_snowfree_albedo_file="${input_sfc_climo_dir}/snowfree_albedo.4comp.0.05.nc" input_slope_type_file="${input_sfc_climo_dir}/slope_type.1.0.nc" -input_soil_type_file="${input_sfc_climo_dir}/soil_type.statsgo.0.05.nc" +input_soil_type_file="${SOIL_TYPE_FILE}" input_vegetation_type_file="${VEG_TYPE_FILE}" input_vegetation_greenness_file="${input_sfc_climo_dir}/vegetation_greenness.0.144.nc" mosaic_file_mdl="$mosaic_file" From 6234c36d63a4a9a2790156bddb49cc7f87218dad Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 13 Oct 2022 13:19:54 +0000 Subject: [PATCH 3/5] Update comments in ./util/sfc_climo_gen/run.wcoss2.sh. Add export of soil type data source variable. Fixes #702. --- util/sfc_climo_gen/run.wcoss2.sh | 34 ++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/util/sfc_climo_gen/run.wcoss2.sh b/util/sfc_climo_gen/run.wcoss2.sh index 91c48566a..c1a67b5aa 100755 --- a/util/sfc_climo_gen/run.wcoss2.sh +++ b/util/sfc_climo_gen/run.wcoss2.sh @@ -46,15 +46,33 @@ export FIX_FV3=${BASE_DIR}/fix/orog/C${res} ##HALO=3 ##export GRIDTYPE=regional -#------------------------------------- -# Choose which virrs data to use. -#------------------------------------- +#------------------------------------------------------------- +# Choose which soil type and vegetation type data to use. +# +# For viirs-based vegetation type data, set to: +# 1) "viirs.igbp.0.1" for global 0.1-deg data +# 2) "viirs.igbp.0.05" for global 0.05-deg data +# 3) "viirs.igbp.0.03" for global 0.03-deg data +# 4) "viirs.igbp.conus.0.01" for regional 1km data +# +# For the modis-based vegetation data, set to: +# 1) "modis.igbp.0.05" for global 0.05-deg data +# 2) "modis.igbp.0.03" for global 0.03-deg data +# 3) "modis.igbp.conus.30s" for CONUS 30s data +# 4) "modis.igbp.nh.30s" for N Hemis 30s data +# 5) "modis.igbp.30s" for global 30s data +# +# Soil type data +# 1) "statsgo.0.05" for global 0.05-deg data +# 2) "statsgo.0.03" for global 0.03-deg data +# 3) "statsgo.conus.30s" for CONUS 30s data +# 4) "statsgo.nh.30s" for NH 30s data +# 5) "statsgo.30s" for global 30s data +#------------------------------------------------------------- + +export veg_type_src="modis.igbp.0.05" -export veg_type_src="viirs.igbp.0.05" # Use global 0.05-degree viirs data -#export veg_type_src="viirs.igbp.0.1" # Use global 0.1-degree viirs data -#export veg_type_src="viirs.igbp.0.03" # Use global 0.03-degree viirs data -#export veg_type_src="viirs.igbp.conus.0.01" # Use CONUS 0.01-degree virrs data. Do not - # use for global grids. +export soil_type_src="statsgo.0.05" #------------------------------------- # Set working directory and directory where output files will be saved. From 7feafe8c7519689a7759724b761ce7dc4acb62ed Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 13 Oct 2022 14:09:22 +0000 Subject: [PATCH 4/5] Update 'readthedocs' for new data sets. Fixes #702. --- docs/source/ufs_utils.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 8599a126e..6122b9d02 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -525,16 +525,20 @@ The surface climatological data is located here `./fix/fix_sfc_climo Date: Fri, 18 Nov 2022 08:24:21 -0600 Subject: [PATCH 5/5] Update grid generation script comments. Fixes #702. --- driver_scripts/driver_grid.hera.sh | 8 ++++---- driver_scripts/driver_grid.jet.sh | 6 +++--- driver_scripts/driver_grid.orion.sh | 6 +++--- driver_scripts/driver_grid.wcoss2.sh | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/driver_scripts/driver_grid.hera.sh b/driver_scripts/driver_grid.hera.sh index d9ad1635c..83ff96b91 100755 --- a/driver_scripts/driver_grid.hera.sh +++ b/driver_scripts/driver_grid.hera.sh @@ -52,7 +52,7 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 9) To use the GSL orographic drag suite, set 'make_gsl_orog' to true. # 10) Set 'soil_veg_src' and 'veg_type_src' to choose the # soil type and vegetation type data. # 11) Submit script: "sbatch $script". @@ -73,9 +73,9 @@ module list #----------------------------------------------------------------------- export gtype=uniform # 'uniform', 'stretch', 'nest', - # 'regional_gfdl', 'regional_esg' -export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL - # orographic drag suite + # 'regional_gfdl', 'regional_esg'. +export make_gsl_orog=false # When 'true' will output 'oro' files for + # the GSL orographic drag suite. export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: # 1) "viirs.igbp.0.1" for global 0.10-deg data diff --git a/driver_scripts/driver_grid.jet.sh b/driver_scripts/driver_grid.jet.sh index 1942d412c..2e1fec251 100755 --- a/driver_scripts/driver_grid.jet.sh +++ b/driver_scripts/driver_grid.jet.sh @@ -53,7 +53,7 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 9) To use the GSL orographic drag suite, set 'make_gsl_orog' to true. # 10) Set 'soil_veg_src' and 'veg_type_src' to choose the # soil type and vegetation type data. # 11) Submit script: "sbatch $script". @@ -74,8 +74,8 @@ module list export gtype=uniform # 'uniform', 'stretch', 'nest', # 'regional_gfdl', 'regional_esg' -export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL - # orographic drag suite +export make_gsl_orog=false # When 'true' will output 'oro' files for + # the GSL orographic drag suite. export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: # 1) "viirs.igbp.0.1" for global 0.10-deg data diff --git a/driver_scripts/driver_grid.orion.sh b/driver_scripts/driver_grid.orion.sh index dee989bd3..e63fccd4e 100755 --- a/driver_scripts/driver_grid.orion.sh +++ b/driver_scripts/driver_grid.orion.sh @@ -52,7 +52,7 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 9) To use the GSL orographic drag suite, set 'make_gsl_orog' to true. # 10) Set 'soil_veg_src' and 'veg_type_src' to choose the # soil type and vegetation type data. # 11) Submit script: "sbatch $script". @@ -74,8 +74,8 @@ module list export gtype=regional_esg # 'uniform', 'stretch', 'nest', # 'regional_gfdl', 'regional_esg' -export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL - # orographic drag suite +export make_gsl_orog=false # When 'true' will output 'oro' files for + # the GSL orographic drag suite. export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: diff --git a/driver_scripts/driver_grid.wcoss2.sh b/driver_scripts/driver_grid.wcoss2.sh index 56f6142c7..69c8ace70 100755 --- a/driver_scripts/driver_grid.wcoss2.sh +++ b/driver_scripts/driver_grid.wcoss2.sh @@ -51,7 +51,7 @@ # x/y grid spacing - "delx/y", and halo. # 8) Set working directory - TEMP_DIR - and path to the repository # clone - home_dir. -# 9) To use GFS orographic drag suite, set 'make_gsl_orog' to true. +# 9) To use the GSL orographic drag suite, set 'make_gsl_orog' to true. # 10) Set 'soil_veg_src' and 'veg_type_src' to choose the # soil type and vegetation type data. # 11) Submit script: "qsub $script". @@ -72,8 +72,8 @@ module list export gtype=regional_esg # 'uniform', 'stretch', 'nest', # 'regional_gfdl', 'regional_esg' -export make_gsl_orog=false # 'true' if user needs 'oro' files for GSL - # orographic drag suite +export make_gsl_orog=false # When 'true' will output 'oro' files for + # the GSL orographic drag suite. export veg_type_src="modis.igbp.0.05" # veg type data. # For viirs-based vegetation type data, set to: # 1) "viirs.igbp.0.1" for global 0.10-deg data