Changes between Version 2 and Version 3 of liss2ew


Ignore:
Timestamp:
03/18/12 16:37:57 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • liss2ew

    v2 v3  
    1515Besides the ASL, there are several other LISS servers. Some digital seismographs produce miniSEED. There is be an earthworm LISS server module, [wiki:ew2liss ew2liss]. This will allow the exchange of earthworm trace data by an alternate format to the current [wiki:Import-Export import/export] combination. 
    1616 
     17On startup, liss2ew reads the configuration file named on the command line. Commands in this file set all the parameters used for configuring the Earthworm LISS client module. (LISS is the Live Internet Seismic Server.) In the control file, lines may begin with a valid liss2ew command (listed below) or with one of 2 special characters: 
     18{{{ 
     19#  marks the line as a comment (example: # This is a comment). 
     20 
     21@  allows control files to be nested; one control file can be 
     22   accessed from another with the command "@" followed by 
     23   a string representing the path name of the next control file 
     24   (example: @model.d). 
     25}}} 
     26Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!). Blank lines are also permitted in the control file. 
     27 
     28=== FUNCTIONAL COMMAND LISTING === 
     29 
     30Below are the commands recognized by liss2ew, grouped by the function they influence. Most of the commands are required; they may be specified in any order in the control file. 
     31{{{ 
     32   Earthworm system setup: 
     33                MyModuleId            required 
     34                OutRing                 required 
     35                HeartBeatInterval      required 
     36                Debug 
     37 
     38        LISS server and input parameters: 
     39                LISSaddr                required 
     40                LISSport                required 
     41                lenSEED                 optional 
     42                SocketTimeout           optional 
     43 
     44        Data output parameters: 
     45                TraceLength             required 
     46                MaxSCNs                 required 
     47                AcceptSCNL              required 
     48}}} 
     49 
     50=== ALPHABETIC COMMAND LISTING & DESCRIPTION === 
     51 
     52In 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 example commands are listed after each command description. 
     53 
     54The following list is organized by: 
     55 
     56command [argument here] 
     57 
     58'''!AcceptSCNL [station component net location pinno]'''[[BR]] 
     59Processed by: ReadConfig[[BR]] 
     60Function: Data selection 
     61 
     62Specifies one stream of data to be read from the LISS and output as trace data. The station, component, and network are used to set the earthworm SCN of this data stream. These three parameters must be given explicitly (no wildcards). Many LISS channels are also identified by a location code. If you are getting data from the ASL LISS, see their table of available data streams. If you don't know the location code, you can try running dumpseed to see what is being served. The location code may be *, the wildcard. If you use the wildcard and more than one location code is available for this SCN, liss2ew will report errors such as samplerate changing as it reads first one location code and then the other. To enter the empty location code (seen on some ASL channels, use the empty string "". 
     63You must give one AcceptSCNL command for each SCN that you want to receive from the LISS. However, you should not specify more than one AcceptSCNL for the same SCN and different location codes. The rest of earthworm does not know about location codes, so the two data streams would get mixed together with bad results. 
     64 
     65The pin number pinno is used for internal earthworm use. 
     66 
     67{{{ 
     68Default:  none 
     69Example:  AcceptSCNL ANMO BHZ IU 00   1234 
     70}}} 
     71 
     72'''Debug'''[[BR]] 
     73Processed by: ReadConfig[[BR]] 
     74Function: Earthworm setup 
     75 
     76Turns on debug logging for liss2ew. 
     77{{{ 
     78Default:  no debug logging 
     79Example:  Debug 
     80}}} 
     81 
     82'''!HeartBeatInterval [nsec]'''[[BR]] 
     83Processed by: !ReadConfig[[BR]] 
     84Function: Earthworm Setup 
     85 
     86Defines the number of seconds, nsec between TYPE_HEARTBEAT messages issued by liss2ew. 
     87{{{ 
     88Default:  none 
     89Example:  HeartBeatInterval 30 
     90}}} 
     91 
     92'''lenSEED [bytes]'''[[BR]] 
     93Processed by: !ReadConfig[[BR]] 
     94Function: LISS parameters 
     95 
     96Defines the number of bytes in the miniSEED records to be read from the LISS. For the ASL LISS, this is 512 bytes. 
     97{{{ 
     98Default:  512 
     99Example:  lenSEED 4096 
     100}}} 
     101 
     102'''LISSaddr [address]'''[[BR]] 
     103Processed by: !ReadConfig[[BR]] 
     104Function: LISS parameters 
     105 
     106Specify the address of the LISS. This can be either on IP address (four period-separated numbers) or the domain name of the server. 
     107 
     108{{{ 
     109Default:  none 
     110Example:  LISSaddr      anmo.iu.liss.org 
     111}}} 
     112 
     113'''LISSport [port]'''[[BR]] 
     114Processed by: !ReadConfig[[BR]] 
     115Function: LISS parameters 
     116 
     117Specifies the IP port number for the LISS. Normally this is 4000. 
     118 
     119{{{ 
     120Default:  none 
     121Example:  LISSport  4000 
     122}}} 
     123 
     124'''!LogFile [switch]'''[[BR]] 
     125Processed by: !ReadConfig[[BR]] 
     126Function: Earthworm Setup 
     127 
     128Sets 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, liss2ew will write daily log file(s) called nnnnnxx.log_yyyymmdd where nnnnn is the name of the configuration file (with the suffix `.d' removed), xx is liss2ew'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). 
     129{{{ 
     130Default:  none 
     131Example:  LogFile   1 
     132}}} 
     133 
     134'''!MaxSCNs [n]'''[[BR]] 
     135Processed by: !ReadConfig[[BR]] 
     136Function: Data Selection 
     137 
     138Specifies the number of !AcceptSCNL commands to be found in this configuration file. 
     139{{{ 
     140Default:  none 
     141Example:  MaxSCNs   3 
     142}}} 
     143 
     144'''!MyModuleId [mod_id]'''[[BR]] 
     145Processed by: !ReadConfig[[BR]] 
     146Function: Earthworm setup 
     147 
     148Sets the module id for labeling all outgoing trigger, heartbeat, and error messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates to a unique single-byte number. 
     149{{{ 
     150Default:  none 
     151Example:  MyModuleId MOD_L2E_ANMO 
     152}}} 
     153 
     154'''!OutRing [ring]'''[[BR]] 
     155Processed by: !ReadConfig[[BR]] 
     156Function: Earthworm setup 
     157 
     158Tells liss2ew 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. 
     159{{{ 
     160Default:  none 
     161Example:  OutRing WAVE_RING 
     162}}} 
     163 
     164'''!SocketTimeout [seconds]'''[[BR]] 
     165Processed by: !ReadConfig[[BR]] 
     166Function: LISS parameters 
     167 
     168Defines the number of seconds to wait for response from the LISS. This time interval must not be large than the !HeartBeatInterval. Unlike in certain other Earthworm modules, you cannot turn off the timeout by using a value of -1. 
     169{{{ 
     170Default:  same as HeartBeatInterval 
     171Example:  SocketTimeout   20 
     172}}} 
     173 
     174'''!TraceLength [samples]'''[[BR]] 
     175Processed by: !ReadConfig[[BR]] 
     176Function: Data parameters 
     177 
     178Specify the number of samples to put in each TRACE_BUF message. Liss2ew always trace data in `long integer' (four byte) format. The total length of the output TRACE_BUF messages will be 64 + 4 * samples. Values are restricted to the range of 10 - 1000. 
     179{{{ 
     180Default:  none 
     181Example:  TraceLength  100 
     182}}} 
     183 
     184=== Sample Configuration File === 
     185{{{ 
     186# 
     187#                     Configuration File for liss2ew 
     188# 
     189MyModId          MOD_LISS2EW 
     190OutRing          WAVE_RING       # Transport ring to write output to, 
     191HeartBeatInterval     30         # Heartbeat interval, in seconds, 
     192LogFile               1          # 1 -> Keep log, 0 -> no log file 
     193#Debug                           # Write out debug messages (optional) 
     194 
     195 
     196LISSaddr   anmo.iu.liss.org      # IP address of the LISS (server) 
     197                                 # If you have DNS configured, you may also 
     198                                 # give the domain name of the LISS. 
     199LISSport    4000                 # Port number for LISS; often this is 4000 
     200 
     201lenSEED      512                 # The size of SEED records to read from LISS 
     202                                 # OPTIONAL; defaults to 512 bytes. 
     203 
     204SocketTimeout  30                # Socket timeout in seconds; not more than 
     205                                 # HeartBeatInterval 
     206 
     207TraceLength    100               # Number of trace data samples to put in one 
     208                                 # TRACE_BUF packet. Range is 10 - 1000 
     209 
     210MaxSCNs        3                 # Number of SCNs to accept; must be at least 
     211                                 # the number of AcceptSCNL commands. 
     212# List each sta/comp/net/location that you expect from LISS in an 
     213# "AcceptSCNL" command. Location code (LC) is a 2-digit code to further 
     214# identify a seismological data path. LC (and ONLY LC) may be given as `*' to 
     215# specify a wildcard. If the LISS has more than one LC for a give SCN, 
     216# using the wildcard will generate errors in log. 
     217# Do NOT specify the same SCN with two different LC values, as this will 
     218# cause great confusion within earthworm!!!! 
     219# If liss2ew sees an SCNL which is not listed here, it will be ignored. 
     220# On each line after the SCNL, list a pinnumber to use for this SCNL. 
     221 
     222#          site comp net LC pinno 
     223#          ---- ---- --- -- ----- 
     224AcceptSCNL  ANMO BHZ  IU 00 1234 
     225AcceptSCNL  ANMO BH1  IU 00 1235 
     226AcceptSCNL  ANMO BH2  IU 00 1236 
     227}}} 
     228 
    17229== Helpful Hints ==