5.7.2. Files, configuration, and environment variables

5.7.2.1. MCIP input files
5.7.2.2. MCIP compilation options
5.7.2.3. MCIP compilation
5.7.2.4. MCIP execution options
5.7.2.5. MCIP output files

Figure 5.6. MCIP input and output files

MCIP input and output files

Figure 6 shows the input and output files and configuration options for MCIP. All MCIP configurations are accomplished at execution, a distinction from the rest of the CMAQ programs, which contain configuration options at both compilation and execution.

5.7.2.1. MCIP input files

Table 5.11. MCIP input files

File Name Format Description
InMetFiles binary List of MM5 or WRF output files for input to MCIP
InTerFile binary MM5 Terrain file with fractional land-use categories; used for calculating land-use dependent vertical diffusivity

5.7.2.2. MCIP compilation options

All model configuration options for MCIP are set during execution. System compiler options must be set in the provided Unix Makefile to build the program for different operating system/compiler combinations. Example compiler paths, flags, and library locations are provided in the default Makefile.

5.7.2.3. MCIP compilation

Section 3.3 provides an overview of how to install and compile the CMAQ programs for the tutorial simulation. Follow the steps outlined in Section 3.3 to compile new versions of MCIP:

  1. Configure the Makefile for your operating system/compiler combination. Comment out the configuration that does not apply to your system. Uncomment the configuration that is closest to that of your system and make the necessary changes to point to the compiler path, I/O API location, and netCDF locations on your system.
  2. Install and compile the I/O API and netCDF libraries if these are not already available on your system
  3. Invoke the Makefile to create an executable by typing the following command in the directory that contains the Makefile and MCIP source code:

    ./make

5.7.2.4. MCIP execution options

The environment variables listed here are invoked during execution of the program and are set in the MCIP run script.

  • APPL:

    Application name; scenario ID for file naming

  • CoordName:

    Coordinate system name of the MCIP output grid that is written to the GRIDDESC file

  • GridName:

    Model grid name of the MCIP output grid that is written to the GRIDDESC file

  • DataPath:

    Input/output data directory path

  • InMetDir:

    Path of the input data directory containing the MM5 or WRF output data files

  • InTerDir:

    Path of the input data directory containing the MM5 TERRAIN file

  • OutDir:

    Path of the MCIP output data directory

  • ProgDir:[default: $cwd]

    Working directory containing the MCIP executable

  • WorkDir:

    Temporary working directory for Fortran links and the namelist file

  • InMetFiles:

    List of input meteorology files, including the directory path for each file; up to 100 files allowed as input to a single MCIP execution

  • IfTer:[default: T]

    Binary flag indicating the availability of an input MM5 TERRAIN file; options include T (true) or F (false)

  • InTerFile:

    Name and location of input MM5 TERRAIN file

  • LPBL: [default: 1]

    Sets the source of the PBL values in the MCIP output files. The setting of this variable determines whether to use PBL values from the input meteorology file or to recalculate within MCIP.

    • 1: use PBL values from the input meteorology
    • 2: re-calculate PBL values within MCIP using PBL similarity
    • 3: re-calculate PBL values within MCIP using surface layer similarity
  • LRAD:[default: 1]

    Sets the source of the radiation fields in the MCIP output files. The setting of this variable determines whether to use the radiation fields from the input meteorology or to recalculate within MCIP.

    • 1: use radiation fields from the input meteorology
    • 2: re-calculate radiation fields using the MCIP version 1 algorithm
  • LDDEP [default: 1]:

    Sets the dry deposition routine. The setting of this variable determines which dry deposition routine for calculating deposition velocities.

    • 1: use the RADM (Wesely) dry deposition routine
    • 2: use the Models-3 (Pleim) dry deposition routine
    • 1: Use the Models-3 dry deposition routine and include Cl
    • 2: Use the Models-3 dry deposition routine and include Cl and Hg
  • MCIP_START:[format: YYYY-MM-DD-HH:MM:SS.SSSS]

    Beginning date and time [UTC] of data to output from MCIP. The start data and time must be contained within the input data from MM5 or WRF.

  • MCIP_END:[format: YYYY-MM-DD-HH:MM:SS.SSSS]

    End date and time [UTC] of data to output from MCIP. The end data and time must be contained within the input data from MM5 or WRF.

  • INTVL: [default: 60]

    Output interval in minutes. This setting determines the amount of model time contained in each output time step.

  • CTMLAYS:

    Sigma values of the vertical layers in the 3-d MCIP output. Comma delimited values for each sigma value must be in descending order starting at 1 and ending with 0. There are a maximum of 100 layers allowed. To use the all of the layers from the input meteorology without collapsing (or explicitly specifying), set CTMLAYS = -1.0.

  • MKGRID: [default: T]

    Determines whether to output static (GRID) meteorology files

  • • BTRIM: [default: 0]

    The number of boundary points to remove on each of the four horizontal sides of the MCIP domain. This setting affects the output MCIP horizontal domain by reducing the input meteorology domain by 2*BTRIM + 2*NTHIK + 1, where NTHIK is the lateral boundary thickness (from the BDY files). The extra point reflects the conversion from the grid points (dot points) to grid cells (cross points). Setting BTRIM = 0 will the maximum of the input meteorology domain. To remove the MM5 lateral boundaries, set BTRIM = 5.

    For windowing a subset domain of the input meteorology, set BTRIM = -1; this setting causes BTRIM to be replaced by the information provided by X0, Y0, NCOLS, and NROWS (see below).

  • X0:

    X-coordinate of the lower-left corner of the full MCIP “X” domain (including the MCIP lateral boundary) based on the input MM5 domain. X0 refers to the east-west direction. This setting is only used when doing a subset of the input meteorology domain by setting BTRIM = -1.

  • Y0:

    Determines whether to output static (GRID) meteorology files

  • MKGRID: [default: T]

    Y-coordinate of the lower-left corner of the full MCIP “X” domain (including the MCIP lateral boundary) based on the input MM5 domain. Y0 refers to the north-south direction. This setting is only used when doing a subset of the input meteorology domain by setting BTRIM = -1.

  • NCOLS:

    Number of columns in the output MCIP domain (excluding MCIP lateral boundaries)

  • NROWS:

    Number of rows in the output MCIP domain (excluding MCIP lateral boundaries)

  • LPRT_COL: [default: 0]

    Column cell coordinate for diagnostic outputs on the MCIP modeling domain

  • LPRT_ROW: [default: 0]

    Row cell coordinate for diagnostic outputs on the MCIP modeling domain

5.7.2.5. MCIP output files

Table 5.12. MCIP output files

File Name Format Description
GRIDDESC ASCII Grid description file with coordinate and grid definition information
GRID_BDY_2D BNDARY3 Time-independent 2-D boundary meteorology file
GRID_CRO_2D GRDDED3 Time-independent 2-D cross point meteorology file
GRID_CRO_3D GRDDED3 Time-independent 3-D cross point meteorology file
GRID_DOT_2D GRDDED3 Time-independent 2-D dot point meteorology file
MET_BDY_3D BNDARY3 Time-dependent 3-D boundary meteorology file
MET_CRO_2D GRDDED3 Time-dependent 2-D cross point meteorology file
MET_CRO_3D GRDDED3 Time-dependent 3-D cross point meteorology file
MET_DOT_3D GRDDED3 Time-dependent 3-D dot point meteorology file

The default location of the MCIP output files is the $M3DATA/mcip3/$GridName directory. Since the default file names do not have any information about the model grid that they are simulating, the name of the grid is wired in the output directory path. The default naming convention for all MCIP output files uses only the APPL environment variable in the file name. All of the file naming variables for the MCIP outputs are set in the run script.