PrintUsage Subroutine

subroutine PrintUsage()

Arguments

None

Source Code

  subroutine PrintUsage()
    print *, "Usage: ESMF_Regrid"
    print *, "                      --source|-s src_grid_filename"
    print *, "                      --destination|-d dst_grid_filename"
    print *, "                      --src_var varname1[,varname2,...]"
    print *, "                      --dst_var  varname1[,varname2,...]"
    print *, "                      [--srcdatafile]"
    print *, "                      [--dstdatafile]"
    print *, "                      [--tilefile_path tile_file_path]"
    print *, "                      [--dst_loc center|corner]"
    print *, "                      [--method|-m bilinear|patch|neareststod|nearestdtos|conserve|conserve2nd]"
    print *, "                      [--pole|-p all|none|teeth|<N>]"
    print *, "                      [--ignore_unmapped|-i]"
    print *, "                      [--ignore_degenerate]"
    print *, "                      [-r]"
    print *, "                      [--src_regional]"
    print *, "                      [--dst_regional]"
    print *, "                      [--check]"
    print *, "                      [--no_log]"
    print *, "                      [--help]"
    print *, "                      [--version]"
    print *, "                      [-V]"
    print *, "where"
    print *, "--source or -s - a required argument specifying the source grid file"
    print *, "              name"
    print *, "--destination or -d - a required argument specifying the destination grid"
    print *, "              file name"
    print *, "--src_var  - a required argument specifying the variable names to be regridded"
    print *, "              in the source grid file.  If more than one, separated them with" 
    print *, "              comma."
    print *, "--dst_var  - a required argument specifying the destination variable name in"
    print *, "              the destination grid file.  If more than one, separated them with"
    print *, "              comma.  The number of dst_vars has to be the same as the number"
    print *, "              of src_var"
    print *, "--srcdatafile - If the source grid is of type MOSAIC, the data is stored "
    print *, "              in separated files, one per tile. srcdatafile is the prefix of"
    print *, "              the source data file.  The filename is srcdatafile.tilename.nc,"
    print *, "              where tilename is the tile name defined in the source grid file"
    print *, "--dstdatafile - If the destination grid is of type MOSAIC, the data is stored"
    print *, "              in separated files, one per tile. dstdatafile is the prefix of"
    print *, "              the destination data file.  The filename is srcdatafile.tilename.nc,"
    print *, "               where tilename is the tile name defined in the destination grid file"
    print *, "--tilefile_path - The alternative file path for the tile files and mosaic data files"
    print *, "              when either srcFile or dstFile is a GRIDSPEC MOSAIC grid.  The path"
    print *, "              can be either relative or absolute.  If it is relative, it is"
    print *, "              relative to the working directory.  When specified, the gridlocation"
    print *, "              variable defined in the Mosaic file will be ignored."
    print *, "--method or -m - an optional argument specifying which interpolation method is"
    print *, "              used.  The default method is bilinear"
    print *, "--pole or -p - an optional argument indicating what to do with the pole."
    print *, "              The default value is all"
    print *, "--ignore_unmapped or -i - ignore unmapped destination points. If not specified,"
    print *, "              the default is to stop with an error."
    print *, "--ignore_degenerate - ignore degenerate cells in the input grids. If not specified,"
    print *, "              the default is to stop with an error."
    print *, "-r          - an optional argument specifying the source and destination grids"
    print *, "              are regional grids.  Without this argument, the grids are assumed"
    print *, "              to be global. This argument only applies to the GRIDSPEC file"
    print *, "--src_regional   - an optional argument specifying the source grid is regional."
    print *, "              Without this argument, the src grids is assumed to be global. This "
    print *, "              argument only applies to the GRIDSPEC file"
    print *, "--dst_regional   - an optional argument specifying the destination grid is regional"
    print *, "              Without this argument, the dst grids is assumed to be global."
    print *, "              This argument only applies to the GRIDSPEC file"
    print *, "--check    - Check the regridded fields by comparing the values with"
    print *, "             a synthetic field calculated based on its coordinates. "
    print *, "             The mean relative error between the destination field "
    print *, "             and synthetic field is computed.  The synthetic value is calculated as " 
    print *, "             data(i,j,k,l)=2.0+(k-1)+2*(l-1)+cos(lat(i,j))**2*cos(2*lon(i,j)), assuming"
    print *, "             it is a 2D grid " 
    print *, "--no_log    - Turn off the ESMF error log."
    print *, "--help     - Print this help message and exit."
    print *, "--version  - Print ESMF version and license information and exit."
    print *, "-V        - Print ESMF version number and exit."
    print *, ""
    print *, "For questions, comments, or feature requests please send email to:"
    print *, "esmf_support@cgd.ucar.edu"
    print *, ""
    print *, "Visit http://www.earthsystemmodeling.org/ to find out more about the"
    print *, "Earth System Modeling Framework."
    print *, ""
  end subroutine PrintUsage