From 46a8d7abb6b5d6dc249d06e09c625ba3bbc411de Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 15:14:28 +0000 Subject: [PATCH 01/41] Minor doxygen fix. Fixes #643. --- sorc/sfc_climo_gen.fd/docs/user_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sorc/sfc_climo_gen.fd/docs/user_guide.md b/sorc/sfc_climo_gen.fd/docs/user_guide.md index aa9c6a80a..40f291ef1 100644 --- a/sorc/sfc_climo_gen.fd/docs/user_guide.md +++ b/sorc/sfc_climo_gen.fd/docs/user_guide.md @@ -9,5 +9,5 @@ fields, such as vegetation type and albedo, for an FV3 grid. This document is part of the UFS_UTILS documentation. -The orog_mask_tools programs are part of the +This program is part of the [UFS_UTILS](https://github.com/ufs-community/UFS_UTILS) project. From 4fd1620ea309a0b8c485d2d3c6d6ef2a38d194c8 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 15:53:43 +0000 Subject: [PATCH 02/41] Update for new vegetation type data. Fixes #643 --- docs/source/ufs_utils.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index b6e23aefe..7de4d83b4 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -403,7 +403,14 @@ The global surface climatological data is located in ./fix/fix_sfc_climo. All N * Global 0.05-degree four component monthly snow-free albedo - snowfree_albedo.4comp.0.05.nc * Global 1.0-degree categorical slope type - slope_type.1.0.nc * Global 0.05-degree categorical STATSGO soil type - soil_type.statsgo.0.05.nc - * Global 0.05-degree categorical IGBP vegetation type - vegetation_type.igbp.0.05.nc + * Categorical IGBP vegetation type + * MODIS-based global 0.03-degree - vegetation_type.modis.igbp.0.03.nc + * MODIS-based global 0.05-degree - vegetation_type.modis.igbp.0.05.nc + * MODIS-based CONUS 0.01-degree - vegetation_type.modis.igbp.conus.0.01.nc + * NESDIS VIIRS-based global 0.03-degree - vegetation_type.viirs.igbp.0.03.nc + * NESDIS VIIRS-based global 0.05-degree - vegetation_type.viirs.igbp.0.05.nc + * NESDIS VIIRS-based global 0.1-degree - vegetation_type.viirs.igbp.0.1.nc + * NESDIS VIIRS-based CONUS 0.01-degree - vegetation_type.viirs.igbp.conus.0.01.nc * Global 0.144-degree monthly vegetation greenness in percent - vegetation_greenness.0.144.nc * Model mosaic file - CRES_mosaic.nc (NetCDF) * Model orography files including halo - CRES_oro_data.tile#.halo#.nc (NetCDF) From 6a0b9362a575c7ecc5ad0fcea708e0985abeb41d Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 16:01:26 +0000 Subject: [PATCH 03/41] Updates for soil type data. Fixes #643 --- docs/source/ufs_utils.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 7de4d83b4..3cf219a74 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -402,7 +402,10 @@ The global surface climatological data is located in ./fix/fix_sfc_climo. All N * Global 2.6 x 1.5-degree soil substrate temperature - substrate_temperature.2.6x1.5.nc * Global 0.05-degree four component monthly snow-free albedo - snowfree_albedo.4comp.0.05.nc * Global 1.0-degree categorical slope type - slope_type.1.0.nc - * Global 0.05-degree categorical STATSGO soil type - soil_type.statsgo.0.05.nc + * Categorical STATSGO soil type + * Global 0.03-degree - soil_type.statsgo.0.03.nc + * Global 0.05-degree - soil_type.statsgo.0.05.nc + * CONUS 0.01-degree - soil_type.statsgo.conus.0.01.nc * Categorical IGBP vegetation type * MODIS-based global 0.03-degree - vegetation_type.modis.igbp.0.03.nc * MODIS-based global 0.05-degree - vegetation_type.modis.igbp.0.05.nc From 3763a1a7e60fa29ccd34f46106ad93d7963690df Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 17:57:02 +0000 Subject: [PATCH 04/41] More sfc_climo_gen updates. Fixes #643. --- docs/source/ufs_utils.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 3cf219a74..96c3b8d6f 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -395,7 +395,7 @@ Program inputs and outputs **Input data:** -The global surface climatological data is located in ./fix/fix_sfc_climo. All NetCDF. +The surface climatological data is located in ./fix/fix_sfc_climo. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc @@ -415,9 +415,12 @@ The global surface climatological data is located in ./fix/fix_sfc_climo. All N * NESDIS VIIRS-based global 0.1-degree - vegetation_type.viirs.igbp.0.1.nc * NESDIS VIIRS-based CONUS 0.01-degree - vegetation_type.viirs.igbp.conus.0.01.nc * Global 0.144-degree monthly vegetation greenness in percent - vegetation_greenness.0.144.nc - * Model mosaic file - CRES_mosaic.nc (NetCDF) - * Model orography files including halo - CRES_oro_data.tile#.halo#.nc (NetCDF) - * Model grid files including halo - CRES_grid.tile#.halo#.nc (NetCDF) + +The files that define the model grid. All NetCDF. + + * Model mosaic file - CRES_mosaic.nc + * Model orography files including halo - CRES_oro_data.tile#.halo#.nc + * Model grid files including halo - CRES_grid.tile#.halo#.nc **Output files:** From f6e1c833ae46ec284d6db541d44e24bb0ca8feeb Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 18:46:21 +0000 Subject: [PATCH 05/41] chgres_cube updates. Fixes #643. --- docs/source/chgres_cube.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 988e346bb..8a6918236 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -22,14 +22,16 @@ The program assumes Noah/Noah-MP LSM coefficients for certain soil thresholds. I * static_data.F90 - Reads static surface climatological data for the target FV3 grid (such as soil type and vegetation type). Time interpolates time-varying fields, such as monthly plant greenness, to the model run time. Data for each target FV3 resolution resides in the ‘fixed’ directory. Set path via the fix_dir_target_grid namelist variable. * write_data.F90 - Writes the tiled and header files expected by the forecast model. * input_data.F90 - Contains routines to read atmospheric and surface data from GRIB2, NEMSIO and NetCDF files. - * utils.f90 - Contains utility routines, such as error handling. + * utils.F90 - Contains utility routines, such as error handling. * grib2_util.F90 - Routines to (1) convert from RH to specific humidity; (2) convert from omega to dzdt. Required for GRIB2 input data. * atmosphere.F90 - Process atmospheric fields. Horizontally interpolate from input to target FV3 grid using ESMF regridding. Adjust surface pressure according to terrain differences between input and target grid. Vertically interpolate to target FV3 grid vertical levels. Description of main routines: * read_vcoord_info - Reads model vertical coordinate definition file (as specified by namelist variable vcoord_file_target_grid). - * newps - computes adjusted surface pressure given a new terrain height. - * newpr1 - computes 3-D pressure given an adjusted surface pressure. + * newps - Computes adjusted surface pressure given a new terrain height. + * newpr1 - Computes 3-D pressure given an adjusted surface pressure. * vintg - vertically interpolate atmospheric fields to target FV3 grid. + * vintg_wam - vertically interpolate atmospheric fields to the thermosphere. Supports the Whole Atmosphere Model. + * atmosphere_target_data.F90 - Holds the target grid atmospheric ESMF fields. * surface.F90 - process land, sea/lake ice, open water/Near Sea Surface Temperature (NSST) fields. NSST fields are not available when using GRIB2 input data. Description of main routines: * interp - horizontally interpolate fields from input to target FV3 grid. @@ -38,7 +40,10 @@ The program assumes Noah/Noah-MP LSM coefficients for certain soil thresholds. I * rescale_soil_moisture - adjust total soil moisture for differences between soil type on input and target FV3 grids. Required to preserve latent/sensible heat fluxes. * roughness - set roughness length at land and sea/lake ice. At land, a vegetation type-based lookup table is used. * qc_check - some consistency checks. - * search_util.f90 - searches for the nearest valid land/non-land data where the input and target fv3 land-mask differ. Example: when the target FV3 grid depicts an island that is not resolved by the input data. If nearby valid data is not found, a default value is used. + * surface_target_data.F90 - Holds the target grid surface ESMF fields. + * search_util.F90 - searches for the nearest valid land/non-land data where the input and target fv3 land-mask differ. Example: when the target FV3 grid depicts an island that is not resolved by the input data. If nearby valid data is not found, a default value is used. + * thompson_mp_climo_data.F90 - Processes climatological Thompson micro-physics fields. + * wam_climo_data.f90 - Process vertical profile climatological data for the Whole Atmosphere Model. Configuring and using chgres_cube for global applications --------------------------------------------------------- @@ -344,6 +349,7 @@ Namelist variables with “input” in their name refer to data input to chgres_ * minmax_vgfrc_from_climo - Use min/max vegetation fraction from climatology. Valid options: .true. or .false. (Default: .true.) * tg3_from_soil - Use tg3 from input soil. Valid options: .true. or .false. . Default: .false. * thomp_mp_climo_file - Location of Thompson aerosol climatology file. Provide only if you wish to use these aerosol variables. + * wam_cold_start - When true, cold start for the Whole Atmosphere Model. Variable Mapping (VARMAP) table ------------------------------- From a55169eac443ede57f4bceaab5e458e8338c3934 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 18:51:55 +0000 Subject: [PATCH 06/41] Minor fix to chgres_cube doc. Fixes #643. --- docs/source/chgres_cube.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 8a6918236..75724b2c1 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -349,7 +349,7 @@ Namelist variables with “input” in their name refer to data input to chgres_ * minmax_vgfrc_from_climo - Use min/max vegetation fraction from climatology. Valid options: .true. or .false. (Default: .true.) * tg3_from_soil - Use tg3 from input soil. Valid options: .true. or .false. . Default: .false. * thomp_mp_climo_file - Location of Thompson aerosol climatology file. Provide only if you wish to use these aerosol variables. - * wam_cold_start - When true, cold start for the Whole Atmosphere Model. + * wam_cold_start - Cold start for the Whole Atmosphere Model. Valid Options: .true. or .false. (Default: .false.) Variable Mapping (VARMAP) table ------------------------------- From 090464f7a2674f87b6c25fd0d7fcf8efdd342ed4 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 20:17:02 +0000 Subject: [PATCH 07/41] Update for orog_gsl. Fixes #643. --- docs/source/ufs_utils.rst | 43 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 96c3b8d6f..fcb5ed650 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -258,6 +258,49 @@ Orography files - one for each tile - oro.CRES.tile#.nc (NetCDF). Contains thes * sigma - slope of orography (unitless) * elvmax - maximum height above mean (meters) +orog_gsl +======== + +Introduction +------------ + +This program computes orographics statistics fields required for the orographic drag suite developed by NOAA's Global Systems Laboratory (GSL). The fields are a subset of the ones calculated by "orog" except that they are calculated in a different manner. The fields are: + + * stddev - Standard deviation of subgrid topography + * convexity - Convexity of subgrid topography + * oa1 - Orographic asymmetry of subgrid topography - westerly + * oa2 - Orographic asymmetry of subgrid topography - southerly + * oa3 - Orographic asymmetry of subgrid topography - southwesterly + * oa4 - Orographic asymmetry of subgrid topography - northwesterly + * ol1 - Orographic effective length of subgrid topography - westerly + * ol2 - Orographic effective length of subgrid topography - southerly + * ol3 - Orographic effective length of subgrid topography - southwesterly + * ol4 - Orographic effective length of subgrid topography - northwesterly + +Code structure +-------------- + +Location of source code: ./sorc/orog_mask_tools.fd/orog_gsl.fd. + +Program inputs and outputs +-------------------------- + +The program reads the tile number (1-6 for global, 7 for stand-alone regional) and grid resolution (e.g., 768) from standard input. + +**Input data:** + +All in NetCDF. + + * geo_em.d01.lat-lon.2.5m.HGT_M.nc - global topographic data on 2.5-minute lat-lon grid (interpolated from GMTED2010 30-second topographic data). + * HGT.Beljaars_filtered.lat-lon.30s_res.nc - global topographic data on 30-second lat-lon grid (GMTED2010 data smoothed according to Beljaars et al. (QJRMS, 2004)) + +**Output data:** + +One for each tile. All in NetCDF. + + * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of Kim and Doyle (QJRMS, 2005) + * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave dray scheme of Tsiringakis et al. (QJRMS, 2017) and the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). + filter_topo =========== From 2942690b00607652428f623ca81dcbad5336d7ea Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 20:54:42 +0000 Subject: [PATCH 08/41] Add vcoord_gen. Fixes #643. --- docs/source/ufs_utils.rst | 44 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index fcb5ed650..14d5d1438 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -477,3 +477,47 @@ All files with and without halo (all NetCDF). * Soil type - CRES_soil_type.tile#.halo#.nc * Vegetation type - CRES_vegetation_type.tile#.halo#.nc * Vegetation greenness - CRES_vegetation_greenness.tile#.halo#.nc + + +vcoord_gen +========== + +Introduction +------------ + +This program generates hybrid coordinate parameters from fields such as surface pressure, model top and the number of vertical levels. Outputs the 'ak' and 'bk' parameters used by the forecast model and chgres_cube to define the hybrid levels as follows: + + * pressure = ak + surface_pressure * bk + +Code structure +-------------- + +Location of the source code: ./sorc/vcoord_gen.fd. + +Program inputs +-------------- + +The following user-defined parameters are read in from standard input. + + * levs - Integer number of levels + * lupp - Integer number of levels below pupp + * pbot - Real nominal surface pressure (Pa) + * psig - Real nominal pressure where coordinate changes from pure sigma (Pa) + * ppre - Real nominal pressure where coordinate changes from pure pressure (Pa) + * pupp - Real nominal pressure where coordinate changes to upper atmospheric profile (Pa) + * ptop - Real pressure at top (Pa) + * dpbot - Real coordinate thickness at bottom (Pa) + * dpsig - Real thickness of zone within which coordinate changes to pure sigma (Pa) + * dppre - Real thickness of zone within which coordinate changes to pure pressure (Pa) + * dpupp - Real coordinate thickness at pupp (Pa) + * dptop - Real coordinate thickness at top (Pa) + +Program outputs +--------------- + +A text file is output containing the 'ak' and 'bk' values. To use it in chgres_cube, set namelist variable "vcoord_target_grid" to the path/name of this file. + +Run script +---------- + +To run, use script ./util/vcoord_gen/run.sh From 1d67f918f7891d9a7224cd8857be30efd59e27da Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 20 Apr 2022 21:06:02 +0000 Subject: [PATCH 09/41] Minor updates. Fixes #643. --- docs/source/ufs_utils.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 14d5d1438..52c8bbee0 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -298,8 +298,8 @@ All in NetCDF. One for each tile. All in NetCDF. - * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of Kim and Doyle (QJRMS, 2005) - * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave dray scheme of Tsiringakis et al. (QJRMS, 2017) and the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). + * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of Kim and Doyle (2005) (https://doi.org/10.1256/qj.04.160) + * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave dray scheme of Tsiringakis et al. (2017) (https://doi.org/10.1002/qj.3021). And the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). filter_topo =========== @@ -487,7 +487,7 @@ Introduction This program generates hybrid coordinate parameters from fields such as surface pressure, model top and the number of vertical levels. Outputs the 'ak' and 'bk' parameters used by the forecast model and chgres_cube to define the hybrid levels as follows: - * pressure = ak + surface_pressure * bk + * pressure = ak + (surface_pressure * bk) Code structure -------------- From dc1393a623e2b9c032136af2956b2247778ac857 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 21 Apr 2022 19:06:14 +0000 Subject: [PATCH 10/41] Add documentation for inland. Fixes #643. --- docs/source/ufs_utils.rst | 40 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 52c8bbee0..a922d58bc 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -16,7 +16,8 @@ The following programs are used to create a grid. * make_hgrid * regional_grid_esg * make_solo_mosaic - * orog + * orog or orog_gsl + * inland * global_equiv_resol * shave * filter_topo @@ -26,7 +27,9 @@ The grid generation process is run by these scripts (located under ./ush) * fv3gfs_grid_driver.sh (driver script) * fv3gfs_make_grid.sh (creates the geo-referencing for the grid) - * fv3gfs_make_orog.sh (creates the land-sea mask and terrain) + * fv3gfs_make_orog.sh (creates the land-sea mask, terrain and gravity wave drag fields) + * fv3gfs_make_orog_gsl.sh (creates the land-sea mask, terrain and GSL gravity wave drag fields) + * fv3gfs_make_lake.sh (adds lakes and lake depth. optional) * fv3gfs_filter_topo.sh (filters the orography) * sfc_climo_gen.sh (creates climatological surface fields, such as soil type) @@ -301,6 +304,39 @@ One for each tile. All in NetCDF. * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of Kim and Doyle (2005) (https://doi.org/10.1256/qj.04.160) * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave dray scheme of Tsiringakis et al. (2017) (https://doi.org/10.1002/qj.3021). And the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). +inland +====== + +Introduction +------------ + +This program reads an orography file, determines which points are inland from water, then writes out a mask record that identifies these points. + +Code structure +-------------- + +Location of source code: ./sorc/orog_mask_tools.fd/inland.fd. + +Program control options +----------------------- + +The program reads the following parameters from standard input: + * The resolution. Ex: '96' for C96. + * Nonland cutoff fraction. Default is '0.99'. + * Maximum recursive depth. Default is '7'. + * Grid type flag - 'g' for global, 'r' for regional. + +Program inputs and outputs +-------------------------- + +**Input data:** + + * orography file - the orography file from the orog or orog_gsl programs - oro.CRES.tile#.nc (NetCDF) + +**Output data:** + + * orography file - The input file, but containing an 'inland' record - '1' inland, '0' coastal. + filter_topo =========== From e53acc79f5f5a6e5d7473244efe8f0b5fa3d12d8 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 21 Apr 2022 20:49:55 +0000 Subject: [PATCH 11/41] Add documentation for lakefrac. Fixes #643 --- docs/source/ufs_utils.rst | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index a922d58bc..4a535a13b 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -17,7 +17,8 @@ The following programs are used to create a grid. * regional_grid_esg * make_solo_mosaic * orog or orog_gsl - * inland + * inland (optional) + * lakefrac (optional) * global_equiv_resol * shave * filter_topo @@ -337,6 +338,42 @@ Program inputs and outputs * orography file - The input file, but containing an 'inland' record - '1' inland, '0' coastal. +lakefrac +======== + +Introduction +------------ + +This program sets freshwater lake fraction and lake depth on the model grid. + +Code structure +-------------- + +Location of source code: ./sorc/orog_mask_tools.fd/lake.fd. + +Program control options +----------------------- + +The program reads the following parameters from standard input: + * The tile number. + * The resolution. Ex: '96' for C96. + * The path to the global lake data. + * Minimum lake fraction in percent. + +Program inputs and outputs +-------------------------- + +**Input data:** + + * grid file - the "grid" file from the make_hgrid or regional_esg programs - CRES_grid.tile#.nc - (NetCDF) + * orography file - the orography file including the 'inland' flag record from the inland program - oro.CRES.tile#.nc (NetCDF) + * lake status code file - GlobalLakeStatus.dat (located in ./fix/fix_orog). See GlobalLakeStatus.txt for the defintion of each code. + * lake depth file - GlobalLakeDepth.dat (located in ./fix/fix_orog) + +**Output data:** + + * orography file - the orography file including records of lake fraction and lake depth - oro.CRES.tile#.nc (NetCDF) + filter_topo =========== From 64a2dfb93fb5311521cc09cf084291f3d5b1f667 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 21 Apr 2022 21:14:10 +0000 Subject: [PATCH 12/41] Link to emc ftp site. Fixes #643. --- docs/source/ufs_utils.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 4a535a13b..06f02ea84 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -511,7 +511,7 @@ Program inputs and outputs **Input data:** -The surface climatological data is located in ./fix/fix_sfc_climo. All NetCDF. +The surface climatological data is located in https://ftp.emc.ncep.noaa.gov/EIB/UFS/SRW/v1p0/fix/fix_sfc_climo. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc From e7765c720e3de6454f3ed0a527168fdaad92072b Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 13:10:27 +0000 Subject: [PATCH 13/41] Update link. Fixes #643. --- docs/source/ufs_utils.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 06f02ea84..6aa0a3614 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -511,7 +511,7 @@ Program inputs and outputs **Input data:** -The surface climatological data is located in https://ftp.emc.ncep.noaa.gov/EIB/UFS/SRW/v1p0/fix/fix_sfc_climo. All NetCDF. +The surface climatological data is located in `./fix/fix_sfc_climo `. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc From bdd97fe7db2139f19dc4537eeeecc7394f72d276 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 13:13:38 +0000 Subject: [PATCH 14/41] Fix typo. Fixes #643. --- docs/source/ufs_utils.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 6aa0a3614..8d41d19bd 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -511,7 +511,7 @@ Program inputs and outputs **Input data:** -The surface climatological data is located in `./fix/fix_sfc_climo `. All NetCDF. +The surface climatological data is located in `./fix/fix_sfc_climo `_. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc From 3a09a6676ac4d169b7347d78b698660d99b77873 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 13:30:45 +0000 Subject: [PATCH 15/41] Add more links. Fixes #643. --- docs/source/ufs_utils.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 8d41d19bd..d421734fa 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -237,11 +237,11 @@ Program inputs and outputs * The "grid" files (CRES_grid.tile#.nc) containing the geo-reference records for the grid - (NetCDF). Created by the make_hgrid or regional_esg_grid programs. * Global 30-arc-second University of Maryland land cover data. Used to create the land-sea mask. - * ./fix/fix_orog/landcover30.fixed (unformatted binary) + * landcover30.fixed (unformatted binary). Located in `./fix/fix_orog `_. * Global 30-arc-second USGS GMTED2010 orography data. - * ./fix/fix_orog/gmted2010.30sec.int (unformatted binary) + * gmted2010.30sec.int (unformatted binary). Located in `./fix/fix_orog `_. * 30-arc-second RAMP Antarctic terrain data (Radarsat Antarctic Mapping Project) - * ./fix/fix_orog/thirty.second.antarctic.new.bin (unformatted binary) + * thirty.second.antarctic.new.bin (unformatted binary). Located in `./fix/fix_orog `_. **Output data:** From 0127c87e679ea8e9e8820916d98363db417bece1 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 13:43:14 +0000 Subject: [PATCH 16/41] Add more links. Fixes #643. --- docs/source/ufs_utils.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index d421734fa..188231af1 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -367,8 +367,8 @@ Program inputs and outputs * grid file - the "grid" file from the make_hgrid or regional_esg programs - CRES_grid.tile#.nc - (NetCDF) * orography file - the orography file including the 'inland' flag record from the inland program - oro.CRES.tile#.nc (NetCDF) - * lake status code file - GlobalLakeStatus.dat (located in ./fix/fix_orog). See GlobalLakeStatus.txt for the defintion of each code. - * lake depth file - GlobalLakeDepth.dat (located in ./fix/fix_orog) + * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_). See GlobalLakeStatus.txt for the defintion of each code. + * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_). See GlobalLakeDepth.txt for a description of this file. **Output data:** From 6d2a1d6c7dff3163afac4a15634becb5105ad51c Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 14:38:45 +0000 Subject: [PATCH 17/41] chgres_cube updates. Fixes #643. --- docs/source/chgres_cube.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 75724b2c1..93cd6c5bc 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -19,7 +19,7 @@ The program assumes Noah/Noah-MP LSM coefficients for certain soil thresholds. I * Computes required soil parameters * Reads the variable mapping (VARMAP) table. * model_grid.F90 - Sets up the ESMF grid objects for the input data grid and target FV3 grid. - * static_data.F90 - Reads static surface climatological data for the target FV3 grid (such as soil type and vegetation type). Time interpolates time-varying fields, such as monthly plant greenness, to the model run time. Data for each target FV3 resolution resides in the ‘fixed’ directory. Set path via the fix_dir_target_grid namelist variable. + * static_data.F90 - Reads static surface climatological data for the target FV3 grid (such as soil type and vegetation type). Time interpolates time-varying fields, such as monthly plant greenness, to the model run time. Set path to these files via the fix_dir_target_grid namelist variable. * write_data.F90 - Writes the tiled and header files expected by the forecast model. * input_data.F90 - Contains routines to read atmospheric and surface data from GRIB2, NEMSIO and NetCDF files. * utils.F90 - Contains utility routines, such as error handling. @@ -53,7 +53,7 @@ Program inputs and outputs for global applications **Inputs** -The following four sets of files are located here: https://ftp.emc.ncep.noaa.gov/EIB/UFS/global/fix/fix_fv3_gmted2010.v20191213/ +Users may create their own global grids, or use the pre-defined files are located `here: `_. * FV3 mosaic file - (NetCDF format) * CRES_mosaic.nc @@ -74,7 +74,7 @@ The following four sets of files are located here: https://ftp.emc.ncep.noaa.gov * CRES_oro_data.tile5.nc * CRES_oro_data.tile6.nc - * FV3 surface climatological files - Located under the ./fix_sfc sub-directory. One file for each tile. NetCDF format. + * FV3 surface climatological files - Located under the `./fix_sfc `_ sub-directory. One file for each tile. NetCDF format. * CRES.facsf.tileX.nc (fractional coverage for strong/weak zenith angle dependent albedo) * CRES.maximum_snow_albedo.tileX.nc (maximum snow albedo) * CRES.slope_type.tileX.nc (slope type) @@ -84,7 +84,7 @@ The following four sets of files are located here: https://ftp.emc.ncep.noaa.gov * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. Located here: https://ftp.emc.ncep.noaa.gov/EIB/UFS/global/fix/fix_am.v20191213/ + * FV3 vertical coordinate file. Text file. `Located here. `_ * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. @@ -240,7 +240,7 @@ The following four sets of files/directories should all be located in the same d * CRES.vegetation_greenness.tile7.halo4.nc (vegetation greenness) * CRES.vegetation_type.tile7.halo4.nc (vegetation type) - * FV3 vertical coordinate file. Text file. Located in ./fix_am directory. + * FV3 vertical coordinate file. Text file. Located in `./fix_am `_ directory. * global_hyblev.l$LEVS.txt * Input data files. GRIB2 only. See the next section for how to find this data. @@ -317,7 +317,6 @@ Namelist variables with “input” in their name refer to data input to chgres_ **Required Entries** * fix_dir_target_grid - Path to the FV3-LAM surface climatological files (such as albedo). - * fix_dir_input_grid - Directory containing RAP lat/lon file. On NOAA HPC machines, typically the “fix/fix_am” directory of the UFS_UTILS directory. * mosaic_file_target_grid - Path and name of the FV3-LAM mosaic file. * orog_dir_target_grid - Directory containing the FV3-LAM orography and grid files (NetCDF). * orog_files_target_grid - Names of the FV3-LAM orography file. From ed0e2ff08fdf242d720458d8631fbea68f3800f8 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 14:46:06 +0000 Subject: [PATCH 18/41] Minor bug fix. Fixes #643. --- docs/source/chgres_cube.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 93cd6c5bc..076f943cb 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -53,7 +53,7 @@ Program inputs and outputs for global applications **Inputs** -Users may create their own global grids, or use the pre-defined files are located `here: `_. +Users may create their own global grids, or use the pre-defined files are located `here `_. * FV3 mosaic file - (NetCDF format) * CRES_mosaic.nc @@ -84,7 +84,7 @@ Users may create their own global grids, or use the pre-defined files are locate * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. `Located here. `_ + * FV3 vertical coordinate file. Text file. `Located here. `_ * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. From 641ffe107b737311852d784135fd9030193ecd96 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 15:30:10 +0000 Subject: [PATCH 19/41] Update data section. Fixes #643. --- docs/source/chgres_cube.rst | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 076f943cb..6b0118e29 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -108,24 +108,20 @@ Users may create their own global grids, or use the pre-defined files are locate * out.sfc.tile1.nc -Where to find GFS GRIB2, NEMSIO and NetCDF data for global applications -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Where to find GFS GRIB2 and NetCDF data for global applications +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **GRIB2** - * 0.25-degree data (last 10 days only) - Use the **gfs.tHHz.pgrb2.0p25.f000** files in subdirectory gfs.YYYYMMDD/HH `here `_.` + * 0.25-degree data (last 10 days only) - Use the **gfs.tHHz.pgrb2.0p25.f000** files in subdirectory gfs.YYYYMMDD/HH on `NOMADS `_. - * 0.5-degree data - Use the **gfs_4_YYYYMMDD_00HH_000.grb2** file, under **GFS Forecasts 004 (0.5-deg)** here: `NCDC - Global Forecast System `__. Note: *Tests were not done with the AVN, MRF or analysis data*. - - * 1.0-degree data - Use the **gfs_3_YYYYMMDD_00HH_000.grb2 file**, under **GFS Forecasts 003 (1-deg)** here: `NCDC - Global Forecast System `__. Note: *Tests were not done with the AVN, MRF or analysis data*. - -**NEMSIO** + * 0.5-degree data - Use the **gfs_4_YYYYMMDD_HHHH_000.grb2** file, under **GFS Forecasts 004 (0.5-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. - * T1534 gaussian (last 10 days only) - Use the **gfs.tHHz.atmanl.nemsio** (atmospheric fields) and **gfs.tHHz.sfcanl.nemsio** (surface fields) files in subdirectory gfs.YYYYMMDD/HH `here `_. + * 1.0-degree data - Use the **gfs_3_YYYYMMDD_00HH_000.grb2 file**, under **GFS Forecasts 003 (1-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. **NetCDF** - * T1534 gaussian (don't have any more details at this time). + * T1534 gaussian (last 10 days only) - Use the **gfs.tHHz.atmanl.nc** (atmospheric fields) and **gfs.tHHz.sfcanl.nc** (surface fields) files in subdirectory gfs.YYYYMMDD/HH/atmos on `NOMADS `_. Initializing global domains with GRIB2 data - some caveats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 62832126a2aff603c6f5271610d5a647092778d6 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 15:44:18 +0000 Subject: [PATCH 20/41] Fix some bad links. Fixes #643. --- docs/source/chgres_cube.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 6b0118e29..37c19e853 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -113,15 +113,15 @@ Where to find GFS GRIB2 and NetCDF data for global applications **GRIB2** - * 0.25-degree data (last 10 days only) - Use the **gfs.tHHz.pgrb2.0p25.f000** files in subdirectory gfs.YYYYMMDD/HH on `NOMADS `_. + * 0.25-degree data (last 10 days only) - Use the **gfs.tHHz.pgrb2.0p25.f000** files in subdirectory ./gfs.YYYYMMDD/HH/atmos on `NOMADS `_. - * 0.5-degree data - Use the **gfs_4_YYYYMMDD_HHHH_000.grb2** file, under **GFS Forecasts 004 (0.5-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. + * 0.5-degree data - Use the **gfs_4_YYYYMMDD_HHHH_000.grb2** file, under **GFS Forecasts 004 (0.5-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. - * 1.0-degree data - Use the **gfs_3_YYYYMMDD_00HH_000.grb2 file**, under **GFS Forecasts 003 (1-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. + * 1.0-degree data - Use the **gfs_3_YYYYMMDD_HHHH_000.grb2 file**, under **GFS Forecasts 003 (1.0-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. **NetCDF** - * T1534 gaussian (last 10 days only) - Use the **gfs.tHHz.atmanl.nc** (atmospheric fields) and **gfs.tHHz.sfcanl.nc** (surface fields) files in subdirectory gfs.YYYYMMDD/HH/atmos on `NOMADS `_. + * T1534 gaussian (last 10 days only) - Use the **gfs.tHHz.atmanl.nc** (atmospheric fields) and **gfs.tHHz.sfcanl.nc** (surface fields) files in subdirectory ./gfs.YYYYMMDD/HH/atmos on `NOMADS `_. Initializing global domains with GRIB2 data - some caveats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 6855f7e27339ad5310839085376a44a9a64a64bf Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 17:38:24 +0000 Subject: [PATCH 21/41] Update old links. Fixes #643. --- docs/source/chgres_cube.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 37c19e853..6ffe1fb68 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -254,19 +254,19 @@ Where to find FV3GFS, NAM, HRRR, and RAP GRIB2 data for regional applications **FV3GFS** - * 0.25-degree data (last 10 days only) - Use the **gfs.tHHz.pgrb2.0p25.f000** files in subdirectory gfs.YYYYMMDD/HH `here `_. + * 0.25-degree data (last 10 days only) - Use the **gfs.tHHz.pgrb2.0p25.f000** files in subdirectory ./gfs.YYYYMMDD/HH/atmos on `NOMADS `_. - * 0.5-degree data - Use the **gfs_4_YYYYMMDD_00HH_000.grb2** file, under **GFS Forecasts 004 (0.5-deg)** here: `NCDC - Global Forecast System `__. Note: *Tests were not done with the AVN, MRF or analysis data*. + * 0.5-degree data - Use the **gfs_4_YYYYMMDD_HHHH_000.grb2** file, under **GFS Forecasts 004 (0.5-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. - * 1.0-degree data - Use the **gfs_3_YYYYMMDD_00HH_000.grb2 file**, under **GFS Forecasts 003 (1-deg)** here: `NCDC - Global Forecast System `__. Note: *Tests were not done with the AVN, MRF or analysis data*. + * 1.0-degree data - Use the **gfs_3_YYYYMMDD_HHHH_000.grb2 file**, under **GFS Forecasts 003 (1.0-deg)** here: `NCEI - Global Forecast System `_. Note: *Tests were not done with the AVN, MRF or analysis data*. **NAM** - * 12-km data from last few days (NOMADS) - Use the **nam.tHHz.conusnest.hiresfFH.tmHH.grib2** files in subdirectory nam.YYYYMMDD `here `__. + * 12-km data from last few days (NOMADS) - Use the **nam.tHHz.conusnest.hiresfFH.tmHH.grib2** files in subdirectory nam.YYYYMMDD on `NOMADS `_. - * 12-km data from previous 6 months - Use the **nam_218_YYYYMMDD_00HH_000.grb2 file**, under **NAM Forecasts NAM-NMM 218 (12km) Domain** here: `NCDC - North American Mesoscale Forecast System `__. + * 12-km data from previous 6 months - Use the **nam_218_YYYYMMDD_HHHH_000.grb2 file**, under **NAM Forecasts NAM-NMM 218 (12km) Domain** here: `NCEI - North American Mesoscale Forecast System `_. - * 12-km archived data older than 6 months can be requested through the Archive Information Request System `here `__. + * 12-km archived data prior to 2020 can be requested through the Archive Information Request System `here `__. **HRRR** From f58219af26e5573d0b2146eeef31f682600817fa Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 18:25:26 +0000 Subject: [PATCH 22/41] Update Rap links. Fixes #643. --- docs/source/chgres_cube.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 6ffe1fb68..606dfc828 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -262,15 +262,15 @@ Where to find FV3GFS, NAM, HRRR, and RAP GRIB2 data for regional applications **NAM** - * 12-km data from last few days (NOMADS) - Use the **nam.tHHz.conusnest.hiresfFH.tmHH.grib2** files in subdirectory nam.YYYYMMDD on `NOMADS `_. + * 12-km data from last few days (NOMADS) - Use the **nam.tHHz.conusnest.hiresfHH.tmHH.grib2** files in subdirectory nam.YYYYMMDD on `NOMADS `_. - * 12-km data from previous 6 months - Use the **nam_218_YYYYMMDD_HHHH_000.grb2 file**, under **NAM Forecasts NAM-NMM 218 (12km) Domain** here: `NCEI - North American Mesoscale Forecast System `_. + * 12-km data starting 2020 - Use the **nam_218_YYYYMMDD_HHHH_000.grb2 file**, under **NAM Forecasts NAM-NMM 218 (12km) Domain** here: `NCEI - North American Mesoscale Forecast System `_. - * 12-km archived data prior to 2020 can be requested through the Archive Information Request System `here `__. + * 12-km archived data prior to 2020 can be requested through the Archive Information Request System `here `_. **HRRR** - * 3-km operational data from previous few days (NOMADS) - Use the **hrrr.tHHz.wrfnatfFH.grib2** files in the subdirectory hrrr.YYYYMMDD/conus `here `__. + * 3-km operational data from previous few days (NOMADS) - Use the **hrrr.tHHz.wrfnatfHH.grib2** files in the subdirectory ./hrrr.YYYYMMDD/conus `here `_. * 3-km operational data from 2015 to present (AWS S3): Go `here `__ and click “Browse Bucket.” Type "YYYYMMDD" in to the Search bar. Use the **hrrr.t00z.wrfnatf00.grib2** files in the directory hrrr.YYYYMMDD/conus/. @@ -280,13 +280,11 @@ Where to find FV3GFS, NAM, HRRR, and RAP GRIB2 data for regional applications **RAP** + * 13-km operational data for the previous few days (NOMADS): Use the **rap.tHHz.wrfnatfHH.grib2** files in the subdirectory ./rap.YYYYMMDD `here `_. - * 13-km operational data for the previous few days (NOMADS): Use the **rap.tHHz.wrfnatfFH.grib2** files in the subdirectory rap.YYYYMMDD `here `__. - - * 13-km isobaric level data from previous 6 months : Use the **rap_130_YYYYMMDD_00HH_0FF.grb2** files from the HTTPS option under **RAP Forecasts - RAP 130 (13km) - Domain** at NCEI `here `__. - - * 13-km archived isobaric data older than 6 months can be requested through the Archive Information Request System `here `__. + * 13-km isobaric level data from previous 6 months : Use the **rap_130_YYYYMMDD_HHHH_0FF.grb2** files from **RAP Forecasts - RAP 130 (13km) - Domain** at NCEI `here `_. + * 13-km archived isobaric data older than 6 months can be requested through the Archive Information Request System `here `_. Initializing regional domains with GRIB2 data - some caveats From 76b327657156657c7542e77511130f72d3a2098a Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 20:04:15 +0000 Subject: [PATCH 23/41] Updates to orog_gsl. Fixes #643. --- docs/source/ufs_utils.rst | 41 ++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 188231af1..f2c48fe03 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -16,7 +16,8 @@ The following programs are used to create a grid. * make_hgrid * regional_grid_esg * make_solo_mosaic - * orog or orog_gsl + * orog + * orog_gsl * inland (optional) * lakefrac (optional) * global_equiv_resol @@ -28,8 +29,8 @@ The grid generation process is run by these scripts (located under ./ush) * fv3gfs_grid_driver.sh (driver script) * fv3gfs_make_grid.sh (creates the geo-referencing for the grid) - * fv3gfs_make_orog.sh (creates the land-sea mask, terrain and gravity wave drag fields) - * fv3gfs_make_orog_gsl.sh (creates the land-sea mask, terrain and GSL gravity wave drag fields) + * fv3gfs_make_orog.sh (creates the land-sea mask, terrain and EMC gravity wave drag fields) + * fv3gfs_make_orog_gsl.sh (creates GSL gravity wave drag fields) * fv3gfs_make_lake.sh (adds lakes and lake depth. optional) * fv3gfs_filter_topo.sh (filters the orography) * sfc_climo_gen.sh (creates climatological surface fields, such as soil type) @@ -268,18 +269,7 @@ orog_gsl Introduction ------------ -This program computes orographics statistics fields required for the orographic drag suite developed by NOAA's Global Systems Laboratory (GSL). The fields are a subset of the ones calculated by "orog" except that they are calculated in a different manner. The fields are: - - * stddev - Standard deviation of subgrid topography - * convexity - Convexity of subgrid topography - * oa1 - Orographic asymmetry of subgrid topography - westerly - * oa2 - Orographic asymmetry of subgrid topography - southerly - * oa3 - Orographic asymmetry of subgrid topography - southwesterly - * oa4 - Orographic asymmetry of subgrid topography - northwesterly - * ol1 - Orographic effective length of subgrid topography - westerly - * ol2 - Orographic effective length of subgrid topography - southerly - * ol3 - Orographic effective length of subgrid topography - southwesterly - * ol4 - Orographic effective length of subgrid topography - northwesterly +This program computes orographics statistics fields required for the orographic drag suite developed by NOAA's Global Systems Laboratory (GSL). The fields are a subset of the ones calculated by "orog" and are calculated in a different manner. Code structure -------------- @@ -303,7 +293,22 @@ All in NetCDF. One for each tile. All in NetCDF. * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of Kim and Doyle (2005) (https://doi.org/10.1256/qj.04.160) - * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave dray scheme of Tsiringakis et al. (2017) (https://doi.org/10.1002/qj.3021). And the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). + * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave drag scheme of Tsiringakis et al. (2017) (https://doi.org/10.1002/qj.3021). And the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). + +Each file contains the following records: + + * geolon - longitude (degrees east) + * geolat - latitude (degrees north) + * stddev - Standard deviation of subgrid topography + * convexity - Convexity of subgrid topography + * oa1 - Orographic asymmetry of subgrid topography - westerly + * oa2 - Orographic asymmetry of subgrid topography - southerly + * oa3 - Orographic asymmetry of subgrid topography - southwesterly + * oa4 - Orographic asymmetry of subgrid topography - northwesterly + * ol1 - Orographic effective length of subgrid topography - westerly + * ol2 - Orographic effective length of subgrid topography - southerly + * ol3 - Orographic effective length of subgrid topography - southwesterly + * ol4 - Orographic effective length of subgrid topography - northwesterly inland ====== @@ -332,11 +337,11 @@ Program inputs and outputs **Input data:** - * orography file - the orography file from the orog or orog_gsl programs - oro.CRES.tile#.nc (NetCDF) + * orography file - The orography file from the orog program - oro.CRES.tile#.nc (NetCDF) **Output data:** - * orography file - The input file, but containing an 'inland' record - '1' inland, '0' coastal. + * orography file - The input file, but containing an additional 'inland' record - '1' inland, '0' coastal. lakefrac ======== From 26d0a0f6a38ef93552e244c205f5a49d4607e4dc Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 22 Apr 2022 20:21:26 +0000 Subject: [PATCH 24/41] Fix links. Fixes #643. --- docs/source/ufs_utils.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index f2c48fe03..46e806cbe 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -292,8 +292,8 @@ All in NetCDF. One for each tile. All in NetCDF. - * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of Kim and Doyle (2005) (https://doi.org/10.1256/qj.04.160) - * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave drag scheme of Tsiringakis et al. (2017) (https://doi.org/10.1002/qj.3021). And the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). + * CRES_oro_data_ls.tile#.nc - Large-scale file for the gravity wave drag and blocking schemes of `Kim and Doyle (2005) `_ + * CRES_oro_data.ss.tile#.nc - Small-scale file for the gravity wave drag scheme of `Tsiringakis et al. (2017) `_. And the turbulent orographic from drag (TOFD) schemem of Beljaars et al. (QJRMS, 2004). Each file contains the following records: From 5558d70acebef7991ac39a6e93cd678faabfa812 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 28 Apr 2022 19:41:41 +0000 Subject: [PATCH 25/41] Update links. Fixes #643. --- docs/source/chgres_cube.rst | 4 ++-- docs/source/ufs_utils.rst | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 606dfc828..eeeac815c 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -84,7 +84,7 @@ Users may create their own global grids, or use the pre-defined files are locate * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. `Located here. `_ + * FV3 vertical coordinate file. Text file. `Located here. `_ * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. @@ -236,7 +236,7 @@ The following four sets of files/directories should all be located in the same d * CRES.vegetation_greenness.tile7.halo4.nc (vegetation greenness) * CRES.vegetation_type.tile7.halo4.nc (vegetation type) - * FV3 vertical coordinate file. Text file. Located in `./fix_am `_ directory. + * FV3 vertical coordinate file. Text file. Located in `./fix_am `_ directory. * global_hyblev.l$LEVS.txt * Input data files. GRIB2 only. See the next section for how to find this data. diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 46e806cbe..ad81097d4 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -238,11 +238,11 @@ Program inputs and outputs * The "grid" files (CRES_grid.tile#.nc) containing the geo-reference records for the grid - (NetCDF). Created by the make_hgrid or regional_esg_grid programs. * Global 30-arc-second University of Maryland land cover data. Used to create the land-sea mask. - * landcover30.fixed (unformatted binary). Located in `./fix/fix_orog `_. + * landcover30.fixed (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. * Global 30-arc-second USGS GMTED2010 orography data. - * gmted2010.30sec.int (unformatted binary). Located in `./fix/fix_orog `_. + * gmted2010.30sec.int (unformatted binary). Located in `./fix/fix_orog `_. * 30-arc-second RAMP Antarctic terrain data (Radarsat Antarctic Mapping Project) - * thirty.second.antarctic.new.bin (unformatted binary). Located in `./fix/fix_orog `_. + * thirty.second.antarctic.new.bin (unformatted binary). Located in `./fix/fix_orog `_. **Output data:** @@ -372,8 +372,8 @@ Program inputs and outputs * grid file - the "grid" file from the make_hgrid or regional_esg programs - CRES_grid.tile#.nc - (NetCDF) * orography file - the orography file including the 'inland' flag record from the inland program - oro.CRES.tile#.nc (NetCDF) - * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_). See GlobalLakeStatus.txt for the defintion of each code. - * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_). See GlobalLakeDepth.txt for a description of this file. + * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_). See GlobalLakeStatus.txt for the defintion of each code. + * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_). See GlobalLakeDepth.txt for a description of this file. **Output data:** @@ -516,7 +516,7 @@ Program inputs and outputs **Input data:** -The surface climatological data is located in `./fix/fix_sfc_climo `_. All NetCDF. +The surface climatological data is located in `./fix/fix_sfc_climo `_. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc From 54f78980afcc2472c8a2f06453645224ffa447ad Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 28 Apr 2022 19:59:14 +0000 Subject: [PATCH 26/41] More link updates. Fixes #643. --- docs/source/ufs_utils.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index ad81097d4..f170b5ff6 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -240,9 +240,9 @@ Program inputs and outputs * Global 30-arc-second University of Maryland land cover data. Used to create the land-sea mask. * landcover30.fixed (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. * Global 30-arc-second USGS GMTED2010 orography data. - * gmted2010.30sec.int (unformatted binary). Located in `./fix/fix_orog `_. + * gmted2010.30sec.int (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_.. * 30-arc-second RAMP Antarctic terrain data (Radarsat Antarctic Mapping Project) - * thirty.second.antarctic.new.bin (unformatted binary). Located in `./fix/fix_orog `_. + * thirty.second.antarctic.new.bin (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. **Output data:** @@ -372,8 +372,8 @@ Program inputs and outputs * grid file - the "grid" file from the make_hgrid or regional_esg programs - CRES_grid.tile#.nc - (NetCDF) * orography file - the orography file including the 'inland' flag record from the inland program - oro.CRES.tile#.nc (NetCDF) - * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_). See GlobalLakeStatus.txt for the defintion of each code. - * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_). See GlobalLakeDepth.txt for a description of this file. + * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_ or at `AWS `_). See GlobalLakeStatus.txt for the defintion of each code. + * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_ or at `AWS `_). See GlobalLakeDepth.txt for a description of this file. **Output data:** @@ -516,7 +516,7 @@ Program inputs and outputs **Input data:** -The surface climatological data is located in `./fix/fix_sfc_climo `_. All NetCDF. +The surface climatological data is located here `./fix/fix_sfc_climo `_ or at `AWS `_. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc From 75a7798972e20e6dfb95d3ecc477f45c6c455e3c Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 28 Apr 2022 20:20:58 +0000 Subject: [PATCH 27/41] More link updates. Fixes #643. --- docs/source/chgres_cube.rst | 4 ++-- docs/source/ufs_utils.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index eeeac815c..4f0d81a03 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -84,7 +84,7 @@ Users may create their own global grids, or use the pre-defined files are locate * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. `Located here. `_ + * FV3 vertical coordinate file. Text file. `Located here. `_ or at `AWS `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. @@ -236,7 +236,7 @@ The following four sets of files/directories should all be located in the same d * CRES.vegetation_greenness.tile7.halo4.nc (vegetation greenness) * CRES.vegetation_type.tile7.halo4.nc (vegetation type) - * FV3 vertical coordinate file. Text file. Located in `./fix_am `_ directory. + * FV3 vertical coordinate file. Text file. Located here `./fix_am `_ or at `AWS `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2 only. See the next section for how to find this data. diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index f170b5ff6..afd6ae48e 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -240,7 +240,7 @@ Program inputs and outputs * Global 30-arc-second University of Maryland land cover data. Used to create the land-sea mask. * landcover30.fixed (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. * Global 30-arc-second USGS GMTED2010 orography data. - * gmted2010.30sec.int (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_.. + * gmted2010.30sec.int (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. * 30-arc-second RAMP Antarctic terrain data (Radarsat Antarctic Mapping Project) * thirty.second.antarctic.new.bin (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. From 8d4ff16a3fefbd95a9cb019610d9991c736f6c87 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Thu, 28 Apr 2022 20:27:38 +0000 Subject: [PATCH 28/41] Minor fix. Fixes #643. --- docs/source/chgres_cube.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 4f0d81a03..4babee5c7 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -84,7 +84,7 @@ Users may create their own global grids, or use the pre-defined files are locate * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. `Located here. `_ or at `AWS `_. + * FV3 vertical coordinate file. Text file. `Located here `_ or at `AWS `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. From 1bb4e8b06ca8d3395882b4af72ccb988231c1294 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 29 Apr 2022 14:58:52 +0000 Subject: [PATCH 29/41] Update orog_gsl documentation. Fixes #643. --- docs/source/ufs_utils.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index afd6ae48e..443e602d1 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -285,8 +285,9 @@ The program reads the tile number (1-6 for global, 7 for stand-alone regional) a All in NetCDF. - * geo_em.d01.lat-lon.2.5m.HGT_M.nc - global topographic data on 2.5-minute lat-lon grid (interpolated from GMTED2010 30-second topographic data). - * HGT.Beljaars_filtered.lat-lon.30s_res.nc - global topographic data on 30-second lat-lon grid (GMTED2010 data smoothed according to Beljaars et al. (QJRMS, 2004)) + * The tiled "grid" files (CRES_grid.tile#.nc) created by the make_hgrid or regional_esg_grid programs - (NetCDF) + * geo_em.d01.lat-lon.2.5m.HGT_M.nc - global topographic data on 2.5-minute lat-lon grid (interpolated from GMTED2010 30-second topographic data). `Located here `_ or at `AWS `_. + * HGT.Beljaars_filtered.lat-lon.30s_res.nc - global topographic data on 30-second lat-lon grid (GMTED2010 data smoothed according to Beljaars et al. (QJRMS, 2004)). `Located here `_ or at `AWS `_. **Output data:** From fececea5896e27509b1307336d3b3463a3528d9c Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 29 Apr 2022 15:03:06 +0000 Subject: [PATCH 30/41] Minor fix. Fixes #643. --- docs/source/ufs_utils.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 443e602d1..3a87be963 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -285,7 +285,7 @@ The program reads the tile number (1-6 for global, 7 for stand-alone regional) a All in NetCDF. - * The tiled "grid" files (CRES_grid.tile#.nc) created by the make_hgrid or regional_esg_grid programs - (NetCDF) + * The tiled "grid" files (CRES_grid.tile#.nc) created by the make_hgrid or regional_esg_grid programs. * geo_em.d01.lat-lon.2.5m.HGT_M.nc - global topographic data on 2.5-minute lat-lon grid (interpolated from GMTED2010 30-second topographic data). `Located here `_ or at `AWS `_. * HGT.Beljaars_filtered.lat-lon.30s_res.nc - global topographic data on 30-second lat-lon grid (GMTED2010 data smoothed according to Beljaars et al. (QJRMS, 2004)). `Located here `_ or at `AWS `_. From b43b1851375965a3d08679370253e50ad39e0a43 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 29 Apr 2022 15:24:43 +0000 Subject: [PATCH 31/41] Minor update. Fixes #643. --- docs/source/ufs_utils.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 3a87be963..17ea3443d 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -17,7 +17,7 @@ The following programs are used to create a grid. * regional_grid_esg * make_solo_mosaic * orog - * orog_gsl + * orog_gsl (optional) * inland (optional) * lakefrac (optional) * global_equiv_resol From 380e85ca7dbf582c0d473ebf3fe9c828b9c92afd Mon Sep 17 00:00:00 2001 From: jeff beck Date: Fri, 27 May 2022 19:04:51 +0000 Subject: [PATCH 32/41] Documentation updates for varmap and chgres_cube namelist changes --- docs/source/chgres_cube.rst | 4 +++- parm/varmap_tables/README | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 4babee5c7..133364b11 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -343,6 +343,8 @@ Namelist variables with “input” in their name refer to data input to chgres_ * tg3_from_soil - Use tg3 from input soil. Valid options: .true. or .false. . Default: .false. * thomp_mp_climo_file - Location of Thompson aerosol climatology file. Provide only if you wish to use these aerosol variables. * wam_cold_start - Cold start for the Whole Atmosphere Model. Valid Options: .true. or .false. (Default: .false.) + * use_rh - Use relative humidity instead of specific humidity when reading in grib2 files (Default: .false.) + * calrh - Type of relative humidity to specific humidity calculation to use (Default: 0; use existing calculation, or 1; use calculation consistent with GFSv15/v16) Variable Mapping (VARMAP) table ------------------------------- @@ -381,7 +383,7 @@ Column 2: Name of the variable in the output “coldstart” files. Unimplemente Column 3: Behavior when the code can't find the variable in the input file. Options are: * "skip": Don't write to the output file. - * "intrp": LnP interpolation to missing levels. No extrapolation allowd. + * "intrp": Ln(pressure) interpolation to missing levels. Extrapolation is allowed, but should be used with caution. * "set_to_fill": Set to user-specified field value (see column 4). * "stop": Force an exception and stop code execution. Use this if you absolutely require a field to be present. diff --git a/parm/varmap_tables/README b/parm/varmap_tables/README index 1bfbd10b8..cf137b06e 100644 --- a/parm/varmap_tables/README +++ b/parm/varmap_tables/README @@ -14,7 +14,8 @@ Column 2: Name the code will use to save the variable in the output file. Unimpl Comumn 3: Behavior when the code can't find the variable in the input file. Options are: "skip": Don't write to output file. "set_to_fill": Set to user-specified field value (see column 4). - "intrp": LnP interpolation to missing levels. No extrapolation allowd. + "intrp": Ln(pressure) interpolation to missing levels. Extrapolation is allowed, + but should be used with caution. "stop": Force an exception and stop code execution. Use this if you absolutely require a field to be present. Column 4: If column 3 = "set_to_fill", then this value is used to fill in all points From 0924001e535deae3491b3eeb52f92df58c39cd9b Mon Sep 17 00:00:00 2001 From: jeff beck Date: Fri, 27 May 2022 19:14:28 +0000 Subject: [PATCH 33/41] Minor wording fix. --- docs/source/chgres_cube.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 133364b11..3e2b12b4b 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -343,7 +343,7 @@ Namelist variables with “input” in their name refer to data input to chgres_ * tg3_from_soil - Use tg3 from input soil. Valid options: .true. or .false. . Default: .false. * thomp_mp_climo_file - Location of Thompson aerosol climatology file. Provide only if you wish to use these aerosol variables. * wam_cold_start - Cold start for the Whole Atmosphere Model. Valid Options: .true. or .false. (Default: .false.) - * use_rh - Use relative humidity instead of specific humidity when reading in grib2 files (Default: .false.) + * use_rh - Use relative humidity instead of specific humidity when reading in external model grib2 files (Default: .false.) * calrh - Type of relative humidity to specific humidity calculation to use (Default: 0; use existing calculation, or 1; use calculation consistent with GFSv15/v16) Variable Mapping (VARMAP) table From ebd8bb12b6b63983af1795b20202367ffd1850da Mon Sep 17 00:00:00 2001 From: jeff beck Date: Wed, 1 Jun 2022 04:55:50 +0000 Subject: [PATCH 34/41] Update description of "intrp" namelist option based on Jili's input. --- docs/source/chgres_cube.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 3e2b12b4b..7020246ca 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -383,7 +383,7 @@ Column 2: Name of the variable in the output “coldstart” files. Unimplemente Column 3: Behavior when the code can't find the variable in the input file. Options are: * "skip": Don't write to the output file. - * "intrp": Ln(pressure) interpolation to missing levels. Extrapolation is allowed, but should be used with caution. + * "intrp": Ln(pressure) interpolation to missing levels. Linear interpolation and extrapolation are possible, but require modifying the value of "LINLOG" in input_data.F90 to anything other than 2, and to a negative number, respectively. * "set_to_fill": Set to user-specified field value (see column 4). * "stop": Force an exception and stop code execution. Use this if you absolutely require a field to be present. From 542bc345bd947e1fdb5af786fc29418866e2ca7d Mon Sep 17 00:00:00 2001 From: jeff beck Date: Wed, 1 Jun 2022 04:59:38 +0000 Subject: [PATCH 35/41] Update description of "intrp" namelist option based on Jili's input. --- parm/varmap_tables/README | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/parm/varmap_tables/README b/parm/varmap_tables/README index cf137b06e..c72aaf778 100644 --- a/parm/varmap_tables/README +++ b/parm/varmap_tables/README @@ -14,8 +14,10 @@ Column 2: Name the code will use to save the variable in the output file. Unimpl Comumn 3: Behavior when the code can't find the variable in the input file. Options are: "skip": Don't write to output file. "set_to_fill": Set to user-specified field value (see column 4). - "intrp": Ln(pressure) interpolation to missing levels. Extrapolation is allowed, - but should be used with caution. + "intrp": Ln(pressure) interpolation to missing levels. Linear interpolation and + extrapolation are possible, but require modifying the value of "LINLOG" + in input_data.F90 to anything other than 2, and to a negative number, + respectively. "stop": Force an exception and stop code execution. Use this if you absolutely require a field to be present. Column 4: If column 3 = "set_to_fill", then this value is used to fill in all points From 0e1e06e2c095634c4a5299dc1133ed7ce9beef5e Mon Sep 17 00:00:00 2001 From: jeff beck Date: Wed, 1 Jun 2022 05:01:23 +0000 Subject: [PATCH 36/41] Minor change to text. --- docs/source/chgres_cube.rst | 2 +- parm/varmap_tables/README | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 7020246ca..1a5f5c97e 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -383,7 +383,7 @@ Column 2: Name of the variable in the output “coldstart” files. Unimplemente Column 3: Behavior when the code can't find the variable in the input file. Options are: * "skip": Don't write to the output file. - * "intrp": Ln(pressure) interpolation to missing levels. Linear interpolation and extrapolation are possible, but require modifying the value of "LINLOG" in input_data.F90 to anything other than 2, and to a negative number, respectively. + * "intrp": Ln(pressure) interpolation to missing levels. Linear interpolation and extrapolation are possible, but require modifying the value of "LINLOG" in input_data.F90 to anything other than 2, or to a negative number, respectively. * "set_to_fill": Set to user-specified field value (see column 4). * "stop": Force an exception and stop code execution. Use this if you absolutely require a field to be present. diff --git a/parm/varmap_tables/README b/parm/varmap_tables/README index c72aaf778..31af3c463 100644 --- a/parm/varmap_tables/README +++ b/parm/varmap_tables/README @@ -16,7 +16,7 @@ Comumn 3: Behavior when the code can't find the variable in the input file. Opti "set_to_fill": Set to user-specified field value (see column 4). "intrp": Ln(pressure) interpolation to missing levels. Linear interpolation and extrapolation are possible, but require modifying the value of "LINLOG" - in input_data.F90 to anything other than 2, and to a negative number, + in input_data.F90 to anything other than 2, or to a negative number, respectively. "stop": Force an exception and stop code execution. Use this if you absolutely require a field to be present. From bbc6b57d68126cfa350d061309535ce7e91f7678 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 1 Jun 2022 13:42:55 +0000 Subject: [PATCH 37/41] Updates for v1.7.0 release. Fixes #643. --- VERSION | 2 +- docs/user_guide.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/VERSION b/VERSION index dc1e644a1..bd8bf882d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.6.0 +1.7.0 diff --git a/docs/user_guide.md b/docs/user_guide.md index 7e91938fe..1c1ec51f4 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -10,6 +10,7 @@ https://github.com/ufs-community/UFS_UTILS. ## Documentation for Previous Versions of UFS_UTILS +* [UFS_UTILS Version 1.7.0](ver-1.7.0/index.html) * [UFS_UTILS Version 1.6.0](ver-1.6.0/index.html) * [UFS_UTILS Version 1.5.0](ver-1.5.0/index.html) * [UFS_UTILS Version 1.4.0](ver-1.4.0/index.html) From 55ed539f03f82f8d2e3477ed32b522cb11ff8459 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 1 Jun 2022 14:27:55 +0000 Subject: [PATCH 38/41] Update links in documentation. Fixes #643. --- docs/source/chgres_cube.rst | 4 ++-- docs/source/ufs_utils.rst | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 1a5f5c97e..bf1614355 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -84,7 +84,7 @@ Users may create their own global grids, or use the pre-defined files are locate * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. `Located here `_ or at `AWS `_. + * FV3 vertical coordinate file. Text file. `Located here `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. @@ -236,7 +236,7 @@ The following four sets of files/directories should all be located in the same d * CRES.vegetation_greenness.tile7.halo4.nc (vegetation greenness) * CRES.vegetation_type.tile7.halo4.nc (vegetation type) - * FV3 vertical coordinate file. Text file. Located here `./fix_am `_ or at `AWS `_. + * FV3 vertical coordinate file. Text file. Located here `./fix_am `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2 only. See the next section for how to find this data. diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index 17ea3443d..a52fddd72 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -238,11 +238,11 @@ Program inputs and outputs * The "grid" files (CRES_grid.tile#.nc) containing the geo-reference records for the grid - (NetCDF). Created by the make_hgrid or regional_esg_grid programs. * Global 30-arc-second University of Maryland land cover data. Used to create the land-sea mask. - * landcover30.fixed (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. + * landcover30.fixed (unformatted binary). Located here `./fix/fix_orog `_. * Global 30-arc-second USGS GMTED2010 orography data. - * gmted2010.30sec.int (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. + * gmted2010.30sec.int (unformatted binary). Located here `./fix/fix_orog `_. * 30-arc-second RAMP Antarctic terrain data (Radarsat Antarctic Mapping Project) - * thirty.second.antarctic.new.bin (unformatted binary). Located here `./fix/fix_orog `_ or at `AWS `_. + * thirty.second.antarctic.new.bin (unformatted binary). Located here `./fix/fix_orog `_. **Output data:** @@ -286,8 +286,8 @@ The program reads the tile number (1-6 for global, 7 for stand-alone regional) a All in NetCDF. * The tiled "grid" files (CRES_grid.tile#.nc) created by the make_hgrid or regional_esg_grid programs. - * geo_em.d01.lat-lon.2.5m.HGT_M.nc - global topographic data on 2.5-minute lat-lon grid (interpolated from GMTED2010 30-second topographic data). `Located here `_ or at `AWS `_. - * HGT.Beljaars_filtered.lat-lon.30s_res.nc - global topographic data on 30-second lat-lon grid (GMTED2010 data smoothed according to Beljaars et al. (QJRMS, 2004)). `Located here `_ or at `AWS `_. + * geo_em.d01.lat-lon.2.5m.HGT_M.nc - global topographic data on 2.5-minute lat-lon grid (interpolated from GMTED2010 30-second topographic data). `Located here `_. + * HGT.Beljaars_filtered.lat-lon.30s_res.nc - global topographic data on 30-second lat-lon grid (GMTED2010 data smoothed according to Beljaars et al. (QJRMS, 2004)). `Located here `_. **Output data:** @@ -373,8 +373,8 @@ Program inputs and outputs * grid file - the "grid" file from the make_hgrid or regional_esg programs - CRES_grid.tile#.nc - (NetCDF) * orography file - the orography file including the 'inland' flag record from the inland program - oro.CRES.tile#.nc (NetCDF) - * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_ or at `AWS `_). See GlobalLakeStatus.txt for the defintion of each code. - * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_ or at `AWS `_). See GlobalLakeDepth.txt for a description of this file. + * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog _). See GlobalLakeStatus.txt for the defintion of each code. + * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_). See GlobalLakeDepth.txt for a description of this file. **Output data:** @@ -517,7 +517,7 @@ Program inputs and outputs **Input data:** -The surface climatological data is located here `./fix/fix_sfc_climo `_ or at `AWS `_. All NetCDF. +The surface climatological data is located here `./fix/fix_sfc_climo `_. All NetCDF. * Global 1-degree fractional coverage strong/weak zenith angle albedo - facsf.1.0.nc * Global 0.05-degree maximum snow albedo - maximum_snow_albedo.0.05.nc From 47fe749d7659eb7adad7e7dacf771b43de3dd856 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 1 Jun 2022 14:37:44 +0000 Subject: [PATCH 39/41] Fix link Fixes #643. --- docs/source/chgres_cube.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index bf1614355..37eb0fb04 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -84,7 +84,7 @@ Users may create their own global grids, or use the pre-defined files are locate * CRES.vegetation_greenness.tileX.nc (vegetation greenness) * CRES.vegetation_type.tileX.nc (vegetation type) - * FV3 vertical coordinate file. Text file. `Located here `_. + * FV3 vertical coordinate file. Text file. `Located here `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2, NEMSIO or NetCDF. See the next section for how to find this data. From 1e3dae1979d638e2f6d550949c4cb9fd7ac0770a Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 1 Jun 2022 17:15:55 +0000 Subject: [PATCH 40/41] Update link Fixes #643. --- docs/source/chgres_cube.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst index 37eb0fb04..a6e2cbb38 100644 --- a/docs/source/chgres_cube.rst +++ b/docs/source/chgres_cube.rst @@ -236,7 +236,7 @@ The following four sets of files/directories should all be located in the same d * CRES.vegetation_greenness.tile7.halo4.nc (vegetation greenness) * CRES.vegetation_type.tile7.halo4.nc (vegetation type) - * FV3 vertical coordinate file. Text file. Located here `./fix_am `_. + * FV3 vertical coordinate file. Text file. `Located here `_. * global_hyblev.l$LEVS.txt * Input data files. GRIB2 only. See the next section for how to find this data. From ec801f39d8d41fd74e4a5d6f0074a09125654d1f Mon Sep 17 00:00:00 2001 From: George Gayno Date: Wed, 1 Jun 2022 17:36:40 +0000 Subject: [PATCH 41/41] Fix typo. Fixes #643. --- docs/source/ufs_utils.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst index a52fddd72..7255dc6d1 100644 --- a/docs/source/ufs_utils.rst +++ b/docs/source/ufs_utils.rst @@ -14,7 +14,7 @@ Grid Generation The following programs are used to create a grid. * make_hgrid - * regional_grid_esg + * regional_esg_grid * make_solo_mosaic * orog * orog_gsl (optional) @@ -373,7 +373,7 @@ Program inputs and outputs * grid file - the "grid" file from the make_hgrid or regional_esg programs - CRES_grid.tile#.nc - (NetCDF) * orography file - the orography file including the 'inland' flag record from the inland program - oro.CRES.tile#.nc (NetCDF) - * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog _). See GlobalLakeStatus.txt for the defintion of each code. + * lake status code file - GlobalLakeStatus.dat (located in `./fix/fix_orog `_). See GlobalLakeStatus.txt for the defintion of each code. * lake depth file - GlobalLakeDepth.dat (located in `./fix/fix_orog `_). See GlobalLakeDepth.txt for a description of this file. **Output data:**