Changes between Version 5 and Version 6 of eqassemble


Ignore:
Timestamp:
05/26/12 12:17:26 (8 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • eqassemble

    v5 v6  
    192192command [argument here] 
    193193 
    194 CodaFromInst inst_id            eqas_config             Event Notification        
     194'''!CodaFromInst [inst_id]'''[[BR]] 
     195Processed by: eqas_config[[BR]] 
     196Function: Event Notification 
     197 
    195198Identify from which installations (by inst_id) eqassemble should wait for coda messages for the FinalRule, other than the local inst_id. This optional command is only useful if the FinalRule is turned on and configured to WaitForCodas. If you are importing TYPE_PICK_SCNL and TYPE_CODA_SCNL messages from other Earthworm installations, then you may want eqassemble to wait for those codas. But if another Earthworm installation was sending only TYPE_PICK_SCNL messages, then you would not want eqassemble to wait for those TYPE_CODA_SCNL messages. You can list as many CodaFromInst as needed. But you do not need to list your own inst_id. 
    196  
     199{{{ 
    197200Default:  none 
    198201Calnet:   CodaFromInst  INST_UCB 
    199  DataSrc name           eqas_config             Event Notification        
     202}}} 
     203 
     204'''!DataSrc [name]'''[[BR]] 
     205Processed by: eqas_config[[BR]] 
     206Function: Event Notification 
     207 
    200208Identify the source of the phase data with a single-character name. This code will be inserted into the hypoinverse input message by eqcoda and will be passed through hypoinverse to show up in the hypoinverse archive message as the Data Source Code (column 109 in the phase lines.) 
    201  
     209{{{ 
    202210Default:  " " 
    203211Calnet:   DataSrc  W 
    204  FinalRule Np Msec WaitForCodas         eqas_config             Event Notification        
     212}}} 
     213 
     214'''!FinalRule [Np Msec WaitForCodas]'''[[BR]] 
     215Processed by: eqas_config[[BR]] 
     216Function: Event Notification 
     217 
    205218The final TYPE_EVENT2K message will be released after binder has not changed the solution (no TYPE_QUAKE2K messages) in Msec seconds, provided there are at least Np P phases associated with the event. If the optional string WaitForCodas is included in the FinalRule command, eqassemble will wait up to 150 seconds after a phase arrival until the corresponding coda message is received. Normally the extra wait for codas applies only to TYPE_CODA_SCNL messages from the local inst_id. Use the CodaFromInst command to tell eqassemble to wait for codas from other Earthworm installations. 
     219 
    206220The final TYPE_EVENT2K message is assigned version number 2. This version number will show up in the hypoinverse archive message produced by hyp2000_mgr, usually the last program in the "sausage". 
    207221 
    208222The FinalRule command is optional. If it is absent, the final ruleset will not be applied and no version 2 event messages will be released from eqassemble. However, you must have at least one of PrelimRule, RapidRule, FinalRule, or eqassemble won't have anything to do. 
    209  
    210  
     223{{{ 
    211224Default:  none 
    212225Calnet:   FinalRule     4 60 WaitForCodas 
    213  GetAssocFrom inst mod_id               eqas_config             Earthworm setup   
     226}}} 
     227 
     228'''!GetAssocFrom [inst mod_id]'''[[BR]] 
     229Processed by: eqas_config[[BR]] 
     230Function: Earthworm setup 
     231 
    214232Controls the association messages input to eqassemble. Eqassemble 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 eqassemble to process all quakes & links, regardless of their place of origin. 
    215  
     233{{{ 
    216234Default:  none 
    217235Calnet:   GetAssocFrom  INST_MENLO  MOD_BINDER 
    218  GetPicksFrom inst mod_id               eqas_config             Earthworm setup   
     236}}} 
     237 
     238'''!GetPicksFrom [inst mod_id]'''[[BR]] 
     239Processed by: eqas_config[[BR]] 
     240Function: Earthworm setup 
     241 
    219242Controls the pick and coda message input to eqassemble. Eqassemble 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 eqassemble to process all picks & codas, regardless of their place of origin. 
     243 
    220244Note: both binder and eqassemble should be set to listen to the same pick source(s)! 
    221  
     245{{{ 
    222246Default:  none 
    223247Calnet:   GetPicksFrom  INST_WILDCARD  MOD_WILDCARD 
    224  HypCheckInterval M             eqas_config             Event Notification        
     248}}} 
     249 
     250'''!HypCheckInterval [M]'''[[BR]] 
     251Processed by: eqas_config[[BR]] 
     252Function: Event Notification 
     253 
    225254Check the list of currently active events every M seconds to see if they are ready for release under the rapid or final rules. 
    226  
     255{{{ 
    227256Default:  10 (seconds) 
    228257Calnet:   HypCheckInterval   5 
    229  lay depth velocity                    t_com                   model      
     258}}} 
     259 
     260'''lay [depth velocity]'''[[BR]] 
     261Processed by: t_com[[BR]] 
     262Function: model 
     263 
    230264Defines 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. 
     265 
    231266Note: binder and eqassemble calculate travel times independently. Be sure that both programs are using the same velocity model! 
    232  
     267{{{ 
    233268Default:  none                          Calnet:  lay   0.0  4.0 
    234269                                                 lay   3.5  5.9 
    235270                                                 lay  15.0  6.85 
    236271                                                 lay  25.0  7.85 
    237  LogFile switch                         eqas_config             output    
    238  
    239 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 1, eqassemble will write a daily log file(s) called eqassemblexx.log_yyyymmdd where xx is eqassemble's module id (set with "MyModuleId" command) and yyyymmdd is the current UTC date (ex: 19960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
    240  
    241 Default:  none 
    242  maxsite N                               eqas_config            Event Notification        
    243 Restrict the number of phases to be reported for the RapidRule and FinalRule to nsite. Cannot be set greater than the Earthworm limit of 250, which is also the default for this parameter. 
    244          
     272}}} 
     273 
     274'''!LogFile [switch]'''[[BR]] 
     275Processed by: eqas_config[[BR]] 
     276Function: output 
     277 
     278Sets 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, eqassemble will write a daily log file(s) called eqassemblexx.log_yyyymmdd where xx is eqassemble's module id (set with "!MyModuleId" command) and yyyymmdd is the current UTC date (ex: 19960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
     279{{{ 
     280Default:  none 
     281}}} 
     282 
     283'''maxsite [N]'''[[BR]] 
     284Processed by: eqas_config[[BR]] 
     285Function: Event Notification 
     286 
     287Restrict the number of phases to be reported for the !RapidRule and !FinalRule to nsite. Cannot be set greater than the Earthworm limit of 250, which is also the default for this parameter. 
     288{{{         
    245289Default:  MaxPhasePerEq 250 
    246290Calnet:   MaxPhasePerEq 250 
    247  maxsite nsite                           site_com                model    
     291}}} 
     292 
     293'''maxsite [nsite]'''[[BR]] 
     294Processed by: site_com[[BR]] 
     295Fucntion: model 
     296 
    248297Allocates memory to store nsite station locations in the site table. 
    249          
    250 Default:  maxsite 1000                  Calnet:  maxsite 1000 
    251  MyModuleId mod_id                      eqas_config             Earthworm setup   
     298{{{ 
     299Default:  maxsite 1000                   
     300Calnet:  maxsite 1000 
     301}}} 
     302 
     303'''!MyModuleId [mod_id]'''[[BR]] 
     304Processed by: eqas_config[[BR]] 
     305Function: Earthworm setup 
     306 
    252307Sets the module id for labelling 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. 
    253  
    254 Default:  none                          Calnet:  MyModuleId MOD_EQASSEMBLE 
    255  pick_fifo_length N             eqas_config             Earthworm setup   
     308{{{ 
     309Default:  none                           
     310Calnet:  MyModuleId MOD_EQASSEMBLE 
     311}}} 
     312 
     313'''pick_fifo_length [N]'''[[BR]] 
     314Processed by: eqas_config[[BR]] 
     315Function: Earthworm setup 
     316 
    256317Specify the size of the pick FIFO buffer as N picks. This value should be at least as large as binder's pick_fifo_length. 
    257  
     318{{{ 
    258319Default:  1000 
    259320Calnet:   pick_fifo_length 4000 
    260  PipeTo cmdstring                       eqas_config             Earthworm setup   
     321}}} 
     322 
     323'''!PipeTo [cmdstring]'''[[BR]] 
     324Processed by: eqas_config[[BR]] 
     325Function: Earthworm setup 
     326 
    261327Sets the command to which eqassemble will pipe a "binder-finalized" 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. 
     328 
    262329Note that on unix-like systems, you can precede the command with "exec". This will cause the shell which invokes the command to be replaced by the command instead of remaining as the command's parent process. Using this trick in the PipeTo command in each of the sausage sub-programs will save you from keeping several shell instances for no useful purpose. 
    263  
    264  
     330{{{ 
    265331Default:  none 
    266332Calnet:   PipeTo "exec eqbuf eqbuf.d" 
    267  PrelimRule N           eqas_config             Event Notification        
     333}}} 
     334 
     335'''!PrelimRule [N]'''[[BR]] 
     336Processed by: eqas_config[[BR]] 
     337Function: Event Notification 
     338 
    268339The preliminary TYPE_EVENT2K message will be released when N P phases are associated with the event, provided that no higher version TYPE_EVENT2K has already been released for the event. The preliminary event message is assigned version 0. 
     340 
    269341The PrelimRule command is optional. If it is absent, the preliminary ruleset will not be applied and no version 0 event messages will be released from eqassemble. However, you must have at least one of PrelimRule, RapidRule, FinalRule, or eqassemble won't have anything to do. 
    270  
    271  
     342{{{ 
    272343Default:  none 
    273344Calnet:   PrelimRule    25 
    274  psratio value                           t_com                   model    
     345}}} 
     346 
     347'''psratio [value]'''[[BR]] 
     348Processed by: t_com[[BR]] 
     349Function: model 
    275350 
    276351Sets the value of the P/S seismic velocity ratio. 
    277  
    278 Default:  psratio  1.72                 Calnet:  psratio  1.72 
    279  quake_fifo_length N            eqas_config             Earthworm setup   
     352{{{ 
     353Default:  psratio  1.72                  
     354Calnet:  psratio  1.72 
     355}}} 
     356 
     357'''quake_fifo_length [N]'''[[BR]] 
     358Processed by: eqas_config[[BR]] 
     359Function: Earthworm setup 
     360 
    280361Specify the size of the quake FIFO buffer as N events. This value should be at least as large as binder's quake_fifo_length. 
    281  
     362{{{ 
    282363Default:  100 
    283364Calnet:   quake_fifo_length  100 
    284  RapidRule Np Msec SinceX               eqas_config             Event Notification        
     365}}} 
     366 
     367'''!RapidRule [Np Msec SinceX]'''[[BR]] 
     368Processed by: eqas_config[[BR]] 
     369Function: Event Notification 
     370 
    285371The "rapid" TYPE_EVENT2K message will be released at a fixed time after either event origin time, or event detection time (when eqassemble receives the first TYPE_QUAKE2K message for the event), provided at least Np P phases are associated with the event. The time delay is specified as Msec seconds. The starting time of the delay is given in the SinceX string, which can be either SinceOrigin or SinceDetection. This TYPE_EVENT2K will be assigned version 1. It will not be released by eqassemble is a higher version message has already be released for the event. 
    286372This ruleset is intended to be used to initiate a magnitude calculation as soon as possible after an event, before the binder solution has stablized. 
     
    288374The PrelimRule command is optional. If it is absent, the preliminary ruleset will not be applied and no version 0 event messages will be released from eqassemble. However, you must have at least one of PrelimRule, RapidRule, FinalRule, or eqassemble won't have anything to do. 
    289375 
    290  
     376{{{ 
    291377Default:  none 
    292378Calnet:   RapidRule     5 30 SinceOrigin 
    293  ReportS switch                         eqas_config             notification      
     379}}} 
     380 
     381'''!ReportS [switch]'''[[BR]] 
     382Processed by: eqas_config[[BR]] 
     383Function: notification 
    294384 
    295385Sets 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. 
    296  
    297 Default:  none                          Calnet:  ReportS  0 
    298  RingName ring                          eqas_config             Earthworm setup   
     386{{{ 
     387Default:  none                           
     388Calnet:  ReportS  0 
     389}}} 
     390 
     391'''!RingName [ring]'''[[BR]] 
     392Processed by: eqas_config[[BR]] 
     393Function: Earthworm setup 
     394 
    299395Tells eqassemble 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. 
    300  
    301 Default:  none                          Calnet:  RingName PICK_RING 
    302  site name latitude longitude           site_com                model     
     396{{{ 
     397Default:  none                           
     398Calnet:  RingName PICK_RING 
     399}}} 
     400 
     401'''site [name latitude longitude]'''[[BR]] 
     402Processed by: site_com[[BR]] 
     403Function: model 
     404 
    303405Enters 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 eqassemble. 
    304  site_file filename                     site_com                model     
     406 
     407'''site_file [filename]'''[[BR]] 
     408Processed by: site_com[[BR]] 
     409Function: model 
    305410 
    306411Enters 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 "NEW HYPOINVERSE STATION FILE FOR FULL 10-LETTER STATION NAMES" in calsta2.doc by Fred Klein. Use either one "site_file" command or multiple "site" commands to load the station list into eqassemble. 
    307  WaifTolerance N                eqas_config             OutPut Control    
     412 
     413 
     414'''!WaifTolerance [N]'''[[BR]] 
     415Processed by: eqas_config[[BR]] 
     416Fucntion: OutPut Control 
     417 
    308418When eqassemble is preparing to release a final (version 2) TYPE_EVENT2K message, it logs information about phases associated with the event, and about phases not associated with this event but which have "small" travel time residuals relative to this event. This command gives the largest absolute value residual as N seconds. See Description of eqassemble's log file for more details about eqassemble's log files. 
    309  
     419{{{ 
    310420Default:  none 
    311421Calnet:   WaifTolerance  4.0 
    312  
     422}}} 
    313423 
    314424=== DESCRIPTION OF EQASSEMBLE'S LOG FILE ===