Changes between Version 3 and Version 4 of eqprelim


Ignore:
Timestamp:
05/29/12 10:41:06 (8 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • eqprelim

    v3 v4  
    111111                LogFile         required 
    112112}}} 
     113 
     114=== ALPHABETIC COMMAND LISTING & DESCRIPTION === 
     115 
     116In 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. 
     117 
     118The following list is organized by: 
     119 
     120command [argument here] 
     121 
     122GetAssocFrom inst mod_id                eqp_config              Earthworm setup   
     123Controls the association messages input to eqprelim. Eqprelim will only process quakes and links that come from module mod_id at installation inst. inst and mod_id are character strings (valid strings are listed in earthworm.h/earthworm.d) which are related to single- byte numbers that uniquely identify each installation and module. Only 2 "Get*From" commands may be issued; wildcards (INST_WILDCARD and MOD_WILDCARD) will force eqprelim to process all quakes & links, regardless of their place of origin. 
     124 
     125Default:  none 
     126Calnet:   GetAssocFrom  INST_MENLO  MOD_BINDER 
     127 GetPicksFrom inst mod_id               eqp_config              Earthworm setup   
     128Controls the pick and coda message input to eqprelim. Eqprelim will only process picks and codas that come from module mod_id at installation inst. inst and mod_id are character strings (valid strings are listed in earthworm.h/earthworm.d) which are related to single- byte numbers that uniquely identify each installation and module. Only 2 "Get*From" commands may be issued; wildcards (INST_WILDCARD and MOD_WILDCARD) will force eqprelim to process all picks & codas, regardless of their place of origin. 
     129Note: both binder and eqprelim should be set to listen to the same pick source(s)! 
     130 
     131Default:  none 
     132Calnet:   GetPicksFrom  INST_WILDCARD  MOD_WILDCARD 
     133 lay depth velocity                    t_com                   model      
     134Defines the layered velocity structure to be used for calculating travel times. depth is the distance (km) to the top of the layer, and velocity is the seismic P-wave velocity (km/sec) within that layer. No default velocity structure is defined; therefore, the user must always supply one in the control file. Up to 20 layers can be specified, and they should be listed in order of increasing depth. 
     135Note: binder and eqprelim calculate travel times independently. Be sure that both programs are using the same velocity model! 
     136 
     137Default:  none                          Calnet:  lay   0.0  4.0 
     138                                                 lay   3.5  5.9 
     139                                                 lay  15.0  6.85 
     140                                                 lay  25.0  7.85 
     141 LocalCode x                            eqprelim_config         notification 
     142Sets the single-character label, x, to identify local picks with in the message sent to the next process. Any picks which were imported from other sources will be labeled with an I. Ultimately, this character ends up in the Hypoinverse archive message in column 92 of the phase line. x must not be surrounded by quotes and it must not be I! 
     143 
     144Default:  none                          Calnet:  LocalCode W 
     145 LogFile switch                         eqp_config              output    
     146Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, eqprelim will write a daily log file(s) called eqprelimxx.log_yymmdd where xx is eqprelim'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). 
     147 
     148Default:  none 
     149 maxsite nsite                           site_com                model    
     150Allocates memory to store nsite station locations in the site table. 
     151         
     152Default:  maxsite 1000                  Calnet:  maxsite 1000 
     153 MyModuleId mod_id                      eqp_config              Earthworm setup   
     154Sets 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. 
     155 
     156Default:  none                          Calnet:  MyModuleId MOD_EQPRELIM 
     157 NumPickNotify npck                     eqprelim_config         notification 
     158Sets the threshold for initiating preliminary event processing. When an event has at least npck P-arrivals associated with it, eqprelim will pipe that event to the process specified in the "PipeTo" command. Eqprelim will initiate only one preliminary location per binder eventid, so npck should be set at the number of phases where most event locations become stable (where additional picks won't change the location). 
     159Note: it is possible that binder may kill an event after eqprelim has reported it, and eqprelim does not send out any kind of "event killed" message. 
     160 
     161Default:  none                          Calnet:  NumPickNotify 25 
     162 PipeTo cmdstring                       eqp_config              Earthworm setup   
     163Sets the command to which eqprelim will pipe a preliminary event for the next step in earthquake processing. Blank spaces are allowed in cmdstring as long as the entire command is enclosed in double-quotes. 
     164 
     165Default:  none 
     166Calnet:   PipeTo "eqbuf eqbuf.d" 
     167 psratio value                           t_com                   model    
     168Sets the value of the P/S seismic velocity ratio. 
     169 
     170Default:  psratio  1.72                 Calnet:  psratio  1.72 
     171 ReportS switch                         eqp_config              notification      
     172Sets the switch for reporting picks that binder has associated as S-phases. If switch is 0, S-phases are not sent along to the next process; if switch is non-zero, S-phases are included in the event message (hypocenter plus associated picks) that is sent to the next process. 
     173 
     174Default:  none                          Calnet:  ReportS  0 
     175 RingName ring                          eqp_config              Earthworm setup   
     176Tells eqprelim which shared memory region to use for input. 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. 
     177 
     178Default:  none                          Calnet:  RingName PICK_RING 
     179 site name latitude longitude           site_com                model     
     180Enters a station location into the station site table, where name is the station code used by the picker, and latitude and longitude are expressed in decimal degrees (positive to the north and east). Use either multiple "site" commands or one "site_file" command to load the station list into eqprelim. 
     181 site_file filename                     site_com                model     
     182Enters site codes and station locations into the site table by reading a HYPOINVERSE format station file called filename. In this file, stations are described by a 5-letter site name, a 2-letter network code and a 3-letter component code. The picker must also be using this station-naming convention. The format of the file is described under "HYPOINVERSE STATION FILE FOR FULL 12-LETTER (S-N-C-L) CHANNEL NAMES". Use either one "site_file" command or multiple "site" commands to load the station list into eqprelim. 
     183 
     184=== THE "MEGA-MODULE" WHICH BEGINS WITH EQPRELIM === 
     185 
     186The eqprelim "mega-module" is a chain of processes that produces preliminary earthquake locations for the Earthworm system. Only eqprelim, the first link in the mega-module, is listed in startstop's configuration file to be started by startstop. Eqprelim then starts the next process, specified in its "PipeTo" command, and communicates with it via a pipe. Each newly created process starts the next link in the same way. From startstop's point of view, the whole mega-module inherits the name of the first link (eqprelim) and that's the only name it displays. From statmgr's point of view, all processes within the mega-module share one module id, one heartbeat, and one descriptor file. However, each process has its own configuration file and its own log file. 
     187 
     188As of 10 October, 1996, the eqprelim mega-module consists of the following "links": 
     189{{{ 
     190  SUB-MODULE    INPUT FROM                      OUTPUT TO 
     191  ----------    ----------                      --------- 
     192  eqprelim      shared memory (PICK_RING)       pipe to eqbuf 
     193  eqbuf         stdin (pipe from eqprelim)      pipe to eqcoda 
     194  eqcoda        stdin (pipe from eqbuf)         pipe to eqverify 
     195  eqverify      stdin (pipe from eqcoda)        pipe to hypo_mgr 
     196  hypo_mgr      stdin (pipe from eqverify)      shared memory (HYPO_RING) 
     197}}} 
     198 
     199==== Inter-link (Intra-mega-module) Communication ==== 
     200 
     201All messages are passed between the processes of the mega-module via pipes. The pipe communications are encapsulated in a set of routines containing the peculiarities of the operating system. Messages, with types defined in earthworm.d, are sent from one link to the next, in one direction only! If a process doesn't need to do anything with a given message type, it just pipes it along to the next link. The current pipe routines (in pipe.c) are: 
     202{{{ 
     203  pipe_init     starts up the next "link", replacing its stdin with 
     204                a pipe from the "parent" program. 
     205  pipe_put      writes a message of a given type to the pipe. 
     206  pipe_get      gets the next message from the pipe. 
     207  pipe_close    closes the pipe. 
     208}}} 
     209 
     210==== Heartbeats ==== 
     211 
     212The mega-module has one module-id and one heartbeat. The heartbeat initiates at the first link (eqprelim), is piped through all the links, and is deposited into shared memory by the last link (in this case, hypo_mgr). If any of the links dies, no heartbeat will be seen by statmgr and it will complain appropriately. 
     213 
     214==== Error Messages ==== 
     215 
     216Since the whole mega-module has only one module-id, the sub-modules need to share the complete set of error numbers within a common descriptor file. Each link is assigned a block of error numbers to use for its complaints. Each link passes along any error messages it reads from the pipe. The last link puts all error messages into shared memory where they are available to statmgr. Statmgr reads one descriptor file for the mega-module. 
     217 
     218==== Final Output from Mega-module ==== 
     219 
     220The last link in the mega-module, hypo_mgr, deposits heartbeats, error messages, and event messages (that look like hypoinverse archive files) onto shared memory where any other Earthworm module can find them. 
     221 
     222 
    113223== Helpful Hints ==