diff --git a/lessons/Lesson-S1-wps.html b/lessons/Lesson-S1-wps.html new file mode 100644 index 000000000..3c170de2c --- /dev/null +++ b/lessons/Lesson-S1-wps.html @@ -0,0 +1,13180 @@ + + +
+This lesson covers two topics: creating your case-specific domain that will also be used throughout the WRF-Hydro system and defining static and initial conditions used for the land-surface model.
+This notebook is not intended to be used interactively and merely is used to create a static markdown document.
+This lesson uses the wrfhydro/wps
docker utility, which can be obtained using the command docker pull wrfhydro/wps
.
+Additionally, we will use the latest Croton_NY_example_testcase.tar.gz
domain tar ball for this lesson, which can be obtained from the latest WRF-Hydro release at https://github.com/NCAR/wrf_hydro_nwm_public/releases.
All paths used in this lesson assume that the lesson materials are located under your home directory in a folder named wrf-hydro-training
.
WRF-Hydro leverages the extensive domain generation and geophysical dataset processing tools available in the WRF Preprocessing System (WPS). The geographical input data (e.g., land cover, soil texture, vegetation) are some of the primary datasets used by WRF-Hydro. The entire dataset collection can be obtained from the WPS geographical input data download page. However, these data are rather large (~50GB) and contain a number of datasets that are not used in most implementations of WRF-Hydro. To facilitate the domain generation process, the WRF-Hydro team has created a subset of the data by removing unnecessary data, removing resolutions of the data not commonly used, and limiting the area to the Continental United States (CONUS). This is consistent with the availability of other datasets used in this tutorial. Thus, the dataset provided with the wrfhydro/training Docker container is considerably smaller than the complete WRF-WPS dataset.
+The WPS program geogrid.exe is used to create the geo_em_d01.nc, hereafter referred to as the 'geogrid' file. The geogrid.exe program takes a Fortran namelist (namelist.wps) and the WPS geographical input data as inputs and creates the geogrid file. However, the geogrid.exe program requires that WRF and WPS be built according to your system specification, and building WRF and WPS can be difficult on some systems. Additionally, much of the functionality of WRF and WPS is not utilized for creating a geogrid file for WRF-Hydro, and many of the options in the namelist.wps are not relevant to this process. Therefore, we have created a Docker container and Python command line utility to abstract much of the WRF/WPS complexity and simplify the process of creating a geogrid file for WRF-Hydro users.
+We will cover the steps to create the geogrid file using this method in the section 'Creating the geogrid file'. For more advanced usage please see the WRF-WPS documentation.
+WRF-Hydro uses domain boundaries defined by the namelist.wps input namelist to the geogrid.exe program. The first step to creating the geogrid file is to define our domain boundaries. The geogrid.exe program takes a centerpoint, x and y grid specifications, and other projection information to define a bounding box for the domain. If you do not already have coordinates, you can obtain them from Google Earth or a standard GIS system. The NOAA supported DomainWizard is also a helpful tool for defining coordinates. However, for this tutorial we have supplied the coordinates for you and you may use the WRF-Hydro geogrid python command line utility to visualize the domain location and create the geogrid file given these coordinates.
+The WPS geogrid.exe utility is controlled by options set in the namelist.wps. As previously stated, there are many options in the namelist.wps file that are not relevant to most WRF-Hydro users. For educational purposes, we will take a quick look at the full namelist.wps file and then discuss the relevant options used by the WRF-Hydro geogrid utility in more detail.
+ +&share
+ wrf_core = 'ARW',
+ max_dom = 1,
+ start_date = '2006-08-16_12:00:00',
+ end_date = '2006-08-16_18:00:00',
+ interval_seconds = 21600
+ io_form_geogrid = 2,
+/
+
+&geogrid
+ parent_id = 1,
+ parent_grid_ratio = 1,
+ i_parent_start = 1,
+ j_parent_start = 1,
+ e_we = 74,
+ e_sn = 61,
+ !
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!! IMPORTANT NOTE !!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ ! The default datasets used to produce the HGT_M, GREENFRAC,
+ ! and LU_INDEX/LANDUSEF fields have changed in WPS v3.8. The HGT_M field
+ ! is now interpolated from 30-arc-second USGS GMTED2010, the GREENFRAC
+ ! field is interpolated from MODIS FPAR, and the LU_INDEX/LANDUSEF fields
+ ! are interpolated from 21-class MODIS.
+ !
+ ! To match the output given by the default namelist.wps in WPS v3.7.1,
+ ! the following setting for geog_data_res may be used:
+ !
+ ! geog_data_res = 'gtopo_10m+usgs_10m+nesdis_greenfrac+10m','gtopo_2m+usgs_2m+nesdis_greenfrac+2m',
+ !
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!! IMPORTANT NOTE !!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ !
+ dx = 30000,
+ dy = 30000,
+ map_proj = 'lambert',
+ ref_lat = 34.83,
+ ref_lon = -81.03,
+ truelat1 = 30.0,
+ truelat2 = 60.0,
+ stand_lon = -98.0,
+
+ geog_data_res = 'default',
+ geog_data_path = '/home/docker/WRF_WPS/utilities/geog_conus'
+/
+
+&ungrib
+ out_format = 'WPS',
+ prefix = 'FILE',
+/
+
+&metgrid
+ fg_name = 'FILE'
+ io_form_metgrid = 2,
+/
+
+A full description of these options can be found in the WPS user guide at http://www2.mmm.ucar.edu/wrf/users/docs/user_guide_V3.9/users_guide_chap3.html. The options that are of interest to most WRF-Hydro users are the following:
+Table 1. WPS namelist options relevent to WRF-Hydro
+Option | +Description | +
---|---|
e_we | +The number of grid edges in the west-east dimension. The number of grid centers will be e_we-1. | +
e_sn | +The number of grid edges in the south-north dimension. The number of grid centers will be e_sn-1. | +
ref_lat | +A real value specifying the latitude part of a (latitude, longitude) center-point of the domain. | +
ref_lon | +A real value specifying the longitude part of a (latitude, longitude) center-point of the domain. West longitudes are negative, and the value of ref_lon should be in the range [-180, 180]. | +
dx | +A real value specifying the grid distance in the x-direction where the map scale factor is 1. The grid distance is in meters for the 'polar', 'lambert', and 'mercator' projection, and in degrees longitude for the 'lat-lon' projection. | +
dy | +A real value specifying the grid distance in the y-direction where the map scale factor is 1. The grid distance is in meters for the 'polar', 'lambert', and 'mercator' projection, and in degrees latitude for the 'lat-lon' projection. | +
map_proj | +A character string specifying the projection of the simulation domain. Accepted projections are 'lambert', 'polar', 'mercator', and 'lat-lon'. Default value is 'lambert'. | +
truelat1 | +A real value specifying, the first true latitude for the Lambert conformal conic projection, or the only true latitude for the Mercator and polar stereographic projections. | +
truelat2 | +A real value specifying, the second true latitude for the Lambert conformal conic projection. For all other projections, truelat2 is ignored. No default value. | +
stand_lon | +A real value specifying, the longitude that is parallel with the y-axis in the Lambert conformal and polar stereographic projections. For the regular latitude-longitude projection, this value gives the rotation about the earth's geographic poles. No default value. | +
geog_data_res | +A character string specifying a corresponding resolution or list of resolutions separated by + symbols of source data to be used when interpolating static terrestrial data to the grid. This string should contain a resolution matching a string preceding a colon in a rel_path or abs_path specification (see the description of GEOGRID.TBL options) in the GEOGRID.TBL file for each field. If a resolution in the string does not match any such string in a rel_path or abs_path specification for a field in GEOGRID.TBL, a default resolution of data for that field, if one is specified, will be used. If multiple resolutions match, the first resolution to match a string in a rel_path or abs_path specification in the GEOGRID.TBL file will be used. Default value is 'default'. | +
geog_data_path | +A character string giving the path, either relative or absolute, to the directory where the geographical data directories may be found. This path is the one to which rel_path specifications in the GEOGRID.TBL file are given in relation to. No default value. | +
To simplify the process of creating the geogrid file, these options are the only ones needed when using the WRF-Hydro geogrid Docker utility.
+Lets take a look at the namelist.wps file used by the wrfhydro/wps
docker utility
&share
+ wrf_core = 'ARW',
+ max_dom = 1,
+ start_date = '2006-08-16_12:00:00',
+ end_date = '2006-08-16_18:00:00',
+ interval_seconds = 21600
+ io_form_geogrid = 2,
+/
+
+&geogrid
+ parent_id = 1,
+ parent_grid_ratio = 1,
+ i_parent_start = 1,
+ j_parent_start = 1,
+ e_we = 74,
+ e_sn = 61,
+ !
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!! IMPORTANT NOTE !!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ ! The default datasets used to produce the HGT_M, GREENFRAC,
+ ! and LU_INDEX/LANDUSEF fields have changed in WPS v3.8. The HGT_M field
+ ! is now interpolated from 30-arc-second USGS GMTED2010, the GREENFRAC
+ ! field is interpolated from MODIS FPAR, and the LU_INDEX/LANDUSEF fields
+ ! are interpolated from 21-class MODIS.
+ !
+ ! To match the output given by the default namelist.wps in WPS v3.7.1,
+ ! the following setting for geog_data_res may be used:
+ !
+ ! geog_data_res = 'gtopo_10m+usgs_10m+nesdis_greenfrac+10m','gtopo_2m+usgs_2m+nesdis_greenfrac+2m',
+ !
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!! IMPORTANT NOTE !!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ !
+ dx = 30000,
+ dy = 30000,
+ map_proj = 'lambert',
+ ref_lat = 34.83,
+ ref_lon = -81.03,
+ truelat1 = 30.0,
+ truelat2 = 60.0,
+ stand_lon = -98.0,
+
+ geog_data_res = 'default',
+ geog_data_path = '/home/docker/WRF_WPS/utilities/geog_conus'
+/
+
+&ungrib
+ out_format = 'WPS',
+ prefix = 'FILE',
+/
+
+&metgrid
+ fg_name = 'FILE'
+ io_form_metgrid = 2,
+/
+
+Step 1: Setup directory for lesson +First, we need to create a directory to hold the inputs and outputs for this lesson.
+ +%%bash
+mkdir -p $HOME/wrf-hydro-training/lessonS1
+
Step 2: Download the example case.
+The example case can be obtained from the WRF-Hydro release page at https://github.com/NCAR/wrf_hydro_nwm_public/releases
+NOTE: The URL below will need to point to the LATEST release
+ +%%bash
+cd $HOME/wrf-hydro-training/lessonS1
+wget https://github.com/NCAR/wrf_hydro_nwm_public/releases/download/v5.0.2/croton_NY_example_testcase.tar.gz &>/dev/null
+tar -xf croton_NY_example_testcase.tar.gz
+
In this section we will make a few changes to the example case namelist.wps
to demonstrate how to move the domain location and change the extent. NOTE: Do not edit the ~/wrf-hydro-training/example_case/supplemental/namelist.wps file because we will use this prepared namelist to create the example case geogrid file using WPS in a later section of this lesson
In general, users want to do the largest, highest-resolution model domain possible. Unfortunately, we are often constrained by available computer power or drive storage. These contraints usually define the acceptable grid sizes for us (e_we, e_sn). Therefore, once we know our domain center, we can play with dx and dy to cover our interested area.
+We will edit the dx and dy options in the namelist to grow the size of the domain. We will leave all other options the same, which will simply increase the domain coverage but maintain the domain center and domain dimensions.
+Step 1: Visualize the original domain location.
+First let's create a basic map of the original example case domain location using the example case namelist.wps file ~/wrf-hydro-training/example_case/supplemental/namelist.wps and the WRF-Hydro geogrid Python utility. You can get help on the arguments to the python utility by accessing its help.
+ +%%bash
+docker run wrfhydro/wps --help
+
Note that the Docker utility entrypoint script takes 4 arguments, the first --namelist_path
is the path to your namelist.wps file, the second --output_dir
is the path to the directory to hold the output, and the third --plot_only
is a boolean True
or False
indicating whether or not to plot the domain. If plot_only
the utility will only plot the domain and not create the geogrid file. This option is useful for making changes to your domain location or extent. The fourth argument --create_wrfinput
is a boolean True
or False
indicating whether or not to create a wrfinput initial conditions.
Now, let's create a plot of the original example case domain location.
+ +%%bash
+docker run -v $HOME/wrf-hydro-training/lessonS1/:/home/docker/mount wrfhydro/wps \
+--namelist_path /home/docker/mount/example_case/supplemental/namelist.wps \
+--output_dir /home/docker/mount \
+--plot_only
+
import os
+from IPython.display import Image
+Image(filename=os.path.expanduser('~/wrf-hydro-training/lessonS1/domain.png'))
+
Step 2: Make a copy of the original domain namelist.wps
+We will copy our original domain namelist.wps that was used to create the example case and edit it. It is located at ~/wrf-hydro-training/example_case/supplemental/namelist.wps
NOTE: Do not edit the original namelist.wps ~/wrf-hydro-training/example_case/supplemental/namelist.wps
because we will use it later to create our geogrid file.
%%bash
+cp ~/wrf-hydro-training/lessonS1/example_case/supplemental/namelist.wps ~/wrf-hydro-training/lessonS1/namelist_edit.wps
+
Step 3: Edit the ~/wrf-hydro-training/output/lessonS1/namelist_edit.wps
Using your editor of choice (can be edited in Jupyter), open the ~/wrf-hydro-training/output/lessonS1/namelist_edit.wps
file and change the dx and dy values to
dx=2000.0
+dy=2000.0
+
+%%bash
+docker run -v $HOME/wrf-hydro-training/lessonS1/:/home/docker/mount wrfhydro/wps \
+--namelist_path /home/docker/mount/namelist_edit.wps \
+--output_dir /home/docker/mount \
+--plot_only
+
import os
+from IPython.display import Image
+Image(filename=os.path.expanduser('~/wrf-hydro-training/lessonS1/domain.png'))
+
We can see that the domain coverage has expanded but the center and size are the same. You can change any of your domain set-up by editing the variables in namelist.wps
.
In this section, we will create the geogrid file using the WRF-Hydro geogrid python utility. Note: If you would like to use this utilitiy outside of this training, the utility and all required datasets for the Continental United States are available in the wrfhydro/wps Docker container at https://hub.docker.com/r/wrfhydro/wps/.
+Step 1: Copy the prepared namelist.wps file for the example case to the lessonS1 output folder
+We will copy over the prepared namelist.wps file from the example case to create our geogrid file. We will also rename our edited namelist.wps from the previous domain location exercise, in case you want to retain for reference.
+ +%%bash
+cp ~/wrf-hydro-training/lessonS1/example_case/supplemental/namelist.wps \
+~/wrf-hydro-training/lessonS1/namelist.wps
+
Step 1: Check the domain boundaries
+We will do a quick visual inspection to make sure our supplied domain boundary information is correct.
+ +%%bash
+docker run -v $HOME/wrf-hydro-training/lessonS1/:/home/docker/mount wrfhydro/wps \
+--namelist_path /home/docker/mount/example_case/supplemental/namelist.wps \
+--output_dir /home/docker/mount \
+--plot_only
+
import os
+from IPython.display import Image
+Image(filename=os.path.expanduser('~/wrf-hydro-training/lessonS1/domain.png'))
+
Step 2: Create the geogrid and wrfinput files.
+This time we will run the utility with --plot_only
set to False. A plot of the domain will still be produced, but the geogrid.exe utility will also be executed to create the geogrid file.
The wrfinput_d01.nc is a very basic WRF-Hydro initialization file (wrfinput) from a WRF geogrid file and a set of user-specified conditions. The file contains fields of spatially uniform initial model states of soil moisture, soil temperature, soil liquid water content and skin temperature among a few other variables necessary for model cold-start initialization. This file can be used as a 'cold start' for long-term model spin-up or users can overwrite the fields in the file created. Sophisticated and WRF-savvy users can bypass this script and use the WRF utility REAL.EXE to create a wrfinput file from model or reanalysis products.
+The R script used to create this file can be downloaded at https://ral.ucar.edu/projects/wrf_hydro/pre-processing-tools.
+NOTE: This R script will be replaced in the future with a Python command line utility to eliminate the R dependency.
+ +%%bash
+docker run -v $HOME/wrf-hydro-training/lessonS1/:/home/docker/mount wrfhydro/wps \
+--namelist_path /home/docker/mount/example_case/supplemental/namelist.wps \
+--output_dir /home/docker/mount \
+--create_wrf_input
+
Now that we have created our geogrid file, we will quickly open it using the Python library xarray
and check its contents.
%%bash
+ncdump -h ~/wrf-hydro-training/lessonS1/geo_em.d01.nc
+
%matplotlib inline
+import xarray as xr
+
+geogrid = xr.open_dataset('~/wrf-hydro-training/lessonS1/geo_em.d01.nc')
+geogrid.HGT_M.plot()
+
View the wrfinput_d01.nc file
+ +%%bash
+ncdump -h ~/wrf-hydro-training/lessonS1/wrfinput_d01.nc
+
This concludes Lesson S1. In the next lesson, we will regrid some NLDAS forcing data to match our geogrid file for use in WRF-Hydro.
+IT IS BEST TO EITHER SHUTDOWN THIS LESSON OR CLOSE IT BEFORE PROCEEDING TO THE NEXT LESSON TO AVOID POSSIBLY EXCEEDING ALLOCATED MEMORY. Shutdown the lesson be either closing the browser tab for the lesson or selecting KERNAL->SHUTDOWN
in the jupyter notebook toolbar.