Changes between Version 5 and Version 6 of nll_mgr


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

--

Legend:

Unmodified
Added
Removed
Modified
  • nll_mgr

    v5 v6  
    112112In 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. 
    113113 
    114  
    115 command arg1                            processed by            function 
    116  LogFile switch                         nll_mgr_config          output 
    117 Sets 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: 
     114The following list is organized by: 
     115 
     116command [argument here] 
     117 
     118'''!LogFile [switch]'''[[BR]] 
     119Processed by: nll_mgr_config[[BR]] 
     120Function: output 
     121 
     122Sets 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: 
     123{{{ 
    118124    switch = 0  no log file is written 
    119125             1  write errors to log file 
    120126             2  write errors and hypocenters to log file 
    121  
     127}}} 
     128{{{ 
    122129Default:  none 
    123  MyModuleId mod_id                      nll_mgr_config          Earthworm setup 
     130}}} 
     131 
     132'''!MyModuleId [mod_id]'''[[BR]] 
     133Processed by: nll_mgr_config[[BR]] 
     134Function: Earthworm setup 
     135 
    124136Sets 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. 
     137 
    125138NOTE: 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. 
    126  
     139{{{ 
    127140Default:  none                          Calnet:  MyModuleId MOD_EQPROC 
    128  NllCtrlFile filename                   nll_mgr_config          NonLinLoc 
    129 NLL 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. 
    130  
     141}}} 
     142 
     143'''!NllCtrlFile [filename]'''[[BR]] 
     144Processed by: nll_mgr_config[[BR]] 
     145Function: !NonLinLoc 
     146 
     147NLL 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. 
     148{{{ 
    131149Default:  none                          Example:  NllCtrlFile /ew/nll/earthworm.in 
    132  NllOutPath label                       nll_mgr_config          NonLinLoc 
     150}}} 
     151 
     152'''!NllOutPath [label]'''[[BR]] 
     153Processed by: nll_mgr_config[[BR]] 
     154Function: !NonLinLoc 
     155 
    133156NLL 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). 
    134  
     157{{{ 
    135158Default:  none                          Example:  NllOutPath /ew/nll/out/nll_mgr0 
    136  NllStaFile filename                    nll_mgr_config          NonLinLoc 
    137 NLL 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). 
    138  
     159}}} 
     160 
     161'''!NllStaFile [filename]'''[[BR]] 
     162Processed by: nll_mgr_config[[BR]] 
     163Function: !NonLinLoc 
     164 
     165NLL 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). 
     166{{{ 
    139167Default:  none                          Example:  NllStaFile /ew/nll/sta_list.in 
    140  NllTimePath label                      nll_mgr_config          NonLinLoc 
     168}}} 
     169 
     170'''!NllTimePath [label]'''[[BR]] 
     171Processed by: nll_mgr_config[[BR]] 
     172Function: !NonLinLoc 
     173 
    141174NLL 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. 
    142  
     175{{{ 
    143176Default:  none                          Example:  NllTimePath /ew/nll/taup/ak135/ak135 
    144  NllTimeSwap label                      nll_mgr_config          NonLinLoc 
     177}}} 
     178 
     179'''!NllTimeSwap [label]'''[[BR]] 
     180Processed by: nll_mgr_config[[BR]] 
     181Function: !NonLinLoc 
     182 
    145183iSwapBytesOnInput 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. 
    146  
     184{{{ 
    147185Default:  none                          Example:  NllTimeSwap 0 
    148  RingName ring                          nll_mgr_config          Earthworm setup 
     186}}} 
     187 
     188'''!RingName [ring]'''[[BR]] 
     189Processed by: nll_mgr_config[[BR]] 
     190Function: Earthworm setup 
     191 
    149192Tells 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. 
    150  
     193{{{ 
    151194Default:  none                          Calnet:  RingName HYPO_RING 
    152  SourceCode label                       nll_mgr_config          miscellaneous 
     195}}} 
     196 
     197'''!SourceCode [label]'''[[BR]] 
     198Processed by: nll_mgr_config[[BR]] 
     199Function: miscellaneous 
     200 
    153201Reads 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. 
    154  
     202{{{ 
    155203Default:  none                          Calnet:  SourceCode W 
     204}}} 
    156205 
    157206== Helpful Hints ==