From 9c229344ad1e52359a8578ab6aa98709512a391c Mon Sep 17 00:00:00 2001 From: amazroo Date: Wed, 13 Nov 2024 11:24:08 -0700 Subject: [PATCH 1/3] Review and Edit documentation on model-inputs-preprocess --- docs/userguide/model-inputs-preproc.rest | 56 +++++++++++++----------- 1 file changed, 30 insertions(+), 26 deletions(-) diff --git a/docs/userguide/model-inputs-preproc.rest b/docs/userguide/model-inputs-preproc.rest index 3392f31df..98789fc4c 100644 --- a/docs/userguide/model-inputs-preproc.rest +++ b/docs/userguide/model-inputs-preproc.rest @@ -30,7 +30,7 @@ physics components may require different parameter and input files. While some parameter files and templates are included with the model source code, most must be generated by the user. We provide a number of scripts and preprocessing utilities on the WRF-Hydro website -(https://ral.ucar.edu/projects/wrf_hydro) in order to aid in this +(https://ral.ucar.edu/projects/wrf_hydro/pre-processing-tools) in order to aid in this process. These include NCAR Command Language (NCL) scripts to regrid forcing data from commonly used data sources, R scripts to generate parameter and model initialization files, and a set of Python based @@ -78,8 +78,9 @@ initial condition files. The data required to define the domain and geospatial attributes of a spatially-distributed, or gridded, 1-dimensional (vertical) land surface model (LSM) are specified in a geogrid (:file:`geo_em.d0{x}.nc`) netCDF file. -This file is generated by the :program:`GEOGRID` utility in the WRF preprocessing -system (WPS). WPS is a preprocessing system that prepares both land surface and +This file is generated by the :program:`GEOGRID` utility in the `WRF preprocessing system (WPS) +`_. +WPS is a preprocessing system that prepares both land surface and atmospheric data for use in the model. The GEOGRID component of WPS automates the procedure of defining in space, georeferencing and attributing most of the land surface parameter data required to execute @@ -98,16 +99,17 @@ preprocessing utilities. Initial conditions for the land surface, such as soil moisture, soil temperature, and snow states, are prescribed via the :file:`wrfinput_d0x.nc` file. This netCDF file can be generated one of two ways, through the -:program:`real.exe` program within WRF or via an R script (:file:`create_Wrfinput.R`) -distributed on the WRF-Hydro website. When created using the real.exe -program in WRF, initial conditions are pulled from existing reanalysis +:program:`real.exe` program within WRF or via an R script (:file:`create_wrfinput.R`) +distributed on the `WRF-Hydro website `_. +When created using the real.exeprogram in WRF, +initial conditions are pulled from existing reanalysis or realtime products (see WRF documentation for data and system requirements). This will typically result in more realistic initial model states. However, the process is somewhat involved and requires the user to obtain additional external datasets. -The R script will create a simplified version of the wrfinput -(:file:`wrfinput_d0x.nc`)file including all necessary fields for the +The R script will create a simplified version of the :file:`wrfinput_d0x.nc` +file including all necessary fields for the Noah-MP land surface model, but with spatially uniform initial conditions that are prescribed within the script and requires only the geogrid file :file:`geo_em.d0{x}.nc` as input. Step-wise instructions and detailed @@ -129,23 +131,24 @@ output files and relevant shapefiles to aid in visualizing the model components. The WRF-Hydro GIS pre-processing tools are developed to function as an additional ArcToolbox within the Esri ArcGIS software. Specific operating system and software requirements are addressed in the -full *WRF-Hydro GIS Pre-processing Toolkit* documentation. +full *WRF-Hydro GIS Pre-processing Toolkit* `documentation +`_. The minimum input data requirements for the pre-processing tools are the -geogrid file geo_em.d0x.nc and a hydrologically conditioned digital +geogrid file :file:`geo_em.d0x.nc` and a hydrologically conditioned digital elevation model covering the full extent of the domain of interest. From -these datasets the terrain routing Fulldom_hires.nc and channel routing -files (see Appendix :ref:`A9 ` can be created. A text file -with stream gage locations can also be supplied allowing the user to -demarcate these locations in the model input files and optionally produce -time series outputs for only these locations :file:`frxst_pts_out.txt` or -:file:`*CHANOBS_DOMAIN{x}`. - -This text file denoting the location of stream gages or forecast points +these datasets the terrain routing files (e.g. :file:`Fulldom_hires.nc`, :file:`hydro2dtbl.nc`) +and channel routing files (e.g. :file:`Route_Link.nc`) can be created (see Appendix :ref:`A9 `). + +A :file:`.txt` or :file:`.csv` file with stream gage locations can optionally +be supplied, allowing the user to demarcate these locations in the model input files +and optionally produce time series outputs (e.g. :file:`*CHANOBS_DOMAIN{x}`) for only these locations. +This text file denoting the location of stream gages or "forecast points" can also be used to generate groundwater input files. Effectively groundwater basins are delineated above each of these locations and default parameters will be assigned to a parameter file that can also be -generated using this tool. +generated using this tool. More details are available in the *WRF-Hydro GIS Pre-processing Toolkit* `documentation +`_. Lake and reservoir component input files also require a supplementary input file. A shapefile containing polygons defining the extent of each @@ -154,11 +157,12 @@ elevation model a number of parameters are derived for each lake (however, note that other parameters are only assigned a global default value). More details about this process and the contents of the input and parameter files can be found in Appendix :ref:`A12 ` -and the full *WRF-Hydro GIS Pre-processing Toolkit* documentation. +and the full *WRF-Hydro GIS Pre-processing Toolkit* `documentation +`_. -The *WRF-Hydro GIS Preprocessing Toolkit* will also produce a geospatial -metadata file for the land surface model grid (as defined by the geogrid -file), :file:`GEOGRID_LDASOUT_Spatial_Metadata.nc`. This file contains +The *WRF-Hydro GIS Pre-processing Toolkit* will also produce a geospatial +metadata file (e.g. :file:`GEOGRID_LDASOUT_Spatial_Metadata.nc`) for the land surface +model grid (as defined by the geogrid file :file:`geo_em.d0{x}.nc`). This file contains projection and coordinate information for the land surface model grid. While this file is an optional input to WRF-Hydro, in combination with the new file output routines in version 5.0 of WRF-Hydro this file will @@ -236,8 +240,8 @@ are described in the model physics :ref:`Section | | category | | | +---------------------------+---------------------+----------------------------------+--------------+ | :file:`HYDRO_MODIS.TBL` | Version of | :file:`template/HYDRO` | Replacement | - | | :file:`HYDRO.TBL` | directory in the | for :file:\ | - | | using MODIS land | model code | `HYDRO.TBL` | + | | :file:`HYDRO.TBL` | directory in the | for | + | | using MODIS land | model code | |HYDRO.TBL| | | | use categories | | when using | | | rather than USGS. | | MODIS land | | | (Change name to | | use | @@ -257,7 +261,7 @@ are described in the model physics :ref:`Section | | to catchment | | mapping | | | objects | | | +---------------------------+---------------------+----------------------------------+--------------+ - +.. |HYDRO.TBL| replace:: :file:`HYDRO.TBL` .. _section-5.3: 5.3 Description of land surface model and lateral routing parameter files From 328f09f0f7debfd9bb913dd1b1b8eeac30a047b7 Mon Sep 17 00:00:00 2001 From: amazroo Date: Fri, 6 Dec 2024 12:34:18 -0700 Subject: [PATCH 2/3] Review and Edit documentation on model-inputs-preprocess --- docs/userguide/model-inputs-preproc.rest | 129 ++++++++++++----------- 1 file changed, 65 insertions(+), 64 deletions(-) diff --git a/docs/userguide/model-inputs-preproc.rest b/docs/userguide/model-inputs-preproc.rest index 98789fc4c..49518cc29 100644 --- a/docs/userguide/model-inputs-preproc.rest +++ b/docs/userguide/model-inputs-preproc.rest @@ -140,7 +140,7 @@ elevation model covering the full extent of the domain of interest. From these datasets the terrain routing files (e.g. :file:`Fulldom_hires.nc`, :file:`hydro2dtbl.nc`) and channel routing files (e.g. :file:`Route_Link.nc`) can be created (see Appendix :ref:`A9 `). -A :file:`.txt` or :file:`.csv` file with stream gage locations can optionally +A ``.txt`` or ``.csv`` file with stream gage locations can optionally be supplied, allowing the user to demarcate these locations in the model input files and optionally produce time series outputs (e.g. :file:`*CHANOBS_DOMAIN{x}`) for only these locations. This text file denoting the location of stream gages or "forecast points" @@ -262,6 +262,7 @@ are described in the model physics :ref:`Section | | objects | | | +---------------------------+---------------------+----------------------------------+--------------+ .. |HYDRO.TBL| replace:: :file:`HYDRO.TBL` + .. _section-5.3: 5.3 Description of land surface model and lateral routing parameter files @@ -269,7 +270,7 @@ are described in the model physics :ref:`Section Parameters for the Noah and Noah-MP land surface models as well as for the lateral routing component are specified via a collection of text -files (i.e. parameter tables) denoted by the file suffix :file:`.TBL`. +files (i.e. parameter tables) denoted by the file suffix ``.TBL``. Default parameter tables for the Noah and Noah-MP models are included in the WRF-Hydro source code within the directory structure for their respective land model and the appropriate files are automatically moved @@ -285,24 +286,6 @@ of land cover type. The final table is the soil parameter table or assigned based upon the soil classification. The variables contained within these files are described in the Appendix :ref:`A6 `. -The Noah-MP land surface model requires three parameter table files, outlined -in :ref:`Table 5.3 `. The first of these is the general parameter -table or :file:`GENPARM.TBL`. This file contains a number of global parameters -for the Noah-MP land surface model. The next is the soil parameter table or -:file:`SOILPARM.TBL`. This parameter table contains parameters that are -assigned based upon the soil classification. The final table is the -:file:`MPTABLE.TBL`. This file contains parameters that are a function -of land cover type. The variables contained within these files are -described in Appendix :ref:`A7 `. - -As part of work conducted for the National Water Model implementation, -the ability to specify a number of these land surface model parameters -spatially on a two or three dimensional grid was introduced. This is -done through the use of the compile time option ``SPATIAL_SOIL`` and the -specification of a netCDF format parameter file with the default -filename :file:`soil_properties.nc`. A list of the variables contained in -this file is included in Appendix :ref:`A7 `. - .. table:: **Table 5.2** Parameter tables for the Noah land surface model. These parameter tables can be found within the land surface model source code :file:`Run/` directory and will be copied over the the WRF-Hydro Run @@ -328,6 +311,24 @@ this file is included in Appendix :ref:`A7 `. .. default-role:: +The Noah-MP land surface model also requires three parameter table files, outlined +in :ref:`Table 5.3 `. The first of these is the general parameter +table or :file:`GENPARM.TBL`. This file contains a number of global parameters +for the Noah-MP land surface model. The next table is the +:file:`MPTABLE.TBL`. This file contains parameters that are a function +of land cover type. The last one is the soil parameter table or +:file:`SOILPARM.TBL`. This parameter table contains parameters that are +assigned based upon the soil classification. The variables contained within these files are +described in Appendix :ref:`A7 `. + +As part of work conducted for the National Water Model implementation, +the ability to specify a number of these land surface model parameters +spatially on a two or three dimensional grid was introduced. This is +done through the use of the compile time option ``SPATIAL_SOIL`` and the +specification of a netCDF format parameter file with the default +filename :file:`soil_properties.nc`. A list of the variables contained in +this file is included in Appendix :ref:`A7 `. + .. table:: **Table 5.3** Parameter tables for the Noah-MP land surface model. These parameter tables can be found within the land surface model source code Run directory and will be copied over to the WRF-Hydro Run directory @@ -383,8 +384,8 @@ those new vegetation indices. Users can alter the values of overland flow roughness here for a given vegetation type. However, users may also 'scale' these initial values of roughness by changing the gridded values of the overland flow roughness scaling factor (``OVROUGHRTFAC``) that are -contained within the high resolution routing data netCDF file. Because -hydrological models are often calibrated over a particular region or +contained within the high resolution routing data netCDF file (e.g., :file:`Fulldom_hires{x}.nc`). +Because hydrological models are often calibrated over a particular region or watershed as opposed to a specific vegetation type it is recommended that users modify the ``OVROUGHRTFAC`` scaling factor as opposed to altering the roughness values in :file:`HYDRO.TBL`. @@ -392,16 +393,16 @@ the roughness values in :file:`HYDRO.TBL`. The second part of the :file:`HYDRO.TBL` parameter table contains several soil hydraulic parameters that are classified as functions of soil type. These soil parameters are copied from the :file:`SOILPARM.TBL` parameter table -from the Noah land surface model. They are provided in HYDRO.TBL to +from the Noah land surface model. They are provided in :file:`HYDRO.TBL` to allow the user to modify those parameters as needed during model calibration activities without modifying the :file:`SOILPARM.TBL` file and thus is just done for convenience. In effect, when routing options in WRF-Hydro are activated the code will read the soil hydraulic parameters -from :file:`HYDRO.TBL`. If the Noah land surface model is run within WRF-Hydro -without any of the routing options active, the code will simply use the -parameter values specific in :file:`HYDRO.TBL`. +from :file:`HYDRO.TBL`. If the Noah land surface model is executed within WRF-Hydro +without any of the routing options activated, the code will simply use the +parameter values specified in :file:`HYDRO.TBL`. -The :file:`hydro2dtbl.nc` is a spatially distributed netCDF file version of the +The file :file:`hydro2dtbl.nc` is a spatially distributed netCDF file version of the :file:`HYDRO.TBL` parameter table. This netCDF file can be created via the :file:`create_SoilProperties.R` script distributed on the WRF-Hydro website (https://ral.ucar.edu/projects/wrf_hydro) or will automatically be @@ -435,8 +436,8 @@ regionalization. Channel parameters for WRF-Hydro are specified in one of two files. If the model is configured using gridded channel routing these parameters -will be stored in :file:`CHANPARM.TBL`. If the model is configured using reach -based routing (including the NWM configuration) the parameters and +will be stored in :file:`CHANPARM.TBL`. If the model is configured using reach-based +routing (including the NWM configuration) the parameters and channel geometry are specified within the :file:`Route_Link.nc` file generated by the *WRF-Hydro GIS Pre-processing Toolkit*. Variables of the :file:`CHANPARM.TBL` and :file:`Route_Link.nc` files are described in Appendix @@ -445,8 +446,8 @@ by the *WRF-Hydro GIS Pre-processing Toolkit*. Variables of the It is important to keep in mind that there is large uncertainty associated with these parameters. Therefore, model calibration is almost always warranted. Also, because fully-distributed estimates of flow -depth (``HLINK``) are not available for model initialization, it is almost -always necessary to use a small initial value of ``HLINK`` and let the model +depth (``HLINK`` in :file:`CHANPARM.TBL`) are not available for model initialization, +it is almost always necessary to use a small initial value of ``HLINK`` and let the model come to its own equilibrium (i.e. “spin-up”) after several hours of integration. The necessary time required to spin up the channel network is a direct function of how dense and long your channel network is. @@ -460,10 +461,10 @@ take to spin up the channel elements. 5.5 Description of groundwater input and parameter files -------------------------------------------------------- -Depending upon the choice of channel configuration groundwater input and +Depending upon the choice of channel configuration, groundwater input and parameter files are specified in slightly different ways. For the -National Water Model (NWM) implementation of the model where user -defined mapping is active the :file:`spatialweights.nc` file is used to map +National Water Model (NWM) implementation of the model - where user +defined mapping is active - the :file:`spatialweights.nc` file is used to map gridded fluxes to the appropriate catchments, the spatial unit of the NWM groundwater bucket model. In other configurations of the model where user defined mapping is not used, grid-based groundwater basins are @@ -486,7 +487,8 @@ calibration are recommended. Lake parameter values are specified for each one of the lake objects. Typically, baseline parameters are derived within the high-resolution terrain preprocessing stages described above using tools such as ArcGIS -(e.g. ``LkArea``, ``LkMxE``). Values for the weir and orifice coefficients and +(e.g. ``LkArea``, ``LkMxE`` in the file :file:`LAKEPARM.nc`). +Values for the weir and orifice coefficients and sizes can be drawn from standard engineering hydraulics textbooks (e.g. *Chow et al., 1957*) and calibrated based on lake level performance. Weir parameters are specified for reservoir “overflow” or “spill” and orifice @@ -510,9 +512,9 @@ systems. Most land models require a similar set of input variables with some variation in terms of the units, spectral bandwidths of radiation, handling of precipitation phase, etc. Most commonly these variables include: incoming short and longwave radiation, humidity, temperature, -pressure, wind speed and precipitation. The required variables for the +pressure, wind speed and precipitation rate and type. The required variables for the Noah and Noah-MP land surface models supported in version 5.x of -WRF-Hydro are listed in :ref:`Table 5.4 ` These variables' +WRF-Hydro are listed in :ref:`Table 5.4 `. These variables' names, units, and several of the forcing data file format options described below are borrowed from the High-Resolution Land Data Assimilation System (`HRLDAS `__), @@ -550,9 +552,12 @@ the forcing data. | ``RAINRATE`` | Precipitation rate | `mm/s` *or* | | | | `kg/m^2` | +-----------------+------------------------------------+---------------+ + | ``LQFRAC`` | Precipitation type | `unitless` | + | (optional) | i.e., liquid water fraction (0-1) | | + +-----------------+------------------------------------+---------------+ Here we simply describe the requirements and options that are available -in the standalone version of WRF-Hydro. Presently, there are 7 forcing +in the standalone version of WRF-Hydro. Presently, there are 9 forcing data input types in WRF-Hydro. Because it is untenable to support a large variety of input file formats and data types within the model, WRF-Hydro requires that most processing of forcing data be handled @@ -561,30 +566,26 @@ forcing data into one of the required formats. This includes performing tasks like, gridding of station observations, making sure forcing data is gridded to match the domain grid and has the correct variable names and units (see :ref:`Table 5.4 `), reformatting data into the -prescribed netCDF format, etc. To facilitate these pre-processing activities -we have developed numerous scripts which can be executed to help in the -forcing data preparation process. These scripts along with sample data files -are distributed on the WRF-Hydro website. +prescribed netCDF format, etc. Note that The WRF-Hydro code will not +remap or spatially-subset the forcing data in any way. To facilitate these pre-processing activities +we have developed `WRF-Hydro Forcing Engine `_ +and numerous scripts which can be executed to help in the forcing data preparation process. +These scripts along with sample data files are distributed on the WRF-Hydro website. The input forcing data type is specified in the land surface model -namelist file namelist.hrldas by modifying the ``FORC_TYP`` namelist -option. - -Model forcing type namelist options are specified as follows: - - 1=HRLDAS-hr format - - 2=HRLDAS-min format - - 3=WRF output - - 4=Idealized - - 5=Idealized with specified precipitation - - 6=HRLDAS-hr format with specified precipitation - - 7=WRF output with specified precipitation +namelist file :file:`namelist.hrldas` by modifying the ``FORC_TYP`` namelist +option. Model forcing type namelist options are specified and described as follows, +See Appendices :ref:`A3 ` and :ref:`A4 ` +for more details. +:: + # 1 = HRLDAS-hr format + # 2 = HRLDAS-min format + # 3 = WRF output + # 4 = Idealized + # 5 = Idealized with specified precipitation + # 6 = HRLDAS-hr format with specified precipitation + # 7 = WRF output with specified precipitation + FORC_TYP = 1 .. rubric:: 1 - HRLDAS hourly format input files: @@ -676,7 +677,7 @@ single gridded field with either the name ``precip`` and units of `mm` or ``precip_rate`` with unit a unit of `mm/s`. When using this forcing type, the WRF-Hydro system will look for a new precipitation input file based on the user-specified ``FORCING_TIMESTEP`` namelist option set in the -namelist.hrldas file. Scripts provided on the WRF-Hydro website will +:file:`namelist.hrldas` file. Scripts provided on the WRF-Hydro website will generate files in this format (specifically the MRMS regridding scripts). Forcing files in this format can also be found in the example test cases. Filenames for supplemental precipitation files must conform @@ -705,7 +706,7 @@ satellite QPE, etc). The model reads in the meteorological forcing data fields on each hour and then holds those values constant for the entire hour. Precipitation can be read in more frequently based on the user-specified ``FORCING_TIMESTEP`` namelist parameter in the -namelist.hrldas file. For example, the user can have 'hourly' +:file:`namelist.hrldas` file. For example, the user can have 'hourly' meteorology with '5-minute' precipitation analyses. .. rubric:: 7 - WRF output files as input to WRF-Hydro with specified @@ -719,7 +720,7 @@ single gridded field with either the name ``precip`` and units of `mm` or WRF-Hydro system will look for a new precipitation input file based on the user-specified ``FORCING_TIMESTEP`` namelist option set in the :file:`namelist.hrldas` file. Scripts provided on the WRF-Hydro website will -generate files in this format (specifically the MRMS regridding scripts). +generate files in this format (e.g., MRMS regridding scripts). Forcing files in this format can also be found in the example test cases. Filenames for supplemental precipitation files must conform to this convention: :file:`{YYYYMMDDHHMM}.PRECIP_FORCING.nc`. @@ -730,7 +731,7 @@ QPE, nowcasts, satellite QPE, etc). The model reads in the meteorological forcing data fields from the WRF output file and then holds those values constant until the next file is available. Precipitation can be read in more frequently based on the user-specified -``FORCING_TIMESTEP`` namelist parameter in the namelist.hrldas file. For +``FORCING_TIMESTEP`` namelist parameter in the :file:`namelist.hrldas` file. For example, the user can have 'hourly' meteorology with '5-minute' precipitation analyses. From f98c1ec808246e7591767ae42f6c3d781e41364b Mon Sep 17 00:00:00 2001 From: Soren Rasmussen Date: Sat, 7 Dec 2024 11:05:06 -0700 Subject: [PATCH 3/3] Newlines for table indentation and trailing whitespace cleanup --- docs/userguide/model-inputs-preproc.rest | 47 ++++++++++++------------ 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/docs/userguide/model-inputs-preproc.rest b/docs/userguide/model-inputs-preproc.rest index 49518cc29..0f99e79be 100644 --- a/docs/userguide/model-inputs-preproc.rest +++ b/docs/userguide/model-inputs-preproc.rest @@ -78,7 +78,7 @@ initial condition files. The data required to define the domain and geospatial attributes of a spatially-distributed, or gridded, 1-dimensional (vertical) land surface model (LSM) are specified in a geogrid (:file:`geo_em.d0{x}.nc`) netCDF file. -This file is generated by the :program:`GEOGRID` utility in the `WRF preprocessing system (WPS) +This file is generated by the :program:`GEOGRID` utility in the `WRF preprocessing system (WPS) `_. WPS is a preprocessing system that prepares both land surface and atmospheric data for use in the model. The GEOGRID component of WPS @@ -100,15 +100,15 @@ Initial conditions for the land surface, such as soil moisture, soil temperature, and snow states, are prescribed via the :file:`wrfinput_d0x.nc` file. This netCDF file can be generated one of two ways, through the :program:`real.exe` program within WRF or via an R script (:file:`create_wrfinput.R`) -distributed on the `WRF-Hydro website `_. -When created using the real.exeprogram in WRF, +distributed on the `WRF-Hydro website `_. +When created using the real.exe program in WRF, initial conditions are pulled from existing reanalysis or realtime products (see WRF documentation for data and system requirements). This will typically result in more realistic initial model states. However, the process is somewhat involved and requires the user to obtain additional external datasets. -The R script will create a simplified version of the :file:`wrfinput_d0x.nc` +The R script will create a simplified version of the :file:`wrfinput_d0x.nc` file including all necessary fields for the Noah-MP land surface model, but with spatially uniform initial conditions that are prescribed within the script and requires only the geogrid file @@ -131,23 +131,23 @@ output files and relevant shapefiles to aid in visualizing the model components. The WRF-Hydro GIS pre-processing tools are developed to function as an additional ArcToolbox within the Esri ArcGIS software. Specific operating system and software requirements are addressed in the -full *WRF-Hydro GIS Pre-processing Toolkit* `documentation +full *WRF-Hydro GIS Pre-processing Toolkit* `documentation `_. The minimum input data requirements for the pre-processing tools are the geogrid file :file:`geo_em.d0x.nc` and a hydrologically conditioned digital elevation model covering the full extent of the domain of interest. From -these datasets the terrain routing files (e.g. :file:`Fulldom_hires.nc`, :file:`hydro2dtbl.nc`) -and channel routing files (e.g. :file:`Route_Link.nc`) can be created (see Appendix :ref:`A9 `). +these datasets the terrain routing files (e.g. :file:`Fulldom_hires.nc`, :file:`hydro2dtbl.nc`) +and channel routing files (e.g. :file:`Route_Link.nc`) can be created (see Appendix :ref:`A9 `). -A ``.txt`` or ``.csv`` file with stream gage locations can optionally -be supplied, allowing the user to demarcate these locations in the model input files +A ``.txt`` or ``.csv`` file with stream gage locations can optionally +be supplied, allowing the user to demarcate these locations in the model input files and optionally produce time series outputs (e.g. :file:`*CHANOBS_DOMAIN{x}`) for only these locations. This text file denoting the location of stream gages or "forecast points" can also be used to generate groundwater input files. Effectively groundwater basins are delineated above each of these locations and default parameters will be assigned to a parameter file that can also be -generated using this tool. More details are available in the *WRF-Hydro GIS Pre-processing Toolkit* `documentation +generated using this tool. More details are available in the *WRF-Hydro GIS Pre-processing Toolkit* `documentation `_. Lake and reservoir component input files also require a supplementary @@ -157,11 +157,11 @@ elevation model a number of parameters are derived for each lake (however, note that other parameters are only assigned a global default value). More details about this process and the contents of the input and parameter files can be found in Appendix :ref:`A12 ` -and the full *WRF-Hydro GIS Pre-processing Toolkit* `documentation +and the full *WRF-Hydro GIS Pre-processing Toolkit* `documentation `_. The *WRF-Hydro GIS Pre-processing Toolkit* will also produce a geospatial -metadata file (e.g. :file:`GEOGRID_LDASOUT_Spatial_Metadata.nc`) for the land surface +metadata file (e.g. :file:`GEOGRID_LDASOUT_Spatial_Metadata.nc`) for the land surface model grid (as defined by the geogrid file :file:`geo_em.d0{x}.nc`). This file contains projection and coordinate information for the land surface model grid. While this file is an optional input to WRF-Hydro, in combination with @@ -384,7 +384,7 @@ those new vegetation indices. Users can alter the values of overland flow roughness here for a given vegetation type. However, users may also 'scale' these initial values of roughness by changing the gridded values of the overland flow roughness scaling factor (``OVROUGHRTFAC``) that are -contained within the high resolution routing data netCDF file (e.g., :file:`Fulldom_hires{x}.nc`). +contained within the high resolution routing data netCDF file (e.g., :file:`Fulldom_hires{x}.nc`). Because hydrological models are often calibrated over a particular region or watershed as opposed to a specific vegetation type it is recommended that users modify the ``OVROUGHRTFAC`` scaling factor as opposed to altering @@ -436,7 +436,7 @@ regionalization. Channel parameters for WRF-Hydro are specified in one of two files. If the model is configured using gridded channel routing these parameters -will be stored in :file:`CHANPARM.TBL`. If the model is configured using reach-based +will be stored in :file:`CHANPARM.TBL`. If the model is configured using reach-based routing (including the NWM configuration) the parameters and channel geometry are specified within the :file:`Route_Link.nc` file generated by the *WRF-Hydro GIS Pre-processing Toolkit*. Variables of the @@ -446,7 +446,7 @@ by the *WRF-Hydro GIS Pre-processing Toolkit*. Variables of the It is important to keep in mind that there is large uncertainty associated with these parameters. Therefore, model calibration is almost always warranted. Also, because fully-distributed estimates of flow -depth (``HLINK`` in :file:`CHANPARM.TBL`) are not available for model initialization, +depth (``HLINK`` in :file:`CHANPARM.TBL`) are not available for model initialization, it is almost always necessary to use a small initial value of ``HLINK`` and let the model come to its own equilibrium (i.e. “spin-up”) after several hours of integration. The necessary time required to spin up the channel network @@ -487,7 +487,7 @@ calibration are recommended. Lake parameter values are specified for each one of the lake objects. Typically, baseline parameters are derived within the high-resolution terrain preprocessing stages described above using tools such as ArcGIS -(e.g. ``LkArea``, ``LkMxE`` in the file :file:`LAKEPARM.nc`). +(e.g. ``LkArea``, ``LkMxE`` in the file :file:`LAKEPARM.nc`). Values for the weir and orifice coefficients and sizes can be drawn from standard engineering hydraulics textbooks (e.g. *Chow et al., 1957*) and calibrated based on lake level performance. Weir @@ -566,18 +566,20 @@ forcing data into one of the required formats. This includes performing tasks like, gridding of station observations, making sure forcing data is gridded to match the domain grid and has the correct variable names and units (see :ref:`Table 5.4 `), reformatting data into the -prescribed netCDF format, etc. Note that The WRF-Hydro code will not +prescribed netCDF format, etc. Note that The WRF-Hydro code will not remap or spatially-subset the forcing data in any way. To facilitate these pre-processing activities -we have developed `WRF-Hydro Forcing Engine `_ -and numerous scripts which can be executed to help in the forcing data preparation process. +we have developed `WRF-Hydro Forcing Engine `_ +and numerous scripts which can be executed to help in the forcing data preparation process. These scripts along with sample data files are distributed on the WRF-Hydro website. The input forcing data type is specified in the land surface model namelist file :file:`namelist.hrldas` by modifying the ``FORC_TYP`` namelist -option. Model forcing type namelist options are specified and described as follows, -See Appendices :ref:`A3 ` and :ref:`A4 ` +option. Model forcing type namelist options are specified and described as follows, +See Appendices :ref:`A3 ` and :ref:`A4 ` for more details. -:: + +: + # 1 = HRLDAS-hr format # 2 = HRLDAS-min format # 3 = WRF output @@ -734,4 +736,3 @@ Precipitation can be read in more frequently based on the user-specified ``FORCING_TIMESTEP`` namelist parameter in the :file:`namelist.hrldas` file. For example, the user can have 'hourly' meteorology with '5-minute' precipitation analyses. -