|
6 | 6 | Creating input for surface dataset generation |
7 | 7 | ********************************************* |
8 | 8 |
|
9 | | -Generating SCRIP grid files |
| 9 | +Generating ESMF mesh files |
10 | 10 | ================================== |
11 | 11 |
|
12 | | -The utility ``mkmapdata.sh`` requires SCRIP format input files to describe the input and output grids that maps are generated for. CLM provides a utility, ``mkmapgrids`` that generates those files. The program converts old formats of CAM or CLM grid files to SCRIP grid format. There is also a NCL script (``mkscripgrid.ncl``) to create regular latitude longitude regional or single-point grids at the resolution the user desires. |
| 12 | +The ``mksurfdata_esmf`` tool requires ESMF mesh files to describe the input and output grids used for generating fsurdat and landuse files. CLM provides the ``mesh_maker`` tool for generating such files. See section :numref:`how-to-make-mesh` for details. |
13 | 13 |
|
14 | | -SCRIP grid files for all the standard model resolutions and the raw surface datasets have already been done and the files are in the XML database. Hence, this step doesn't need to be done -- EXCEPT WHEN YOU ARE CREATING YOUR OWN GRIDS. |
| 14 | +ESMF mesh files for all the standard model resolutions and the raw surface datasets already exist and the files are in the XML database. Hence, you may skip this step -- UNLESS YOU ARE CREATING YOUR OWN GRIDS. |
15 | 15 |
|
16 | | -.. _using-mkocnmap: |
17 | | - |
18 | | -Using mknocnmap.pl to create grid and maps for single-point regional grids |
19 | | --------------------------------------------------------------------------- |
20 | | - |
21 | | -.. todo:: |
22 | | - Update the below, as domain files aren't needed with nuopc. |
23 | | - |
24 | | -If you want to create a regular latitude/longitude single-point or regional grid, we suggest you use ``mknoocnmap.pl`` in ``$CTSMROOT/tools/mkmapdata`` which will create both the SCRIP grid file you need (using ``$CTSMROOT/tools/mkmapgrids/mkscripgrid.ncl``) AND an identity mapping file assuming there is NO ocean in your grid domain. If you HAVE ocean in your domain you could modify the mask in the SCRIP grid file for ocean, and then use ``ESMF_RegridWeightGen`` to create the mapping file, and ``gen_domain`` to create the domain file. Like other tools, ``./mkmapdata/mknoocnmap.pl`` has a help option with the following: |
25 | | -:: |
26 | | - |
27 | | - SYNOPSIS |
28 | | - mknoocnmap.pl [options] Gets map and grid files for a single land-only point. |
29 | | - REQUIRED OPTIONS |
30 | | - -centerpoint [or -p] <lat,lon> Center latitude,longitude of the grid to create. |
31 | | - -name [-or -n] <name> Name to use to describe point |
32 | | - |
33 | | - OPTIONS |
34 | | - -dx <number> Size of total grid in degrees in longitude direction |
35 | | - (default is 0.1) |
36 | | - -dy <number> Size of total grid in degrees in latitude direction |
37 | | - (default is 0.1) |
38 | | - -silent [or -s] Make output silent |
39 | | - -help [or -h] Print usage to STDOUT. |
40 | | - -verbose [or -v] Make output more verbose. |
41 | | - -nx <number> Number of longitudes (default is 1) |
42 | | - -ny <number> Number of latitudes (default is 1) |
43 | | - |
44 | | -See :numref:`Figure mknoocnmap.pl` for a visual representation of this process. |
45 | | - |
46 | | -Creating mapping files for mksurfdata_esmf |
47 | | -============================================== |
48 | | - |
49 | | -``mkmapdata.sh`` uses the above SCRIP grid input files to create SCRIP mapping data files (uses ESMF). |
50 | | - |
51 | | -The bash shell script ``$CTSMROOT/tools/mkmapgrids/mkmapdata.sh`` uses ``ESMF_RegridWeightGen`` to create a list of maps from the raw datasets that are input to ``mksurfdata_esmf``. Each dataset that has a different grid, or land-mask needs a different mapping file for it, but many different raw datasets share the same grid/land-mask as other files. Hence, there doesn't need to be a different mapping file for EACH raw dataset---just for each raw dataset that has a DIFFERENT grid or land-mask. See :numref:`Figure mkmapdata.sh` for a visual representation of how this works. The bash script figures out which mapping files it needs to create and then runs ``ESMF_RegridWeightGen`` for each one. You can then either enter the datasets into the XML database (see Chapter :numref:`adding-new-resolutions-section`), or leave the files in place and use the ``-res usrspec -usr_gname -usr_gdate`` options to ``mksurfdata_esmf``. ``mkmapdata.sh`` has a help option with the following |
52 | | -:: |
53 | | - |
54 | | - ../../tools/mkmapdata/mkmapdata.sh |
55 | | - |
56 | | - ********************** |
57 | | - usage on derecho:Figure mkmapdata.sh |
58 | | - ./mkmapdata.sh |
59 | | - |
60 | | - valid arguments: |
61 | | - [-f|--gridfile <gridname>] |
62 | | - Full pathname of model SCRIP grid file to use |
63 | | - This variable should be set if this is not a supported grid |
64 | | - This variable will override the automatic generation of the |
65 | | - filename generated from the -res argument |
66 | | - the filename is generated ASSUMING that this is a supported |
67 | | - grid that has entries in the file namelist_defaults_clm.xml |
68 | | - the -r|--res argument MUST be specied if this argument is specified |
69 | | - [-r|--res <res>] |
70 | | - Model output resolution (default is 10x15) |
71 | | - [-t|--gridtype <type>] |
72 | | - Model output grid type |
73 | | - supported values are [regional,global], (default is global) |
74 | | - [-b|--batch] |
75 | | - Toggles batch mode usage. |
76 | | - If you want to run in batch mode |
77 | | - you need to have a separate batch script for a supported machine |
78 | | - that calls this script interactively - you cannot submit this |
79 | | - script directory to the batch system |
80 | | - [-l|--list] |
81 | | - List mapping files required (use check_input_data to get them) |
82 | | - also writes data to clm.input_data_list |
83 | | - [-d|--debug] |
84 | | - Toggles debug-only (don't actually run mkmapdata just echo what would happen) |
85 | | - [-h|--help] |
86 | | - Displays this help message |
87 | | - [-v|--verbose] |
88 | | - Toggle verbose usage -- log more information on what is happening |
89 | | - |
90 | | - You can also set the following env variables: |
91 | | - ESMFBIN_PATH - Path to ESMF binaries |
92 | | - (default is /contrib/esmf-5.3.0-64-O/bin) |
93 | | - CSMDATA ------ Path to CESM input data |
94 | | - (default is /glade/p/cesm/cseg/inputdata) |
95 | | - MPIEXEC ------ Name of mpirun executable |
96 | | - (default is mpirun.lsf) |
97 | | - REGRID_PROC -- Number of MPI processors to use |
98 | | - (default is 8) |
99 | | - |
100 | | - **pass environment variables by preceding above commands |
101 | | - with 'env var1=setting var2=setting ' |
102 | | - ********************** |
103 | | - |
104 | | -.. _Figure mkmapdata.sh: |
105 | | - |
106 | | -.. figure:: mkmapdata_details.jpeg |
107 | | - |
108 | | - Details of running mkmapdata.sh |
109 | | - |
110 | | -Each of the raw datasets for ``mksurfdata_esmf`` needs a mapping file to map from the output grid you are running on to the grid and land-mask for that dataset. This is what ``mkmapdata.sh`` does. To create the mapping files you need a SCRIP grid file to correspond with each resolution and land mask that you have a raw data file in ``mksurfdata_esmf``. Some raw datasets share the same grid and land mask -- hence they can share the same SCRIP grid file. The output maps created here go into ``mksurfdata_esmf`` see :numref:`Figure Workflow of CLM5 Land Use Data Tool and mksurfdata_esmf Tool`. |
0 commit comments