Changes between Version 2 and Version 3 of eqassemble


Ignore:
Timestamp:
05/26/12 10:32:37 (8 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • eqassemble

    v2 v3  
    4444 
    4545== Configuration File Commands == 
     46On startup, eqassemble reads the configuration file named on the command-line. Commands in this file set up all parameters used in making earthquake notifications. In the control file, lines may begin with a valid eqassemble command (listed below) or with one of 2 special characters: 
     47{{{ 
     48    #  marks the line as a comment (example: # This is a comment). 
     49 
     50    @  allows control files to be nested; one control file can be 
     51       accessed from another with the command "@" followed by 
     52       a string representing the path name of the next control file 
     53       (example: @model.d). 
     54}}} 
     55Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!). 
     56 
     57=== EXAMPLE CONFIGURATION FILE === 
     58{{{ 
     59 # This is Eqassemble's Parameter File 
     60 
     61# Basic Earthworm setup: 
     62#----------------------- 
     63 MyModuleId   MOD_EQASSEMBLE    # Module id for this instance of eqassemble 
     64 RingName     PICK_RING     # Ring to get input from 
     65 HeartbeatInt 30            # seconds between heartbeats to statmgr 
     66 LogFile      1             # 0 = turn off disk log file; 
     67                            # 1 = turn on disk log 
     68                            # 2 = write disk log but not to stderr/stdout 
     69 
     70# List the message logos to grab from transport ring 
     71#               Installation       Module          Message Types 
     72#----------------------------------------------------------------- 
     73 GetPicksFrom   INST_WILDCARD    MOD_WILDCARD    # pick2k & coda2k 
     74 GetAssocFrom   INST_MENLO       MOD_BINDER      # quake2k & link2k 
     75 
     76# Send output to the following command (uncomment one): 
     77#------------------------------------------------------ 
     78 PipeTo "exec eqbuf eqbuf.d"     # buffer events for downstream modules 
     79#PipeTo "log_everything"         # end chain here for debugging 
     80 
     81# Load station list 
     82#------------------ 
     83 maxsite     3500 
     84 site_file   calsta.hinv 
     85 
     86# Load crustal model 
     87# Refer to file containing "lay" commands, or list them here 
     88#----------------------------------------------------------- 
     89@ncal_model.d# Load the central California crustal model 
     90 
     91 
     92# Set pick/quake FIFO lengths (must be >= binder's fifo lengths) 
     93#--------------------------------------------------------------- 
     94 pick_fifo_length  1000  # optional: default = 1000 
     95 quake_fifo_length  100  # optional: default = 100 
     96 
     97# Control how/when events are reported 
     98#------------------------------------- 
     99 ReportS      0     # 0 = do not send S-phases to next process 
     100                    # non-zero = do send S-phases to next process 
     101 HypCheckInterval  5.0  # interval (sec) at which to check all hypocenters 
     102                    #   to see if it's time to report an event 
     103 
     104 
     105# Rules for reporting events 
     106#--------------------------- 
     107# At least one of these rules must be given; there are no defaults 
     108# Syntax: 
     109#       PrelimRule numPhases 
     110#               Event2K message released with version 0 when event has 
     111#                P phases associated. 
     112#       RapidRule numPhases seconds SinceOrigin 
     113#     or 
     114#       RapidRule numPhases seconds SinceDetection 
     115#               Event2K message released with version 1  since 
     116#               origin or detection time provided  P phases 
     117#               associated. 
     118#       FinalRule numPhases seconds [WaitForCodas] 
     119#               Event2K message released with version 2 when solution has 
     120#               been stable for , has  P phases associated, 
     121#               and optionally after codas have arrived. 
     122# Codas are reported only with the FinalRule and only if the 
     123# WaitForCodas flag is included in the FinalRule command 
     124# 
     125PrelimRule    25 
     126RapidRule     5 30 SinceDetection 
     127FinalRule     4 60 WaitForCodas 
     128 
     129# If we are going to wait for codas, and some picks are imported from 
     130# other Earthworm Installations, eqassemble can optionally wait for codas 
     131# from those other installations with one or more of: 
     132# CodaFromInst InstId 
     133# You do not need to list your own Inst ID. 
     134# CodaFromInst is ignored if the FinalRule does not wait for codas. 
     135CodaFromInst INST_MENLO 
     136 
     137# DataSrc: single character to indicate the source of phase data 
     138DataSrc    W 
     139 
     140# MaxPhasesPerEq: restrict the number of phases to be reported for 
     141# the RapidRule and FinalRule to this value. Cannot be set greater than 
     142# the Earthworm limit of 250, which is also the default for this parameter 
     143MaxPhasesPerEq 250 
     144 
     145# Control debugging info to log 
     146#------------------------------ 
     147 WaifTolerance   4.0  # tolerance (sec) for noting waif picks for 
     148                      #   in log file. (optional: default = 4.0) 
     149}}} 
     150 
     151=== FUNCTIONAL COMMAND LISTING === 
     152 
     153Below are the commands recognized by eqassemble, grouped by the function they influence. Some of the commands are marked "required"; they describe the Earthworm system setup and the network model. These commands must be specified in the control file in order for eqassemble to operate. 
     154{{{ 
     155        Earthworm system setup: 
     156                GetAssocFrom    required 
     157                GetPicksFrom    required 
     158                MyModuleId      required 
     159                PipeTo          required 
     160                RingName        required 
     161                pick_fifo_length 
     162                quake_fifo_length 
     163 
     164        Seismic network/model definition: 
     165                lay             required 
     166                psratio 
     167                site            \  site list required; specify with 
     168                site_file       /  either "site" or "site_file" 
     169                maxsite 
     170 
     171        Event Notification: 
     172                PrelimRule 
     173                RapidRule 
     174                FinalRule 
     175                CodaFromInst 
     176                HypCheckInterval 
     177                ReportS          required 
     178                DataSrc 
     179                MaxPhasesPerEq 
     180 
     181        Output Control: 
     182                LogFile          required 
     183                WaifTolerance 
     184}}} 
     185 
     186=== ALPHABETIC COMMAND LISTING & DESCRIPTION === 
     187 
     188In 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. 
     189 
     190The following list is organized by: 
     191 
     192command [argument here] 
     193 
     194 
    46195 
    47196== Helpful Hints ==