Program M3EDHDR

Usage

    setenv  <infile>     <path name>
    m3edhdr [<infile>>]
    <and respond to the prompts>

where infile is the logical name of the input file whose header attributes are to be edited. If infile is not present, the program will prompt the user for the input file logical name.

Summary

Program M3EDHDR allows the user to edit various attributes in Models-3 I/O API file headers. Certain other edits, which would destroy the integrity of the file's internal metadata, are not allowed. The following table describes the supported edits, (in terms of the names for file attributes as specified in the FDESC3.EXT include-file):

Horizontal coordinate system parameters, provided that the coordinate system is not a lat-lon coordinate system:
- angle P_ALP3D
- angle P_BET3D (except for UTM coordinate systems)
- angle P_GAM3D (except for UTM coordinate systems)
- coordinate origin X coordinate, XCENT3D
- coordinate origin Y coordinate, YCENT3D
Horizontal grid parameters
- Lower-left grid corner X coordinate XORIG3D
- Lower-left grid corner Y coordinate YORIG3D
- X-direction cell size, XCELL3D
- Y-direction cell size, YCELL3D
Vertical grid and coordinate system parameters
- Vertical grid type VGTYP3D
- vertical grid sigma-top VGTOP3 (for sigma (pressure or altitude) vertical coordinates only)
- The layer tops VGLVS3D( L, L = 1, NLAYS3D+1 )
Time step structure description (for time-dependent files only):
- starting date SDATE3D, in format YYYYDDD
- starting time STIME3D, in format HHMMSS
- time step TSTEP3D, in format HHMMSS
Variables
- Names VNAME3D( V, 1, ..., NVARS3D )
- Units UNITS3D( V, 1, ..., NVARS3D )
- Descriptions VDESC3D( V, 1, ..., NVARS3D )
File description field FDESC3D

Before you run the program, you need to assign a logical name to the physical file names of both the input file and the report file (if any), according to Models-3 conventions, using the operation

    "setenv <lname> <pname>"

The program will prompt you for the logical name you have chosen for the input file, and then extensively for the options to choose; the prompts will have default responses which can be accepted by hitting <RETURN>. (Note that the default responses are in fact the values taken from the file itself, so that default behavior is not to change the attributes.)

Note that the set of edits which can be performed by one execution of M3EDHDR is quite complex, being dependent upon the variables and other structures in the file being analyzed. If you want to run this program in batch mode (i.e., from a script), the recommended way to develop the script is to run the program once interactively while noting the pattern of responses to prompts which generate the particular analysis you want. The pattern of responses then becomes either a command-input file which is redirected into the program's execution by the script, or becomes a "here-document" fed into the execution.

Source code for program m3edhdris available under the GNU GPL License, Version 2, and can be downloaded here from CMAS or here from GitHub.

Previous: m3diff

Next: m3merge

Up: Related Programs

To: Models-3/EDSS I/O API: The Help Pages