Changes between Version 2 and Version 3 of nll_mgr


Ignore:
Timestamp:
05/13/12 09:05:41 (8 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • nll_mgr

    v2 v3  
    1919 
    2020== Configuration File Commands == 
     21=== EXAMPLE CONFIGURATION FILE === 
     22{{{ 
     23 # 
     24#               nll_mgr's Configuration File 
     25# 
     26MyModuleId MOD_EQPRELIM_NLL   # module id to label outgoing messages with. 
     27                              # Note: nll_mgr is part of a mega-module which is 
     28                              # ultimately started by the program eqproc.  All 
     29                              # child processes of this mega-module need to use the 
     30                              # same module id (thus use eqproc's module id). 
     31RingName   HYPO_RING          # The transport ring to write output to, 
     32LogFile    2                  # 0=no log; 1=errors; 2=errors and hypocenters 
     33SourceCode W                  # character to label summary cards with to 
     34                              # identify them as coming from Earthworm 
     35NllCtrlFile /ew/nll/earthworm.in 
     36                              # NLL control file name with full path (see www.alomax.net/nlloc -> Control File) 
     37                              # This files must exist. 
     38                              # (The NLL LOCFILES statement will be overwritten by nll_mgr) 
     39NllStaFile  /ew/nll/sta_list.in 
     40                              # NLL file containing station coordinates in NLL GTSRCE format 
     41                              # This file must exist. 
     42                              # Use an existing, empty file if station GTSRCE statements 
     43                              # are inside NllCtrlFile 
     44NllTimePath /ew/nll/taup/ak135/ak135 
     45                              # NLL travel-time grid files path/root (see NLL LOCFILES statement) 
     46                              # These files must exist. 
     47NllTimeSwap 1                 # iSwapBytesOnInput value from NLL LOCFILES statement 
     48                              # (0 = NO, 1 = YES) flag to indicate if hi and low 
     49                              # bytes of input time grid files should be swapped. Allows reading of travel time 
     50                              # grids generated with a different binary, floating point byte order than on the 
     51                              # computer running EW. 
     52NllOutPath  /ew/nll/out/nll_mgr0 
     53                              # NLL output file path without NLL "root name" 
     54                              # This directory must exist. 
     55                              # IMPORTANT! - this path should be different from 
     56                              # the path used by any other 
     57                              # instances of modules containing nll_mgr. 
     58                              # NLL output to this path will only be overwritten 
     59                              # by output from subsequent events with same output name 
     60                              # (i.e. same first phase time). 
     61}}} 
     62 
     63=== NLL_MGR COMMAND LINE ARGUMENTS === 
     64 
     65An example command line to start nll_mgr may look like this: 
     66{{{ 
     67        nll_mgr nll_mgr.d 
     68        argv[0]  argv[1]  
     69}}} 
     70argv[0] is the name of the executable. 
     71argv[1] is the name of nll_mgr's own configuration file which it reads on startup. In this file, lines may begin with a valid nll_mgr command, described later in this document, or with one of 2 special characters: 
     72{{{ 
     73#  marks the line as a comment (example: # This is a comment). 
     74 
     75@  allows control files to be nested; one control file can be 
     76   accessed from another with the command "@" followed by 
     77   a string representing the path name of the next control file 
     78   (example: @model.d). 
     79}}} 
     80 
     81Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!). 
     82 
     83=== FUNCTIONAL COMMAND LISTING === 
     84 
     85Below are the commands recognized by nll_mgr, grouped by the function they influence. All of the commands are required; they must be specified in the configuration file in order for nll_mgr to operate. 
     86{{{ 
     87        Earthworm system setup: 
     88                MyModuleId      required 
     89                RingName        required 
     90 
     91        Output Control: 
     92                LogFile         required 
     93 
     94        Miscellaneous: 
     95                SourceCode      required 
     96 
     97        NonLinLoc specific: 
     98                NllCtrlFile     required 
     99                NllStaFile      required 
     100                NllTimePath     required 
     101                NllTimeSwap     required 
     102                NllOutPath      required 
     103}}} 
     104 
     105=== ALPHABETIC COMMAND LISTING & DESCRIPTION === 
     106 
     107In the following section, all configuration file commands are listed in alphabetical order. Listed along with the command (bold-type) are its arguments (in red), the name of the subroutine that processes the command, and the function within the module that the command influences. A detailed description of the command and is also given. Default values and the values used by Calnet are listed after each command description. 
     108 
     109 
     110command arg1                            processed by            function 
     111 LogFile switch                         nll_mgr_config          output 
     112Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is non-zero, nll_mgr will write daily log file(s) called nll_mgrxx.log_yymmdd where xx is nll_mgr's module id (set with "MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). The level of output written to the file is controlled by the value of switch: 
     113    switch = 0  no log file is written 
     114             1  write errors to log file 
     115             2  write errors and hypocenters to log file 
     116 
     117Default:  none 
     118 MyModuleId mod_id                      nll_mgr_config          Earthworm setup 
     119Sets the module id for labeling all outgoing messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. 
     120NOTE: nll_mgr is part of a mega-module which is ultimately started by the program eqproc. All sub-modules of this megamodule should be given the same module id. 
     121 
     122Default:  none                          Calnet:  MyModuleId MOD_EQPROC 
     123 NllCtrlFile filename                   nll_mgr_config          NonLinLoc 
     124NLL control file name with full path. The specified file must exist. This control statements in this file will be used by NLL when called from EW, except for certain control statements (including LOCFILES) which are automatically set or use parameters from the other nll_mgr configuration file NonLinLoc commands. See www.alomax.net/nlloc -> Control File for a complete description of NLL control file format and statements. 
     125 
     126Default:  none                          Example:  NllCtrlFile /ew/nll/earthworm.in 
     127 NllOutPath label                       nll_mgr_config          NonLinLoc 
     128NLL output file path without NLL "root name" (see NLL LOCFILES statement). This directory must exist. IMPORTANT! - this path should be different from the path used by any other instances of modules containing nll_mgr. NLL output to this path will only be overwritten by output from subsequent events with same output name (i.e. same first phase time). 
     129 
     130Default:  none                          Example:  NllOutPath /ew/nll/out/nll_mgr0 
     131 NllStaFile filename                    nll_mgr_config          NonLinLoc 
     132NLL file containing station coordinates in NLL GTSRCE format. This file must exist. Use an existing, empty file if all station GTSRCE statements are in the file specified by NllCtrlFile. NLL will only use stations whose coordinates are specified by a GRSRCE statement (usually NLL GLOBAL mode location) or for which individaul station travel-time grid files exist on the NllTimePath (usually NLL non-GLOBAL mode location). 
     133 
     134Default:  none                          Example:  NllStaFile /ew/nll/sta_list.in 
     135 NllTimePath label                      nll_mgr_config          NonLinLoc 
     136NLL travel-time grid files path/root (see NLL LOCFILES statement). These files must exist. For NLL GLOBAL mode location there will normally be travel-time grid files for each phase type, for NLL non-GLOBAL mode location, there will normally be a travel-time grid file for each station, either P phase only or P and S phase. 
     137 
     138Default:  none                          Example:  NllTimePath /ew/nll/taup/ak135/ak135 
     139 NllTimeSwap label                      nll_mgr_config          NonLinLoc 
     140iSwapBytesOnInput value from NLL LOCFILES statement. (0 = NO, 1 = YES) flag to indicate if hi and low bytes of input time grid files should be swapped. Allows reading of travel time grids generated with a different binary, floating point byte order than on the computer running EW. 
     141 
     142Default:  none                          Example:  NllTimeSwap 0 
     143 RingName ring                          nll_mgr_config          Earthworm setup 
     144Tells nll_mgr which shared memory region to use for output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. 
     145 
     146Default:  none                          Calnet:  RingName HYPO_RING 
     147 SourceCode label                       nll_mgr_config          miscellaneous 
     148Reads in a single character label to write in column 80 of the hypo71-format summary messages output by nll_mgr. This label identifies the source of the hypocenter as the Earthworm system. These summary messages are placed on the output shared memory region. 
     149 
     150Default:  none                          Calnet:  SourceCode W 
    21151 
    22152== Helpful Hints ==