Changeset 4571


Ignore:
Timestamp:
08/18/11 13:28:39 (10 years ago)
Author:
stefan
Message:

lyris -> google groups

Location:
trunk
Files:
242 edited

Legend:

Unmodified
Added
Removed
  • trunk/ewdoc/WEB_DOC/DBMS/CUSP_Schema.html

    r2365 r4571  
    2929<FONT SIZE=2><P>&nbsp;</P></font></DIR> 
    3030</DIR><hr><address>Questions? Issues? <a 
    31  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    32  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     31 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     32 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    3333</BODY> 
    3434</HTML> 
  • trunk/ewdoc/WEB_DOC/DBMS/EWv5Design.html

    r2365 r4571  
    180180<B><P>4.3.5 Historical Configuration "Snapshots"</P> 
    181181</B> 
    182 <P>Because epoch date-time ranges are saved for each channel, constructing historical  
    183   response and/or configuration snapshots is straightforward. This capability  
    184   supports such requirements as generating dataless SEED volumes, providing response  
    185   information for historical data accessed via AutoDRM, etc. It also makes it  
    186   possible to smoothly handle the impact of field equipment changes on routine  
    187   processing, particularly for events that may be revised some time after they  
     182<P>Because epoch date-time ranges are saved for each channel, constructing historical 
     183  response and/or configuration snapshots is straightforward. This capability 
     184  supports such requirements as generating dataless SEED volumes, providing response 
     185  information for historical data accessed via AutoDRM, etc. It also makes it 
     186  possible to smoothly handle the impact of field equipment changes on routine 
     187  processing, particularly for events that may be revised some time after they 
    188188  are recorded.</P> 
    189189<hr><address>Questions? Issues? <a 
    190  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    191  target="_blank">Subscribe to the Earthworm List (earthw). </a></address></BODY> 
     190 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     191 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></BODY> 
    192192</HTML> 
  • trunk/ewdoc/WEB_DOC/DBMS/dbms-modules.html

    r2365 r4571  
    1414 
    1515 
    16 <a href="http://www.usgs.gov/"><img src="../images/dark_blue.gif" width="480" height="72" border="0" alt="Visual identity banner and link to the U.S. Geological Survey's home page."></a>  
     16<a href="http://www.usgs.gov/"><img src="../images/dark_blue.gif" width="480" height="72" border="0" alt="Visual identity banner and link to the U.S. Geological Survey's home page."></a> 
    1717 
    1818 
     
    144144<TD align=center>concierge</TD> 
    145145 
    146 <TD>Concierge is the name given to a new method of waveform archiving to the Earthworm database.  
     146<TD>Concierge is the name given to a new method of waveform archiving to the Earthworm database. 
    147147The Concierge makes multiple attempts at archiving the data, and provides incremental results that improve over time. 
    148148 The previous versions of  waveform archivers made only one attempt and were subject to incomplete data retrievals. 
     
    158158<TD align=center>ora_trace_req (Part of Concierge)</TD> 
    159159 
    160 <TD>Reads an Earthworm message TYPE_TRIGLIST2K, converts the channel-trigger lines to  
     160<TD>Reads an Earthworm message TYPE_TRIGLIST2K, converts the channel-trigger lines to 
    161161    snippet requests, and inserts the snippet requests into the DB.  (Front half of 
    162162        Concierge)</TD> 
     
    172172<TD align=center>ora_trace_fetch (Part of Concierge)</TD> 
    173173 
    174 <TD>Reads SnippetRequests from the database, and repeatedly attempts to retrieve  
    175     snippets to fulfill the requests.  It stuffs the snippets into the DB and  
     174<TD>Reads SnippetRequests from the database, and repeatedly attempts to retrieve 
     175    snippets to fulfill the requests.  It stuffs the snippets into the DB and 
    176176        updates/deletes the requests.  (Back half of Concierge)</TD> 
    177177 
     
    249249<TD align=center>email_sender</TD> 
    250250 
    251 <TD>picks up TYPE_EMAIL_MSG messages from the ring, parses them  
    252 and calls the <I>SendMail()</I> earthworm library routine to delivery the message.  
    253 Then, it updates the appropriate entry in the AlarmsAudit table to indicate that  
     251<TD>picks up TYPE_EMAIL_MSG messages from the ring, parses them 
     252and calls the <I>SendMail()</I> earthworm library routine to delivery the message. 
     253Then, it updates the appropriate entry in the AlarmsAudit table to indicate that 
    254254the message has been delivered. 
    255255</TD> 
     
    264264<TD align=center>qdds_sender</TD> 
    265265 
    266 <TD>picks up TYPE_QDDS_MSG messages from the ring, parses them and writes the text  
    267 of the message to the specified QDDS target directory. For now, this program only  
    268 deals with placing the files in CUBE format into the correct directory, leaving the  
    269 bulk of the delivery work to an outside QDDS-capable process.  
     266<TD>picks up TYPE_QDDS_MSG messages from the ring, parses them and writes the text 
     267of the message to the specified QDDS target directory. For now, this program only 
     268deals with placing the files in CUBE format into the correct directory, leaving the 
     269bulk of the delivery work to an outside QDDS-capable process. 
    270270</TD> 
    271271 
     
    298298 
    299299<TD align=center>Jiggle</TD> 
    300 <TD>Jiggle was developed at USGS Pasadena for routine analysis of data collected on  
    301 150 broadband stations by TriNet in Southern California.  
     300<TD>Jiggle was developed at USGS Pasadena for routine analysis of data collected on 
     301150 broadband stations by TriNet in Southern California. 
    302302The Golden development team has incorporated 
    303 the Jiggle analysis package with the earthworm DBMS.  
     303the Jiggle analysis package with the earthworm DBMS. 
    304304</TD> 
    305305 
     
    311311 
    312312<TD align=center>Quick Review</TD> 
    313 <TD>Quick review is a web-based earthquake analysis tool. It is a customized version of SeisGram2K,  
    314 a java applet written by Anthony Lomax (<http://alomax.free.fr/software.html>).  
     313<TD>Quick review is a web-based earthquake analysis tool. It is a customized version of SeisGram2K, 
     314a java applet written by Anthony Lomax (<http://alomax.free.fr/software.html>). 
    315315 
    316316</TD> 
     
    347347 
    348348 
    349 <TD>saves the contents of one or more DB Events to SAC directory(s). archive can then, optionally,  delete  the data for each Event from the database.  
     349<TD>saves the contents of one or more DB Events to SAC directory(s). archive can then, optionally,  delete  the data for each Event from the database. 
    350350</TD> 
    351351 
     
    359359 
    360360<TD align=center>db_cleanup2</TD> 
    361 <TD>db_cleanup2 is a catch-all, time based archiver. Based on rules set in the config file, it saves/deletes Events and unassociated data  
    362 based on time limits. Rules schedule the archiving/deletion of data based on time, magnitude, and location of Events.  
     361<TD>db_cleanup2 is a catch-all, time based archiver. Based on rules set in the config file, it saves/deletes Events and unassociated data 
     362based on time limits. Rules schedule the archiving/deletion of data based on time, magnitude, and location of Events. 
    363363</TD> 
    364364 
     
    391391      U.S. Geological Survey, Reston, VA, USA<br> 
    392392      <address>Questions? Issues? <a 
    393  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    394  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> <br> 
     393 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     394 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> <br> 
    395395      <a href="http://www.usgs.gov/privacy.html">Privacy Statement</a> || <a href="http://www.usgs.gov/disclaimer.html">Disclaimer</a> 
    396396 
     
    403403</table> 
    404404      <p>&nbsp;</p> 
    405       <P>Date Last Modified: April 17, 2002  
     405      <P>Date Last Modified: April 17, 2002 
    406406    </h2> 
    407407</h2></BODY> 
  • trunk/ewdoc/WEB_DOC/DBMS/dbms-prog-index.html

    r2365 r4571  
    88<BODY TEXT="#000000" BGCOLOR="#FAC0A2" LINK="#0000EE" VLINK="#551A8B" ALINK="#FF0000"> 
    99 
    10 <a href="http://www.usgs.gov/"><img src="../images/dark_blue.gif" width="480" height="72" border="0" alt="Visual identity banner and link to the U.S. Geological Survey's home page."></a>  
     10<a href="http://www.usgs.gov/"><img src="../images/dark_blue.gif" width="480" height="72" border="0" alt="Visual identity banner and link to the U.S. Geological Survey's home page."></a> 
    1111 
    1212<H1><IMG SRC="../GIFS/ew.logo.gif" ALT="EARTHWORM Logo" HEIGHT=100 WIDTH=104 ALIGN=TEXTTOP>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    2323<LI><A HREF="Schema/ewdb_psi_217.gif">Parametric Schema</A> 
    2424<LI><A HREF="Schema/ewdb_wvsi_217.gif">Waveform Schema</A> 
    25 <LI><A HREF="Schema/ewdb_xsi_217.gif">External Schema</A>  
    26 <LI><A HREF="Schema/ewdb_cisi_217.gif">Cooked Infrastructure Schema</A>  
     25<LI><A HREF="Schema/ewdb_xsi_217.gif">External Schema</A> 
     26<LI><A HREF="Schema/ewdb_cisi_217.gif">Cooked Infrastructure Schema</A> 
    2727<LI><A HREF="Schema/ewdb_msi_217.gif">Meta Schema</A> 
    2828<LI><A HREF="Schema/ewdb_smsi_217.gif">Strong Motion Parametric Schema</A> 
    2929<LI><A HREF="Schema/Alarms_SchemaDiag.gif">Alarms Schema</A> 
    3030</UL> 
    31 <LI>The Schema Table Description Document is available in Microsoft WORD format at  
     31<LI>The Schema Table Description Document is available in Microsoft WORD format at 
    3232ftp:ghtftp.cr.usgs.gov/earthworm/schema 
    3333</UL> 
    3434<LI>API Documentation</LI> 
    35 <UL>  
     35<UL> 
    3636<LI> <A HREF="ewdb_app_guide2.htm"> Application Writers Guide to the API</A> and in Microsoft Word Format at ftp:ghtftp.cr.usgs.gov/earthworm/schema</LI> 
    3737<LI> <A HREF="API-DOC/index.html"> API Library Functions and Applications</A></LI> 
     
    4444<li> 
    4545<A HREF="Alarms_ProgDoc3.htm">Alarms Programmer Notes</A> </li> 
    46 <LI><A HREF="comparison/default.htm">Schema Comparison</A>  
     46<LI><A HREF="comparison/default.htm">Schema Comparison</A> 
    4747</b></ol><b><B> 
    4848 
     
    5454      U.S. Geological Survey, Reston, VA, USA<br> 
    5555<address>Questions? Issues? <a 
    56  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    57  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> <br> 
     56 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     57 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> <br> 
    5858      <a href="http://www.usgs.gov/privacy.html">Privacy Statement</a> || <a href="http://www.usgs.gov/disclaimer.html">Disclaimer</a> 
    5959 
  • trunk/ewdoc/WEB_DOC/DBMS/schema_motivation.html

    r2365 r4571  
    235235<LI>Web pages.</LI></UL><hr> 
    236236<address>Questions? Issues? <a 
    237  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    238  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     237 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     238 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    239239</BODY> 
    240240</HTML> 
  • trunk/ewdoc/WEB_DOC/OVERVIEW/distribution.html

    r3234 r4571  
    1616<ul> 
    1717  <li>The software distribution is available via FTP: <a 
    18  href="ftp://anonymous%40isti2.com@ftp.isti2.com/pub/ew/">ftp://anonymous%40isti2.com@ftp.isti2.com/pub/ew/</a><br>  
     18 href="ftp://anonymous%40isti2.com@ftp.isti2.com/pub/ew/">ftp://anonymous%40isti2.com@ftp.isti2.com/pub/ew/</a><br> 
    1919If you're asked for a password, leave it blank and click OK. For Safari, try the direct link below, or change the %40 to an @ in the username when the window pops up.<br> 
    20     (The username to get into ftp.isti2.com is &quot;anonymous@isti2.com&quot;.  
    21     That user has no password. Yes the &quot;@&quot; is part of the user name...  
    22     The above URL with %40 substituted for the @ should work if you're using a  
     20    (The username to get into ftp.isti2.com is &quot;anonymous@isti2.com&quot;. 
     21    That user has no password. Yes the &quot;@&quot; is part of the user name... 
     22    The above URL with %40 substituted for the @ should work if you're using a 
    2323    web browser that can do ftp://.) 
    2424        <br>OR try the direct link to our <a href="ftp://ftp.isti2.com/pub/ew">ftp server: ftp://ftp.isti2.com/pub/ew</a></li> 
    25   <li>The software distribution is available via HTTP:  
     25  <li>The software distribution is available via HTTP: 
    2626        <a class="moz-txt-link-freetext" href="http://folkworm.ceri.memphis.edu/ew-dist">http://folkworm.ceri.memphis.edu/ew-dist</a> 
    2727        <br>OR <a href="http://www.isti2.com/ew/distribution">http://www.isti2.com/ew/distribution</a> 
    2828 
    29   
     29 
    3030</ul> 
    3131<b></b> 
     
    3737the Interior</a>, U.S. Geological Survey, Reston, VA, USA<br> 
    3838      <address>Questions? Issues? <a 
    39  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    40  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> <br> 
     39 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     40 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> <br> 
    4141      <a href="http://www.usgs.gov/privacy.html">Privacy Statement</a> 
    4242|| <a href="http://www.usgs.gov/disclaimer.html">Disclaimer</a> || <a 
  • trunk/ewdoc/WEB_DOC/OVERVIEW/ew-email.html

    r2362 r4571  
    77 
    88 
    9 <a href="http://www.usgs.gov/"><img src="../images/dark_blue.gif" width="480" height="72" border="0" alt="Visual identity banner and link to the U.S. Geological Survey's home page."></a>  
     9<a href="http://www.usgs.gov/"><img src="../images/dark_blue.gif" width="480" height="72" border="0" alt="Visual identity banner and link to the U.S. Geological Survey's home page."></a> 
    1010 
    1111 
     
    3737            <address>Questions? Issues? <a 
    3838 href="http://lyris.nmt.edu/read/all_forums/subscribe%5C?name=earth%0Aw" 
    39  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> <br> 
     39 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> <br> 
    4040      <a href="http://www.usgs.gov/privacy.html">Privacy Statement</a> || <a href="http://www.usgs.gov/disclaimer.html">Disclaimer</a> 
    4141 
  • trunk/ewdoc/WEB_DOC/OVERVIEW/overview.html

    r2363 r4571  
    289289</UL> 
    290290 
    291 <LI>5. <A NAME="record.playback"></A>Record/Playback Modules: This is a set of modules which  
    292 can create and play back segments of trace and pick  
    293 data. The main use for this is for fault analysis and creation of test suites. See  
    294 wave_serverV, tankplayer, and waveman2disk for creating and replaying trace  
    295 data. Also see trig2K_putter getter.     
     291<LI>5. <A NAME="record.playback"></A>Record/Playback Modules: This is a set of modules which 
     292can create and play back segments of trace and pick 
     293data. The main use for this is for fault analysis and creation of test suites. See 
     294wave_serverV, tankplayer, and waveman2disk for creating and replaying trace 
     295data. Also see trig2K_putter getter. 
    296296 
    297297 
     
    319319<P> 
    320320<HR> 
    321   <IMG SRC="../GIFS/ew.logo.tiny.gif" HEIGHT=61 WIDTH=71 ALIGN=LEFT><IMG SRC="../GIFS/smusgs.gif" HEIGHT=48 WIDTH=48 ALIGN=RIGHT><FONT SIZE=-1>The  
    322   <B><I>EARTHWORM</I></B> development team is headed by Alex Bittenbinder and  
    323   coordinated by Barbara Bogaert; both with the <A HREF="http://earthquake.usgs.gov/">U.S.  
     321  <IMG SRC="../GIFS/ew.logo.tiny.gif" HEIGHT=61 WIDTH=71 ALIGN=LEFT><IMG SRC="../GIFS/smusgs.gif" HEIGHT=48 WIDTH=48 ALIGN=RIGHT><FONT SIZE=-1>The 
     322  <B><I>EARTHWORM</I></B> development team is headed by Alex Bittenbinder and 
     323  coordinated by Barbara Bogaert; both with the <A HREF="http://earthquake.usgs.gov/">U.S. 
    324324  Geological Survey</A>. &nbsp;&nbsp;&nbsp;&nbsp; <p> 
    325325<address>Questions? Issues? <a 
    326  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    327  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     326 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     327 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    328328  <CENTER><P> 
    329329<HR> 
  • trunk/ewdoc/WEB_DOC/PROGRAMMER/SoftwareStandards.html

    r2369 r4571  
    44 
    55<! Blame Alex and Mitch for this one> 
    6 <H1><IMG  src="../GIFS/ew.logo.gif"ALT="EARTHWORM Logo"  
     6<H1><IMG  src="../GIFS/ew.logo.gif"ALT="EARTHWORM Logo" 
    77height=200 width=208 align=TEXTTOP>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    88Earthworm Software Standards</h1> 
     
    1616  <li><a href="#PROCEDURES">Earthworm Software Procedures</a> 
    1717  <ol> 
    18     <LI><A href="#CORE">Core Software</A>  
    19     <LI><A href="#CONTRIBUTED">Contributed Software</A>  
    20     <LI><A href="#ENCAPSULATED">Encapsulated Software</A>  
    21     <LI><A href="#CONTRIBUTING">Contributing New Software</A>  
    22     <LI><A href="#MODIFYING">Modifying Existing Software</A>  
     18    <LI><A href="#CORE">Core Software</A> 
     19    <LI><A href="#CONTRIBUTED">Contributed Software</A> 
     20    <LI><A href="#ENCAPSULATED">Encapsulated Software</A> 
     21    <LI><A href="#CONTRIBUTING">Contributing New Software</A> 
     22    <LI><A href="#MODIFYING">Modifying Existing Software</A> 
    2323  </ol> 
    24   <LI><A href="#CODING">Earthworm Coding Standards</A>  
     24  <LI><A href="#CODING">Earthworm Coding Standards</A> 
    2525  <OL> 
    26     <LI><A href="#FLEXIBILITY">Flexibility</A>  
    27     <LI><A href="#SYSIND">System Independence</A>  
    28     <LI><A href="#TEDIUM">Reducing the Tedium</A>  
    29     <LI><A href="#ROBUSTNESS">Robustness</A>  
    30     <LI><A href="#MAINTAINABILITY">Maintainability</A>  
     26    <LI><A href="#FLEXIBILITY">Flexibility</A> 
     27    <LI><A href="#SYSIND">System Independence</A> 
     28    <LI><A href="#TEDIUM">Reducing the Tedium</A> 
     29    <LI><A href="#ROBUSTNESS">Robustness</A> 
     30    <LI><A href="#MAINTAINABILITY">Maintainability</A> 
    3131    </LI> 
    3232  </OL> 
     
    4141 
    4242<P> 
    43 Earthworm effort began as a grass-roots  
    44 effort by developers. As such, its spirit was to focus on producing high-quality  
    45 code and to minimize meetings, rules, and procedures. However, success brings  
    46 problems; as the number of contributors and users has grown, so has the need for  
     43Earthworm effort began as a grass-roots 
     44effort by developers. As such, its spirit was to focus on producing high-quality 
     45code and to minimize meetings, rules, and procedures. However, success brings 
     46problems; as the number of contributors and users has grown, so has the need for 
    4747a stated set of operating procedures. Thus, the following is offered in the 
    48 spirit of  "A loose consensus and some working code."  
    49  
    50 <P> 
    51 The Earthworm effort has several objectives: first, it is to provide a rapid  
    52 response system suitable for critical monitoring applications; second, it is to  
    53 operate as a vehicle to integrate the products of various seismic installations  
    54 into a common software package available to all. The first objective implies  
    55 that the system be robust and reliable, which, in turn requires a closely knit  
    56 organization to provide rigorous standards, testing, and rapid bug-fixing. It  
    57 further requires that the system be maintainable, and be suitable for use at a  
    58 variety of installations, including those with modest levels of resources. The  
    59 second objective leads toward a policy of open inclusion of various offerings,  
    60 produced for a variety of purposes and operating environments, and therefore  
    61 engineered to varying degrees of robustness and reliability.  
    62  
    63 <P> 
    64 In response to these needs, an <I>Earthworm Central</I> has evolved, which  
    65 maintains the Earthworm software, accepts contributions, develops code, produces  
    66 documentation, and releases Earthworm versions. This group is also responsible  
    67 for quality assurance and bug fixes. There are currently three rough categories  
     48spirit of  "A loose consensus and some working code." 
     49 
     50<P> 
     51The Earthworm effort has several objectives: first, it is to provide a rapid 
     52response system suitable for critical monitoring applications; second, it is to 
     53operate as a vehicle to integrate the products of various seismic installations 
     54into a common software package available to all. The first objective implies 
     55that the system be robust and reliable, which, in turn requires a closely knit 
     56organization to provide rigorous standards, testing, and rapid bug-fixing. It 
     57further requires that the system be maintainable, and be suitable for use at a 
     58variety of installations, including those with modest levels of resources. The 
     59second objective leads toward a policy of open inclusion of various offerings, 
     60produced for a variety of purposes and operating environments, and therefore 
     61engineered to varying degrees of robustness and reliability. 
     62 
     63<P> 
     64In response to these needs, an <I>Earthworm Central</I> has evolved, which 
     65maintains the Earthworm software, accepts contributions, develops code, produces 
     66documentation, and releases Earthworm versions. This group is also responsible 
     67for quality assurance and bug fixes. There are currently three rough categories 
    6868of software within the Earthworm effort: 
    69 <A href="#CORE">core</A>,  
    70 <A href="#CONTRIBUTED">contributed</A>,  
    71 <A href="#ENCAPSULATED">encapsulated</A>.  
     69<A href="#CORE">core</A>, 
     70<A href="#CONTRIBUTED">contributed</A>, 
     71<A href="#ENCAPSULATED">encapsulated</A>. 
    7272 
    7373<hr> 
    7474 
    7575<P> 
    76 <A name=CORE>1. Core Software</A>  
    77  
    78 <P> 
    79 The core software is intended to meet the requirements of the  
    80 mission-critical objectives. The focus here is to maintain the quality of the  
    81 core software in terms of reliability, maintainability, robustness, and  
    82 longevity. This, in turn, comes down to issues like portability, failure modes,  
    83 and error-detection, -processing, and -recovery. Core software is modified as  
    84 needed under the control of Earthworm Central to fix errors and provide  
    85 enhancements. The distribution system consists mainly of numbered releases and  
    86 patches of various degrees of formality, depending on the urgency of the fix.  
    87  
    88 <P> 
    89 <A href="#TOP">Return to top</A>  
    90  
    91 <HR> 
    92  
    93 <P> 
    94 <A name=CONTRIBUTED>2. Contributed Software</A>  
    95  
    96 <P> 
    97 The Contributed software consists of ancillary programs submitted for  
    98 inclusion with the Earthworm distribution, but which, for whatever reason, don't  
    99 fit into the <A href="#CORE">core</A>  
    100 category. These are distributed <STRONG>as is</STRONG>. An index and  
    101 descriptions of these programs will be maintained.  
    102  
    103 <P> 
    104 <A href="#TOP">Return to top</A>  
    105  
    106 <HR> 
    107  
    108 <P> 
    109 <A name=ENCAPSULATED>3. Encapsulated Software</A>  
    110  
    111 <P> 
    112 A few exotic codes belong to the encapsulated category. These are part of the  
    113 <A href="#CORE">core</A>  
    114 offering, but are maintained by the original authors rather than <I>Earthworm  
    115 Central</I>, either due to the complexity of the algorithm, or because they  
    116 interface to other systems which may be changing. Examples include hypo-inverse  
    117 and the 'coupler' package to the NOAA tsunami warning system. The approach is  
    118 that the author, or the author's institution is responsible for the quality and  
    119 maintenance of the code.  
    120  
    121 <P> 
    122 <A href="#TOP">Return to top</A>  
    123  
    124 <HR> 
    125  
    126 <P> 
    127 <A name=CONTRIBUTING>4. Contributing New Software</A>  
    128  
    129 <P> 
    130 Anyone is welcome to create and contribute software. As mentioned above, most  
    131 any relevant software will be accepted into the distribution as contributed. It  
    132 is only requested that source code, some documentation, and a link to the author be  
    133 provided. <A href="#CORE">Core</A>  
    134 software is usually created or solicited in response to user needs. The  
    135 objective in such cases is to offer the highest-quality code, in terms of the  
    136 above requirements, in the most timely manner possible. After it is acquired it  
    137 is normally reviewed and released to selected sites for testing. Any required  
    138 changes as a result of testing and review will be communicated to the author.  
    139 Such changes may then be implemented either by the author or by others as  
    140 dictated by schedule and available resources.  
    141  
    142 <P> 
    143 <A href="#TOP">Return to top</A>  
    144  
    145 <HR> 
    146  
    147 <P> 
    148 <A name=MODIFYING>5. Modifying existing modules</A>  
    149  
    150 <P> 
    151 Modifications to contributed software are on request by the author. The  
    152 author may simply request to replace the software currently in the distribution  
    153 with a new version, and it will be replaced on the Earthworm ftp site.  
    154  
    155 <P> 
    156 New versions of encapsulated software are generally accepted as they are  
    157 produced, and released by various methods as required by the urgency of the  
    158 situation. Any observed malfunctions are reported to the author.  
    159  
    160 <P> 
    161 Since the performance of core software is the responsibility of <I>Earthworm  
    162 Central</I>, changes to core are made under its control. Reported bugs and  
    163 deficiencies are discussed, and implementation of the fix is assigned, reviewed,  
    164 and incorporated by <I>Earthworm Central</I> as required. Enhancements produced  
    165 by others will similarly be evaluated and inserted by <I>Earthworm Central</I>.  
    166  
    167 <P> 
    168 <A href="#TOP">Return to top</A>  
     76<A name=CORE>1. Core Software</A> 
     77 
     78<P> 
     79The core software is intended to meet the requirements of the 
     80mission-critical objectives. The focus here is to maintain the quality of the 
     81core software in terms of reliability, maintainability, robustness, and 
     82longevity. This, in turn, comes down to issues like portability, failure modes, 
     83and error-detection, -processing, and -recovery. Core software is modified as 
     84needed under the control of Earthworm Central to fix errors and provide 
     85enhancements. The distribution system consists mainly of numbered releases and 
     86patches of various degrees of formality, depending on the urgency of the fix. 
     87 
     88<P> 
     89<A href="#TOP">Return to top</A> 
     90 
     91<HR> 
     92 
     93<P> 
     94<A name=CONTRIBUTED>2. Contributed Software</A> 
     95 
     96<P> 
     97The Contributed software consists of ancillary programs submitted for 
     98inclusion with the Earthworm distribution, but which, for whatever reason, don't 
     99fit into the <A href="#CORE">core</A> 
     100category. These are distributed <STRONG>as is</STRONG>. An index and 
     101descriptions of these programs will be maintained. 
     102 
     103<P> 
     104<A href="#TOP">Return to top</A> 
     105 
     106<HR> 
     107 
     108<P> 
     109<A name=ENCAPSULATED>3. Encapsulated Software</A> 
     110 
     111<P> 
     112A few exotic codes belong to the encapsulated category. These are part of the 
     113<A href="#CORE">core</A> 
     114offering, but are maintained by the original authors rather than <I>Earthworm 
     115Central</I>, either due to the complexity of the algorithm, or because they 
     116interface to other systems which may be changing. Examples include hypo-inverse 
     117and the 'coupler' package to the NOAA tsunami warning system. The approach is 
     118that the author, or the author's institution is responsible for the quality and 
     119maintenance of the code. 
     120 
     121<P> 
     122<A href="#TOP">Return to top</A> 
     123 
     124<HR> 
     125 
     126<P> 
     127<A name=CONTRIBUTING>4. Contributing New Software</A> 
     128 
     129<P> 
     130Anyone is welcome to create and contribute software. As mentioned above, most 
     131any relevant software will be accepted into the distribution as contributed. It 
     132is only requested that source code, some documentation, and a link to the author be 
     133provided. <A href="#CORE">Core</A> 
     134software is usually created or solicited in response to user needs. The 
     135objective in such cases is to offer the highest-quality code, in terms of the 
     136above requirements, in the most timely manner possible. After it is acquired it 
     137is normally reviewed and released to selected sites for testing. Any required 
     138changes as a result of testing and review will be communicated to the author. 
     139Such changes may then be implemented either by the author or by others as 
     140dictated by schedule and available resources. 
     141 
     142<P> 
     143<A href="#TOP">Return to top</A> 
     144 
     145<HR> 
     146 
     147<P> 
     148<A name=MODIFYING>5. Modifying existing modules</A> 
     149 
     150<P> 
     151Modifications to contributed software are on request by the author. The 
     152author may simply request to replace the software currently in the distribution 
     153with a new version, and it will be replaced on the Earthworm ftp site. 
     154 
     155<P> 
     156New versions of encapsulated software are generally accepted as they are 
     157produced, and released by various methods as required by the urgency of the 
     158situation. Any observed malfunctions are reported to the author. 
     159 
     160<P> 
     161Since the performance of core software is the responsibility of <I>Earthworm 
     162Central</I>, changes to core are made under its control. Reported bugs and 
     163deficiencies are discussed, and implementation of the fix is assigned, reviewed, 
     164and incorporated by <I>Earthworm Central</I> as required. Enhancements produced 
     165by others will similarly be evaluated and inserted by <I>Earthworm Central</I>. 
     166 
     167<P> 
     168<A href="#TOP">Return to top</A> 
    169169 
    170170<HR> 
     
    173173<p> 
    174174<h1 align=center> 
    175 <A name=CODING>Earthworm Coding Standards</A>  
     175<A name=CODING>Earthworm Coding Standards</A> 
    176176</h1> 
    177177 
    178178<P> 
    179 Coding standards is a noxious and intrusive idea which invades a developer's  
    180 creative privacy (limited as it is), stifles innovation, and destroys  
    181 morale. At best it is ignored; at worst it incites a counter-productive  
    182 reaction. Yet in order to have any hope of having the system be portable,  
    183 maintainable, and mission critical, some common conventions are needed. Thus the  
    184 intent here is to state coding objectives rather than standards, and to explain  
    185 traditional practices and conventions as they have (not necessarily as they  
    186 should have) evolved within the Earthworm group.  
    187  
    188 <P> 
    189 <A href="#TOP">Return to top</A>  
    190  
    191 <HR> 
    192  
    193 <P> 
    194 <A name=FLEXIBILITY>1. Flexibility:</A>  
    195 <P> 
    196 One module, one function: We've found (the hard way)  
    197 that the idea that 'a module should do only one thing' to be extremely important.  
     179Coding standards is a noxious and intrusive idea which invades a developer's 
     180creative privacy (limited as it is), stifles innovation, and destroys 
     181morale. At best it is ignored; at worst it incites a counter-productive 
     182reaction. Yet in order to have any hope of having the system be portable, 
     183maintainable, and mission critical, some common conventions are needed. Thus the 
     184intent here is to state coding objectives rather than standards, and to explain 
     185traditional practices and conventions as they have (not necessarily as they 
     186should have) evolved within the Earthworm group. 
     187 
     188<P> 
     189<A href="#TOP">Return to top</A> 
     190 
     191<HR> 
     192 
     193<P> 
     194<A name=FLEXIBILITY>1. Flexibility:</A> 
     195<P> 
     196One module, one function: We've found (the hard way) 
     197that the idea that 'a module should do only one thing' to be extremely important. 
    198198It's more expedient to write one module to do several related functions, but the 
    199199result is a complex module with numerous switches and options, and a maintenance 
    200200and stability problem, in that enhancements to one of the functions may affect 
    201 the others. Single-function modules, on the other hand, results in  
     201the others. Single-function modules, on the other hand, results in 
    202202code which is simpler to understand and maintain. Separate, similar modules may 
    203203lead to identical code in multiple modules. The solution is to place such code 
    204204into utility functions, and place those functions into the utility library 
    205 (/src/libsrc/util).  
    206  
    207 <P> 
    208 One input, one output: In principle, a module can connect to any number of  
     205(/src/libsrc/util). 
     206 
     207<P> 
     208One input, one output: In principle, a module can connect to any number of 
    209209transport rings and use any number of 'back-door' communication schemes. 
    210210However, the idea of standard-in and standard-out (one input ring, one output ring) 
     
    214214performance, there's no harm in a module dumping various kinds of messages onto 
    215215one output ring, and contemporary hardware can easily support very high traffic 
    216 on transport rings.  
    217  
    218 <P><A href="#TOP">Return to top</A>  
    219  
    220 <HR> 
    221  
    222 <P> 
    223 <A name=SYSIND>2. System independence:</A>  
     216on transport rings. 
     217 
     218<P><A href="#TOP">Return to top</A> 
     219 
     220<HR> 
     221 
     222<P> 
     223<A name=SYSIND>2. System independence:</A> 
    224224<P> 
    225225OS Kernel functions: Given our limited resources, the principle is to run on the 
     
    227227To date, Earthworm has survived five operating systems. In the process, the 
    228228tradition has developed of using wrapper routines for system-specific calls, 
    229 and producing  
    230 different versions of such routines for each operating system. Such routines are  
    231 kept in system-specific libraries (currently .../src/libsrc/solaris and  
    232 .../src/libsrc/winnt), and the correct library  
    233 is specified at link-time via environment variables. Thus, for example, the  
    234 routine sleep_ew() wraps the NT "Sleep()" call, and the Solaris "nanosleep()"  
    235 call, and modules which use the sleep_ew() function can run on either  
    236 system.  
    237  
    238 <P> 
    239 To preserve this, of course, implies that wrapper routines will be produced as needed.  
    240  
    241 <P><A href="#TOP">Return to top</A>  
    242  
    243 <HR> 
    244  
    245 <P> 
    246 <A name=TEDIUM>3. Reducing the tedium:</A>  
    247 <P> 
    248 Start with a template. The Earthworm architecture imposes an overhead burden  
    249 on a module. This includes connecting to transport rings, reading and writing  
    250 messages, reading the parameter file, error logging, etc. We've found that the  
    251 most painless way of coding this is to start with an existing module which is  
    252 similar in structure to the module to be written, and to modify it as needed.  
    253 Another approach is to use the "template" module in  
    254 /src/diagnostic_tools/template. This tends to reduce these tasks to cut and past  
    255 operations, and produces code which is easy for others to maintain.  
    256  
    257 <P> 
    258 Earthworm utilities: /src/libsrc/util/ contains various utility routines such  
    259 as message parsers and format generators. Using these can save much tedious  
    260 effort, and aids portability.  
    261  
    262 <P><A href="#TOP">Return to top</A> 
    263  
    264 <HR> 
    265  
    266 <P><A name=ROBUSTNESS>4. Robustness:</A>  
    267  
    268 <P> 
    269 Error reporting. This is best appreciated by those who get stuck installing  
    270 and maintaining Earthworm systems. A major frustration is the situation when a  
    271 module which exits with no error message, or a message which not meaningful to  
    272 the people who must maintain the system. This occurs most often during  
    273 configuration, when the parameter files are being created and debugged. A  
    274 shocking amount of installation time can be spent resolving such problems. A  
    275 more serious case is when a module exits during run-time because of an unusual  
    276 asynchronous condition (e.g. receiving an oversize message) without adequately  
    277 reporting the cause. If such events are rare, finding the problem can become  
    278 extremely difficult and the consequence of such failures is potentially very  
    279 serious.  
    280  
    281 <P> 
    282 "Works as long as there are no earthquakes". There are numerous horror  
    283 stories of systems which had performed well for long time, and failed when a  
    284 major earthquake occurred. Some classic problem areas include:  
     229and producing 
     230different versions of such routines for each operating system. Such routines are 
     231kept in system-specific libraries (currently .../src/libsrc/solaris and 
     232.../src/libsrc/winnt), and the correct library 
     233is specified at link-time via environment variables. Thus, for example, the 
     234routine sleep_ew() wraps the NT "Sleep()" call, and the Solaris "nanosleep()" 
     235call, and modules which use the sleep_ew() function can run on either 
     236system. 
     237 
     238<P> 
     239To preserve this, of course, implies that wrapper routines will be produced as needed. 
     240 
     241<P><A href="#TOP">Return to top</A> 
     242 
     243<HR> 
     244 
     245<P> 
     246<A name=TEDIUM>3. Reducing the tedium:</A> 
     247<P> 
     248Start with a template. The Earthworm architecture imposes an overhead burden 
     249on a module. This includes connecting to transport rings, reading and writing 
     250messages, reading the parameter file, error logging, etc. We've found that the 
     251most painless way of coding this is to start with an existing module which is 
     252similar in structure to the module to be written, and to modify it as needed. 
     253Another approach is to use the "template" module in 
     254/src/diagnostic_tools/template. This tends to reduce these tasks to cut and past 
     255operations, and produces code which is easy for others to maintain. 
     256 
     257<P> 
     258Earthworm utilities: /src/libsrc/util/ contains various utility routines such 
     259as message parsers and format generators. Using these can save much tedious 
     260effort, and aids portability. 
     261 
     262<P><A href="#TOP">Return to top</A> 
     263 
     264<HR> 
     265 
     266<P><A name=ROBUSTNESS>4. Robustness:</A> 
     267 
     268<P> 
     269Error reporting. This is best appreciated by those who get stuck installing 
     270and maintaining Earthworm systems. A major frustration is the situation when a 
     271module which exits with no error message, or a message which not meaningful to 
     272the people who must maintain the system. This occurs most often during 
     273configuration, when the parameter files are being created and debugged. A 
     274shocking amount of installation time can be spent resolving such problems. A 
     275more serious case is when a module exits during run-time because of an unusual 
     276asynchronous condition (e.g. receiving an oversize message) without adequately 
     277reporting the cause. If such events are rare, finding the problem can become 
     278extremely difficult and the consequence of such failures is potentially very 
     279serious. 
     280 
     281<P> 
     282"Works as long as there are no earthquakes". There are numerous horror 
     283stories of systems which had performed well for long time, and failed when a 
     284major earthquake occurred. Some classic problem areas include: 
    285285<UL> 
    286   <LI>Careless algorithm design, which fails to correctly handle extreme input  
    287       values (or volume).  
    288   <LI>Code which requests additional resources during an event. For example, a  
    289       module which requests additional memory proportional to the size of an event  
    290       may fail only during large events, when sufficient memory may be temporarily  
    291       unavailable.  
    292   <LI>Insufficient internal buffering. CPU time will likely become more scarce  
    293       during a large event, and a module must survive such periods gracefully. Note  
    294       that a standard practice for such modules is to use a separate thread to  
    295       acquire input messages, and to use the library buffering routines between the  
     286  <LI>Careless algorithm design, which fails to correctly handle extreme input 
     287      values (or volume). 
     288  <LI>Code which requests additional resources during an event. For example, a 
     289      module which requests additional memory proportional to the size of an event 
     290      may fail only during large events, when sufficient memory may be temporarily 
     291      unavailable. 
     292  <LI>Insufficient internal buffering. CPU time will likely become more scarce 
     293      during a large event, and a module must survive such periods gracefully. Note 
     294      that a standard practice for such modules is to use a separate thread to 
     295      acquire input messages, and to use the library buffering routines between the 
    296296      acquisition thread the processing thread. </LI> 
    297297</UL> 
    298298 
    299299<P> 
    300 Memory leaks. There have been modules which passed various tests, but which  
    301 caused the system to hang after weeks of running by slowly draining available  
    302 memory. This, plus the event-driven failure mode above, makes run-time memory  
    303 requests a very dangerous practice. It is far better to do all malloc()'s only  
    304 at start-up time and 'waste' memory, rather than crashing the system later.  
    305  
    306 <P><A href="#TOP">Return to top</A>  
    307  
    308 <HR> 
    309  
    310 <P> 
    311 <A name=MAINTAINABILITY>5. Maintainability:</A>  
    312  
    313 <P> 
    314 Given the 'community' objective of the Earthworm distribution, it is crucial  
    315 that the code be easily understood, modified, and maintained by others. People  
    316 with various skill levels and available time should be able to understand and  
    317 modify the distributed code. Considerations here include:  
     300Memory leaks. There have been modules which passed various tests, but which 
     301caused the system to hang after weeks of running by slowly draining available 
     302memory. This, plus the event-driven failure mode above, makes run-time memory 
     303requests a very dangerous practice. It is far better to do all malloc()'s only 
     304at start-up time and 'waste' memory, rather than crashing the system later. 
     305 
     306<P><A href="#TOP">Return to top</A> 
     307 
     308<HR> 
     309 
     310<P> 
     311<A name=MAINTAINABILITY>5. Maintainability:</A> 
     312 
     313<P> 
     314Given the 'community' objective of the Earthworm distribution, it is crucial 
     315that the code be easily understood, modified, and maintained by others. People 
     316with various skill levels and available time should be able to understand and 
     317modify the distributed code. Considerations here include: 
    318318<UL> 
    319   <LI>Long, leading comments which give the reader insight into the motivations  
    320     for the code being as it is. Consider that the reader may be less skilled and  
    321     familiar with the algorithm than the author.  
    322   <LI>Simple, flexible coding. Most developers are familiar with horrors of  
    323       dense, 'elegant' code, written in a minimum number of lines of source code.  
    324       The usual excuse for this practice is efficiency, but this is hard to justify  
    325       given modern hardware and optimizing compilers. More realistically, this is  
    326       usually a pathetic attempt by the author to impress the reader with their  
    327       cleverness. This style creates problems in that it takes longer to understand  
    328       the code, and more code has to be disturbed to make modifications.  
    329   <LI>Intuitive naming conventions. Cute or terse file and variable names  
    330       may be convenient and amusing to the author, but make things difficult for  
    331       people who follow, and detract from the author's reputation.  
    332   <LI>Documentation. The primary documentation is comments in the source code.  
    333       Beyond that, the author is encouraged to write a short description for  
     319  <LI>Long, leading comments which give the reader insight into the motivations 
     320    for the code being as it is. Consider that the reader may be less skilled and 
     321    familiar with the algorithm than the author. 
     322  <LI>Simple, flexible coding. Most developers are familiar with horrors of 
     323      dense, 'elegant' code, written in a minimum number of lines of source code. 
     324      The usual excuse for this practice is efficiency, but this is hard to justify 
     325      given modern hardware and optimizing compilers. More realistically, this is 
     326      usually a pathetic attempt by the author to impress the reader with their 
     327      cleverness. This style creates problems in that it takes longer to understand 
     328      the code, and more code has to be disturbed to make modifications. 
     329  <LI>Intuitive naming conventions. Cute or terse file and variable names 
     330      may be convenient and amusing to the author, but make things difficult for 
     331      people who follow, and detract from the author's reputation. 
     332  <LI>Documentation. The primary documentation is comments in the source code. 
     333      Beyond that, the author is encouraged to write a short description for 
    334334      publication on the Earthworm web site.</LI> 
    335335</UL> 
     
    337337<! **********************   END PAGE BLURB   ***************************************> 
    338338 
    339 <P><A href="#TOP">Return to top</A>  
     339<P><A href="#TOP">Return to top</A> 
    340340 
    341341<HR> 
    342342 
    343343<address>Questions? Issues? <a 
    344  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    345  target="_blank">Subscribe to the Earthworm List (earthw). </a></address></BODY></HTML> 
     344 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     345 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></BODY></HTML> 
  • trunk/ewdoc/WEB_DOC/PROGRAMMER/libsrc.html

    r2369 r4571  
    423423 *           *pf  pointer to the FACT structure that will be filled in 
    424424 *                by prepFFT for this FFT. 
    425  * returns:  size of FFT on success,  
     425 * returns:  size of FFT on success, 
    426426 *           -1 on failure (out of memory; not logged) 
    427427 *           -2 on other errors, logged here 
     
    10061006#include &lt;transfer.h> 
    10071007 
    1008 int convertWave(double input[], long npts, double deltat,  
    1009                 ResponseStruct *origRS, ResponseStruct *finalRS,  
    1010                 double freq[4], int retFD, long *pPadLen, long *pnfft,  
     1008int convertWave(double input[], long npts, double deltat, 
     1009                ResponseStruct *origRS, ResponseStruct *finalRS, 
     1010                double freq[4], int retFD, long *pPadLen, long *pnfft, 
    10111011                double output[], long outBufLen, double *work, double *workFFT) 
    10121012/* 
    10131013 * convertWave: converts a waveform (time series) from its original response 
    10141014 *              function to a new response function. This conversion is done 
    1015  *              in the frequency domain. The frequency response of the  
     1015 *              in the frequency domain. The frequency response of the 
    10161016 *              transfer function may be tapered. The input data will be 
    10171017 *              padded in the time-domain. The amount of padding is determined 
     
    10311031 *                   or in time-domain (if retFD == 0) 
    10321032 *                   If the output is to stay in the frequency domain, 
    1033  *                   be sure you understand how the results are laid out.  
     1033 *                   be sure you understand how the results are laid out. 
    10341034 *                   See the comments in the FFT package: currently sing.c 
    10351035 *           padlen: The pad length to be applied to data before transforming 
     
    10391039 *             nfft: The size of the FFT chosen, based on npts + *padlen 
    10401040 *                   If the returned value of nfft + padlen is less than 
    1041  *                   npts, then convertWave had to effectively truncate the  
     1041 *                   npts, then convertWave had to effectively truncate the 
    10421042 *                   raw trace in order to fit the processed trace in 
    10431043 *                   the limit of outBufLen. 
    10441044 *           output: array of values output from the conversion 
    1045  *                   This array must be allocated by the caller.  
     1045 *                   This array must be allocated by the caller. 
    10461046 *        outBufLen: size of `output' array. 
    10471047 *             work: a work array that must be allocated by the caller. 
    10481048 *                   Its size must be outBufLen+2 
    1049  *          workFFT: a work array needed by fft99.  
     1049 *          workFFT: a work array needed by fft99. 
    10501050 *                   Its size must be outBufLen+1 
    10511051 * 
    10521052 * Returns: 0 on success 
    1053  *         -1 on out-of-memory errors                    
     1053 *         -1 on out-of-memory errors 
    10541054 *         -2 on too-small impulse response 
    10551055 *         -3 on invalid arguments 
     
    10581058 
    10591059 
    1060 void response(long nfft, double deltat, ResponseStruct *pRS,  
     1060void response(long nfft, double deltat, ResponseStruct *pRS, 
    10611061              double *tfr, double *tfi) 
    10621062/* 
     
    10671067 *                    zeros and gain information for the desired function 
    10681068 *               tfr: pointer to the real part of the frequency response 
    1069  *               tfi: pointer to the imaginary part of the frequency  
     1069 *               tfi: pointer to the imaginary part of the frequency 
    10701070 *                    response. Both tfr and tfi must be allocated 
    10711071 *                    by the caller to contain at least nfft/2+1 values. 
     
    10781078 *               pRS: pointer to the response structure to be filled in 
    10791079 *                    The calling program must allocate the ResponseStruct; 
    1080  *                    the individual pole and zero structures will be  
     1080 *                    the individual pole and zero structures will be 
    10811081 *                    allocated here. 
    1082  *             
    1083  *            Pole-zero-gain files must be for input displacement in  
     1082 * 
     1083 *            Pole-zero-gain files must be for input displacement in 
    10841084 *            nanometers, output in digital counts, poles and zeros of 
    10851085 *            the LaPlace transform, frequency in radians per second. 
     
    11061106 * respLen: estimate the length of the impulse response (the number of 
    11071107 *          points where it is greater than some throshold) so we know 
    1108  *          how much padding we need for the convolution.       
     1108 *          how much padding we need for the convolution. 
    11091109 *          This is a trial algorithm that may or may not work. 
    11101110 *          We assume the the impulse response looks something like a 
    11111111 *          broadened and shifted impulse. We asssume that the width of 
    11121112 *          its peak is independent of the number of points used in 
    1113  *          this trial FFT, as long as the peak isn't too broad.   
     1113 *          this trial FFT, as long as the peak isn't too broad. 
    11141114 *  Returns: the length of the peak (in data points) on success 
    11151115 *           NFFT_TEST when impulse response never drops below threshold 
     
    11241124 
    11251125void taper(double *data, long npts, double percent) 
    1126 /*  
     1126/* 
    11271127 * taper: Apply a cosine taper to a data series. 
    11281128 * Arguments:  data: array of data to be tapered 
     
    11301130 *          percent: width of taper (at each end) in percent of array length 
    11311131 */ 
    1132   
     1132 
    11331133void deMean( double *data, long npts, double *mean) 
    11341134/* 
     
    11611161 *           1: (TR_DBG_PZG) print to stdout the poles, zeros and gain of the 
    11621162 *              input and output response functions. 
    1163  *           2: (TR_DBG_TRS) print to stdout the trial frequency response  
     1163 *           2: (TR_DBG_TRS) print to stdout the trial frequency response 
    11641164 *              function and the corresponding impulse response function. 
    1165  *              This will produce about 1500 lines of output for each call  
     1165 *              This will produce about 1500 lines of output for each call 
    11661166 *              to respLen or convertWave. 
    1167  *           4: (TR_DBG_ARS) print to stdout the full frequency response  
    1168  *              function. This will produce about one line of output for  
     1167 *           4: (TR_DBG_ARS) print to stdout the full frequency response 
     1168 *              function. This will produce about one line of output for 
    11691169 *              every two datapoints input to convertWave. 
    11701170 */ 
     
    17421742 
    17431743<hr> 
    1744   <img SRC="../GIFS/ew.logo.tiny.gif" height=61 width=71 align=LEFT><img SRC="../GIFS/smusgs.gif" height=48 width=48 align=RIGHT><font size=-1>The  
    1745   <b><i>EARTHWORM</i></b> development team is headed by Alex Bittenbinder and  
    1746   coordinated by Barbara Bogaert; both with the <a href="http://www.usgs.gov/">U.S.  
    1747   Geological Survey</a>. Advice and assistance with <b><i>EARTHWORM</i></b> development  
    1748   is provided by members of the <a href="http://www.cnss.org/">CNSS</a>.</font>  
     1744  <img SRC="../GIFS/ew.logo.tiny.gif" height=61 width=71 align=LEFT><img SRC="../GIFS/smusgs.gif" height=48 width=48 align=RIGHT><font size=-1>The 
     1745  <b><i>EARTHWORM</i></b> development team is headed by Alex Bittenbinder and 
     1746  coordinated by Barbara Bogaert; both with the <a href="http://www.usgs.gov/">U.S. 
     1747  Geological Survey</a>. Advice and assistance with <b><i>EARTHWORM</i></b> development 
     1748  is provided by members of the <a href="http://www.cnss.org/">CNSS</a>.</font> 
    17491749  <center> 
    17501750<p> 
     
    17521752 
    17531753<address>Questions? Issues? <a 
    1754  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    1755  target="_blank">Subscribe to the Earthworm List (earthw). </a></address></dl> 
     1754 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     1755 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></dl> 
    17561756 
    17571757</body> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/2000_autostart.html

    r2656 r4571  
    2222<pre> 
    2323-Create the autostart file: c:\earthworm\run\params\autostart_ew_2000.cmd 
    24 You can use word pad or a similar application to make this file.   
     24You can use word pad or a similar application to make this file. 
    2525 
    2626This file should contain the following lines: 
     
    3131<HR> 
    3232<address>Questions? Issues? <a 
    33  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    34  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     33 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     34 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    3535</BODY> 
    3636</HTML> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/examples.html

    r2364 r4571  
    88<BODY TEXT="#000000" BGCOLOR="#FAC0A2" LINK="#0000EE" VLINK="#551A8B" ALINK="#FF0000"> 
    99 
    10 <H1><IMG SRC="../GIFS/ew.logo.tiny.gif" ALT="EARTHWORM Logo (We need one)" HEIGHT=61 WIDTH=71 ALIGN=TEXTTOP>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;  
     10<H1><IMG SRC="../GIFS/ew.logo.tiny.gif" ALT="EARTHWORM Logo (We need one)" HEIGHT=61 WIDTH=71 ALIGN=TEXTTOP>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1111  EARTHWORM SETUP EXAMPLES</H1> 
    1212 
     
    8989code. The syntax of the table is as per standard Earthworm 
    9090parameter files (contributed by Carl). A # marks the start of a 
    91 comment field.   
     91comment field. 
    9292<LI><B> Message Rings:</B> These are all the ring names 
    9393known to the local Earthworm system. The associated numeric 
     
    9696startup time. Each individual installation is free to define 
    9797its own set if it so chooses. Earthworm releases, however, 
    98 include the default set.   
     98include the default set. 
    9999<LI><B> Module names:</B> These are all module 
    100100names known to the local Earthworm system. The conventions are 
    101 as with Message Ring names.   
     101as with Message Ring names. 
    102102<LI><B> Message types:</B> As with Module 
    103103names above. 
     
    174174<LI> <B>WaveServerV</B>: This module maintains rotating histories of 
    175175selected channels, and offers a service capable of supplying 
    176 requested segments of historic trace data.   
     176requested segments of historic trace data. 
    177177<LI> <B>export_scn</B>: 
    178178This is the long-distance shipping module (companion to 
     
    180180(Station, Component, Network names). In this application, 
    181181several selected channels of data are being sent to another 
    182 installation.   
     182installation. 
    183183<LI> <B>copystatus</B>, which conducts status messages 
    184184and heartbeats to the <I>Hypo_ring</I>. <B>statmgr</B> is listening to 
    185 that ring, and will be able to receive and process them.   
     185that ring, and will be able to receive and process them. 
    186186<LI> <B>pick_ew</B>, as above, listens to selected trace channels, and 
    187187produces pick and coda messages (along with status and 
     
    193193Carl Johnson). This module listens to pick messages, and 
    194194produces trial location messages as well as link messages that 
    195 relate picks to trial locations (via sequence numbers).   
     195relate picks to trial locations (via sequence numbers). 
    196196<LI> <B>eqproc</B> is the first of a series of sub-modules that perform 
    197197event locations via hypo-inverse. The sub-modules are linked 
     
    234234<hr> 
    235235<address>Questions? Issues? <a 
    236  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    237  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     236 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     237 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    238238 
    239239</BODY> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/hypoinv_sta.html

    r3124 r4571  
    1313 
    1414The channel identifier consists of a 5-letter site code, a 2-letter network 
    15 code unique to the owner or operator of the network, a 3-letter component  
    16 or channel code, and a 2-letter location code.  The net, component, and  
    17 location fields are optional to Hypoinverse, but space for these fields will  
    18 be reserved in all input and output files.  The user of Hypoinverse may specify  
    19 (with the LET command) how many characters (counted from the left side) in  
    20 each field to use when matching names in station and phase files.  Full use  
    21 of the fields will require 5, 2, 3, and 2 letters; minimum use will require  
    22 3, 0, 0 and 0 letters.  Hypoinverse can use both a 1-letter (old USGS style)  
    23 and 3-letter (SEED style) component field. Space for both fields will be  
     15code unique to the owner or operator of the network, a 3-letter component 
     16or channel code, and a 2-letter location code.  The net, component, and 
     17location fields are optional to Hypoinverse, but space for these fields will 
     18be reserved in all input and output files.  The user of Hypoinverse may specify 
     19(with the LET command) how many characters (counted from the left side) in 
     20each field to use when matching names in station and phase files.  Full use 
     21of the fields will require 5, 2, 3, and 2 letters; minimum use will require 
     223, 0, 0 and 0 letters.  Hypoinverse can use both a 1-letter (old USGS style) 
     23and 3-letter (SEED style) component field. Space for both fields will be 
    2424reserved in all input and output files. Select whether to use the 1- or 3-letter 
    2525field for matching station and phase names with the LES command.  It is 
     
    6969                    magnitude. If you don't want a station's magnitude used in 
    7070                    the event magnitude, use  a  correction  of  5.0  plus the 
    71                     actual correction.  You can also assign a zero weight (see  
     71                    actual correction.  You can also assign a zero weight (see 
    7272                    next). 
    7373 
    747467      A1          Amplitude magnitude weight code.  Codes 0-9, "*" and blank 
    75                     are the same as the P & S weight codes (col 15). The actual  
     75                    are the same as the P & S weight codes (col 15). The actual 
    7676                    magnitude weight used is the product of those on the station 
    7777                    and phase cards. See also col 62. 
     
    10510581-82   A2          2-letter location code. 
    106106                    Earthworm follows the SEED convention of allowed characters 
    107                     (A-Z, 0-9, space).  In apparent contradiction to the previous  
    108                     statement, Earthworm uses the character '-' to represent  
    109                     'space' in all Earthworm I/O. Just remember to think 'space'  
     107                    (A-Z, 0-9, space).  In apparent contradiction to the previous 
     108                    statement, Earthworm uses the character '-' to represent 
     109                    'space' in all Earthworm I/O. Just remember to think 'space' 
    110110                    when you see '-'. Lower case alphanumerics are not permitted. 
    111                     The location code should always contain 2 characters, either  
    112                     two alpha-numeric characters or two spaces ('--' or '  ').  
    113                     The use of a single space (or '-') adjacent to an alpha-numeric  
     111                    The location code should always contain 2 characters, either 
     112                    two alpha-numeric characters or two spaces ('--' or '  '). 
     113                    The use of a single space (or '-') adjacent to an alpha-numeric 
    114114                    is not permitted. 
    115115</PRE> 
    116116 
    117 Other details of hypoinverse configuration can be found in the complete  
     117Other details of hypoinverse configuration can be found in the complete 
    118118Hypoinverse documentation maintained by Fred Klein at: <br> 
    119119<a href=ftp://ehzftp.wr.usgs.gov/klein/hyp2000/docs/hyp2000-1.0.pdf>ftp://ehzftp.wr.usgs.gov/klein/hyp2000/docs/hyp2000-1.0.pdf</a><BR> 
     
    131131<HR> 
    132132<address>Questions? Issues? <a 
    133  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    134  target="_blank">Subscribe to the Earthworm List (earthw). </a> 
     133 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     134 target="_blank">Subscribe to the Earthworm Google Groups List. </a> 
    135135<br>Updated <B>21 Feb 2007</B></address><BR> 
    136136 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/nt_autostart.html

    r2364 r4571  
    77<I>(last revised 9 October, 1999)</I></CENTER> 
    88<P> 
    9 Following are steps needed to have earthworm (EW) start up  
     9Following are steps needed to have earthworm (EW) start up 
    1010automatically when a PC running Windows NT Workstation 4.0 boots up. 
    1111<P> 
     
    3030 
    3131  (b) Click on User->New User 
    32      - New user window should come up.  
     32     - New user window should come up. 
    3333 
    3434      Fill in the fields: 
    3535        Username:    earthworm 
    3636        Password:    earthworm 
    37        
    38       Make sure that the box labeled "User Must Change Password.." is  
     37 
     38      Make sure that the box labeled "User Must Change Password.." is 
    3939      NOT checked. 
    4040 
    41   (c) Setup groups - click on the "Groups" Icon  
     41  (c) Setup groups - click on the "Groups" Icon 
    4242     - Groups window should come up 
    4343 
    44      Select all groups in the right hand screen, then click Add, then click OK.  
     44     Select all groups in the right hand screen, then click Add, then click OK. 
    4545     Back in the New User window, Click OK. 
    4646     Back in the User Manager, Click USER->EXIT. 
     
    5050(2) Automatic login 
    5151 
    52   (a) Start the registry editor:  
     52  (a) Start the registry editor: 
    5353        Click on Start->Run, type  "regedt32" in the box, then click OK. 
    5454 
     
    5656         "HKEY_LOCAL_MACHINE" 
    5757 
    58   (c) HKEY_LOCAL_MACHINE window should come to the foreground. Double click on  
     58  (c) HKEY_LOCAL_MACHINE window should come to the foreground. Double click on 
    5959        the following: 
    6060             Software->Microsoft->WindowsNT->CurrentVersion->WinLogon 
    6161 
    62   (d) Now we need to create and/or set some values in the registry in the right  
    63       hand section of the window.  
     62  (d) Now we need to create and/or set some values in the registry in the right 
     63      hand section of the window. 
    6464        1.  AutoAdminLogon 
    6565            If the AutoAdminLogon exits: 
     
    6767                  pop up window. 
    6868            If the AutoAdminLogon does not exit: 
    69                 - From the EDIT pull down menu, choose AddValue.   
    70                   In the pop up window, enter "AutoAdminLogon" in the ValueName  
     69                - From the EDIT pull down menu, choose AddValue. 
     70                  In the pop up window, enter "AutoAdminLogon" in the ValueName 
    7171                  box.  Choose 'REG_SZ' for the data type.  Click OK. 
    7272                  Enter 1 in the next pop up window; then click OK. 
     
    7474        2.  DefaultUserName 
    7575            Click on Edit->Add Value. A dialog box should come up. Fill in: 
    76                 Value Name:    DefaultUserName   click OK, another window  
     76                Value Name:    DefaultUserName   click OK, another window 
    7777                comes up. Fill in: 
    7878                String:        earthworm 
     
    8484             String:        earthworm 
    8585 
    86      When all is said and done, the following values whould be listed in  
     86     When all is said and done, the following values whould be listed in 
    8787       the right hand window: 
    88   
     88 
    8989          DefaultUserName     earthworm 
    9090          DefaultPassword     earthworm 
     
    9797(3) Automatic Earthworm Startup during login 
    9898 
    99   (a) Restart the PC.  If everything in step 1 and 2 was done correctly, the PC  
     99  (a) Restart the PC.  If everything in step 1 and 2 was done correctly, the PC 
    100100      will automatically log you in as earthworm. 
    101101  (b) Make sure that the EW automatic startup script exists -- it should be 
    102       called something like c:\earthworm\run\params\autostart_ew_nt.cmd.                 
     102      called something like c:\earthworm\run\params\autostart_ew_nt.cmd. 
    103103        Example autostart_ew_nt.cmd: 
    104104                call ew_nt.cmd 
    105                 call startstop.exe  
     105                call startstop.exe 
    106106 
    107107  (c) Click on Start->Settings->Taskbar 
     
    115115     The right hand side window under Startup should be empty. 
    116116 
    117   (e) Create a shortcut to the EW automatic startup script: In the right  
     117  (e) Create a shortcut to the EW automatic startup script: In the right 
    118118      hand side window, click the right button, then select New->Shortcut. 
    119119 
    120      A new window should come up, in the box enter the full path to the  
    121      autostart_ew_nt script, click NEXT, and then click FINISH.  OR click on  
    122      Browse to select the path to the  
    123      script using NT Explorer, highlight the autorestart_ew_nt.cmd, click OPEN,  
    124      then NEXT, and then click FINISH.  Last.  then click OK in the  
     120     A new window should come up, in the box enter the full path to the 
     121     autostart_ew_nt script, click NEXT, and then click FINISH.  OR click on 
     122     Browse to select the path to the 
     123     script using NT Explorer, highlight the autorestart_ew_nt.cmd, click OPEN, 
     124     then NEXT, and then click FINISH.  Last.  then click OK in the 
    125125     TaskBar window. 
    126     
    127126 
    128127 
    129 NOTES OF CAUTION:  
    130128 
    131   - user earthworm must have a password in order for automatic login to  
     129NOTES OF CAUTION: 
     130 
     131  - user earthworm must have a password in order for automatic login to 
    132132    work. This means that password cannot be blank. 
    133133 
    134   - make sure that when creating user earthworm it is added to all groups,  
     134  - make sure that when creating user earthworm it is added to all groups, 
    135135    particularly the administrator group, since earthworm will be the only 
    136     user that can log in once the registry is changed.  
    137       
     136    user that can log in once the registry is changed. 
     137 
    138138 
    139139 
     
    144144must be updated. Basically, the file autostart_ew_nt.cmd mentioned 
    145145above consists of the main command file ew_nt.cmd (which is 
    146 located in the params directory of the current configuration),  
     146located in the params directory of the current configuration), 
    147147with the addition of the startstop command which starts earthworm 
    148 automatically. Therefore, whenever ANY changes are made to  
    149 the local of the active ew_nt.cmd, the  
     148automatically. Therefore, whenever ANY changes are made to 
     149the local of the active ew_nt.cmd, the 
    150150autostart_ew_nt.cmd file should be update. 
    151151 
     
    155155<HR> 
    156156<address>Questions? Issues? <a 
    157  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    158  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     157 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     158 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    159159</BODY> 
    160160</HTML> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/solaris_autostart.html

    r2364 r4571  
    77<I>(last revised 13 March, 2001)</I></CENTER> 
    88<P> 
    9 Following are steps needed to have earthworm (EW) start up  
     9Following are steps needed to have earthworm (EW) start up 
    1010automatically when a Sun workstation running Solaris boots up. 
    1111<P> 
     
    251251<HR> 
    252252<address>Questions? Issues? <a 
    253  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    254  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     253 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     254 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    255255</BODY> 
    256256</HTML> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/start-stop-status.html

    r3945 r4571  
    5353   type quit<cr> to stop Earthworm. 
    5454</PRE> 
    55 <P> To stop the Earthworm system, type <STRONG>quit</STRONG> into the Earthworm  
    56   status console. The currently running Earthworm configuration can also be stopped  
    57   outside of the console window using the module <STRONG>pau</STRONG>. Follow  
    58   the first two steps for starting up Earthworm to source or execute the ew_sol_sparc.cmd  
    59   or ew_nt.cmd files, then type <STRONG>pau</STRONG>. A similar procedure can  
    60   be used to obtain the status of the Earthworm system. The module to execute  
     55<P> To stop the Earthworm system, type <STRONG>quit</STRONG> into the Earthworm 
     56  status console. The currently running Earthworm configuration can also be stopped 
     57  outside of the console window using the module <STRONG>pau</STRONG>. Follow 
     58  the first two steps for starting up Earthworm to source or execute the ew_sol_sparc.cmd 
     59  or ew_nt.cmd files, then type <STRONG>pau</STRONG>. A similar procedure can 
     60  be used to obtain the status of the Earthworm system. The module to execute 
    6161  in this case is called <STRONG>status</STRONG>. </P><hr> 
    6262<address>Questions? Issues? <a 
    63  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    64  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     63 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     64 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/v6_to_v7.html

    r2828 r4571  
    164164the Interior</a>, U.S. Geological Survey, Reston, VA, USA<br> 
    165165Contact: <a 
    166  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw">earthw 
     166 href="http://groups.google.com/group/earthworm_forum?hl=en">earthw 
    167167mailing list </a><br> 
    168168      <a href="http://www.usgs.gov/privacy.html">Privacy Statement</a> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/v70_to_v71.html

    r2828 r4571  
    3535message be added to your earthworm.d. <br> 
    3636</p> 
    37   <p>Yes, that's really all there is to it. See the documentation on startstop  
     37  <p>Yes, that's really all there is to it. See the documentation on startstop 
    3838    for more information on how to use the stop feature.<br> 
    3939</p> 
     
    4848the Interior</a>, U.S. Geological Survey, Reston, VA, USA<br> 
    4949Contact: <a 
    50  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw">earthw 
     50 href="http://groups.google.com/group/earthworm_forum?hl=en">earthw 
    5151mailing list </a><br> 
    5252      <a href="http://www.usgs.gov/privacy.html">Privacy Statement</a> 
  • trunk/ewdoc/WEB_DOC/USER_GUIDE/windows_startstop_service.html

    r4001 r4571  
    166166<HR> 
    167167<address>Questions? Issues? <a 
    168  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    169  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     168 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     169 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    170170</BODY> 
    171171</HTML> 
  • trunk/ewdoc/WEB_DOC/cmd/activated_scripts_cmd.html

    r4223 r4571  
    1111<pre> 
    1212# 
    13 #         Activated_scripts Configuration File  
     13#         Activated_scripts Configuration File 
    1414# 
    1515MyModuleId    MOD_ACT_SCR # activated_scripts's module id 
     
    1919 
    2020# 
    21 # Commands to be executed, in this order, substituting $n for the n-th argument  
     21# Commands to be executed, in this order, substituting $n for the n-th argument 
    2222# in the ACTIVATE_MODULE messages 
    2323# 
     
    2626 
    2727</pre> 
    28 <CENTER>  
    29 <A HREF="../modules.html">Module Index</A> |  
     28<CENTER> 
     29<A HREF="../modules.html">Module Index</A> | 
    3030<A HREF="../ovr/activated_scripts_ovr.html">Activated_scripts Overview</A> 
    3131</CENTER> 
     
    3535<HR> 
    3636<ADDRESS> 
    37 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     37Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    3838</ADDRESS> 
    3939</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/adsend_cmd.html

    r2351 r4571  
    1616<!-- USGS-required stuff at the end --> 
    1717<hr> 
    18 Contact: <b><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></b><br> 
     18Contact: <b><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></b><br> 
    1919</address> 
    2020</body> 
  • trunk/ewdoc/WEB_DOC/cmd/arc2trigII_cmd.html

    r2369 r4571  
    66<BODY text=#000000 vLink=#551a8b aLink=#ff0000 link=#0000ee bgColor=#fadfaf> 
    77<CENTER> 
    8 <H1><BR>Arc2trigII Configuration File</H1><I>(last revised April 17,  
     8<H1><BR>Arc2trigII Configuration File</H1><I>(last revised April 17, 
    992002)</I></CENTER> 
    1010<PRE> 
    1111# This is arc2trigII's parameter file 
    12 # Derived from, you guessed it, arc2trig. The enhancements are to save snippets  
     12# Derived from, you guessed it, arc2trig. The enhancements are to save snippets 
    1313# of interest which were not listed in the arc message. This is done as follows: 
    1414#   * Get all the stations - either from hypoinverse station list or DBMS. For ea 
    1515ch station: 
    16 #     * Check the table of magnitude vs. radius. If it's within the radius, save  
     16#     * Check the table of magnitude vs. radius. If it's within the radius, save 
    1717this snippet. 
    1818#     * Check the list of mandatory stations to save (wildcards permitted). If it 
     
    2121#   * Within a specified epicentral distance, save all data from origin time thro 
    2222ugh S time. 
    23 #   * Outside this distance, use the travel-time table as in usnsn_loc2trig, and  
     23#   * Outside this distance, use the travel-time table as in usnsn_loc2trig, and 
    2424save from P to S. 
    2525#   * All snippets to be padded with a specified safety margin of pre and post ti 
     
    2828#  Basic Earthworm setup: 
    2929# 
    30 MyModuleId        MOD_ARC2TRIG   # module id for this instance of arc2trig  
     30MyModuleId        MOD_ARC2TRIG   # module id for this instance of arc2trig 
    3131InRingName           HYPO_RING   # shared memory ring for input 
    3232OutRingName          TRIG_RING   # shared memory ring for output 
     
    4545# Lat-Lon limits we'll use for constructing station list: 
    4646 DBLatRange   20.1   50.2 
    47  DBLonRange -120.2 -80.1  
     47 DBLonRange -120.2 -80.1 
    4848 
    4949# Name of hypoinverse station list. 
     
    5252 
    5353# Optional: Magnitude vs Distance (km) within which we'll get all snippets: 
    54 # How it works:  it finds the lowest magnitude entry which is greater  
    55 # than the event magnitude and uses that radius for determinatin of stations.  
    56 # For events with magnitudes largest than the largest in the Table,  
     54# How it works:  it finds the lowest magnitude entry which is greater 
     55# than the event magnitude and uses that radius for determinatin of stations. 
     56# For events with magnitudes largest than the largest in the Table, 
    5757# arc2trigII used the radius of largest magnitude in the table. 
    5858MagDist 3.0 10 
     
    6969# Optional: Mandatory channels that must be included for all events. 
    7070# List one SCN per line, as many as you need. Wildcards (*) permitted. 
    71 # Channel  * * UW  
     71# Channel  * * UW 
    7272# Channel  LON LHZ UW 
    73   
     73 
    7474 
    7575# List the message logos to grab from transport ring 
     
    9898<HR> 
    9999<address>Questions? Issues? <a 
    100  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    101  target="_blank">Subscribe to the Earthworm List (earthw). </a></address></BODY></HTML> 
     100 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     101 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></BODY></HTML> 
  • trunk/ewdoc/WEB_DOC/cmd/arc2trig_cmd.html

    r2351 r4571  
    1515#  Basic Earthworm setup: 
    1616# 
    17 MyModuleId        MOD_ARC2TRIG   # module id for this instance of arc2trig  
     17MyModuleId        MOD_ARC2TRIG   # module id for this instance of arc2trig 
    1818InRingName           HYPO_RING   # shared memory ring for input 
    1919OutRingName          HYPO_RING   # shared memory ring for output 
     
    3939 
    4040</pre> 
    41 <CENTER>  
    42 <A HREF="../modules.html">Module Index</A> |  
     41<CENTER> 
     42<A HREF="../modules.html">Module Index</A> | 
    4343<A HREF="../ovr/arc2trig_ovr.html">Arc2trig Overview</A> 
    4444</CENTER> 
     
    4848<HR> 
    4949<ADDRESS> 
    50 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     50Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    5151</ADDRESS> 
    5252</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/binder_ew_cmd.html

    r4373 r4571  
    660660<pre><a name="rmscut_pick"><b>rmscut_pick <font color="red">threshold number_of_picks</font></b>                                bind_com                location</a></pre> 
    661661<blockquote> <a name="rmscut_pick">Sets a maximum value (seconds) <font color="red">threshold</font> for the 
    662 average absolute residual (rms)  
    663 for a successful location that  
     662average absolute residual (rms) 
     663for a successful location that 
    664664must be met unless <font color="red">number_of_picks</font> is observed. 
    665665If this value is exceeded as a result of 
     
    859859<br> 
    860860<address> Questions? Issues? <a 
    861  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    862  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     861 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     862 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    863863<br> 
    864864</body> 
  • trunk/ewdoc/WEB_DOC/cmd/carlstatrig_cmd.html

    r3797 r4571  
    254254<address>Contact: <b> 
    255255<address> Questions? Issues? <a 
    256  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    257  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     256 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     257 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    258258</b><br> 
    259259</address> 
  • trunk/ewdoc/WEB_DOC/cmd/carlsubtrig_cmd.html

    r4567 r4571  
    2020On startup, CarlSubTrig reads the configuration file named on the command 
    2121line. Commands in this file set all the parameters used for performing the subnet 
    22 logic for the Carl Johnson trigger system. In the control file, lines may begin with a  
     22logic for the Carl Johnson trigger system. In the control file, lines may begin with a 
    2323valid carlsubtrig command (listed below) or with one of 2 special characters: 
    2424 
    2525<BLOCKQUOTE><PRE> 
    26 #  marks the line as a comment (example: # This is a comment).<BR>    
    27 @  allows control files to be nested; one control file can be  
    28    accessed from another with the command "@" followed by  
    29    a string representing the path name of the next control file  
     26#  marks the line as a comment (example: # This is a comment).<BR> 
     27@  allows control files to be nested; one control file can be 
     28   accessed from another with the command "@" followed by 
     29   a string representing the path name of the next control file 
    3030   (example: @model.d). 
    3131</BLOCKQUOTE></PRE> 
     
    5252<A NAME="function"> 
    5353<H2>2.  FUNCTIONAL COMMAND LISTING</H2> 
    54 <P>   
     54<P> 
    5555<!-- ADD HERE: Paragraph "Below are the commands recognized..." --> 
    56 Below are the commands recognized by carlsubtrig, grouped by the function  
    57 they influence.  All of the commands are required except <B>Debug</B>; they may be specified  
     56Below are the commands recognized by carlsubtrig, grouped by the function 
     57they influence.  All of the commands are required except <B>Debug</B>; they may be specified 
    5858in any order in the control file. 
    5959 
     
    8787                <A HREF="#CompAsWild">CompAsWild</A>            optional 
    8888                <A HREF="#Channel">Channels</A>         optional 
    89                 <A HREF="#MaxTrigMsgLen">MaxTrigMsgLen</A>              optional      
    90                 <A HREF="#CoincidentStaTriggers">CoincidentStaTriggers</A>              optional      
    91                 <A HREF="#IgnoreCoincident">IgnoreCoincident</A>                optional      
     89                <A HREF="#MaxTrigMsgLen">MaxTrigMsgLen</A>              optional 
     90                <A HREF="#CoincidentStaTriggers">CoincidentStaTriggers</A>              optional 
     91                <A HREF="#IgnoreCoincident">IgnoreCoincident</A>                optional 
    9292</PRE> 
    9393 
     
    9595<H2>3.  ALPHABETIC COMMAND LISTING & DESCRIPTION</H2> 
    9696<P> 
    97 In the following section, all configuration file commands are listed  
    98 in alphabetical order.  Listed along with the command (<B>bold-type</B>) are  
    99 its arguments (in <font color=red>red</font>), the name of the subroutine that processes the  
    100 command, and the function within the module that the command influences.  
    101 A detailed description of the command and is also given.  Default values  
     97In the following section, all configuration file commands are listed 
     98in alphabetical order.  Listed along with the command (<B>bold-type</B>) are 
     99its arguments (in <font color=red>red</font>), the name of the subroutine that processes the 
     100command, and the function within the module that the command influences. 
     101A detailed description of the command and is also given.  Default values 
    102102and the values used by PNSN are listed after each command description. 
    103103<PRE><B> 
     
    109109 
    110110<A NAME="AllSubnets"></A> 
    111 <PRE><B>AllSubnets <font color=red>nsubnets</font>              ReadConfig              Earthworm setup  
    112 </B><!-- command args ... -->            
     111<PRE><B>AllSubnets <font color=red>nsubnets</font>              ReadConfig              Earthworm setup 
     112</B><!-- command args ... --> 
    113113</PRE> 
    114114<BLOCKQUOTE> <!-- command description goes here --> 
     
    124124 
    125125<A NAME="Channel"></A> 
    126 <PRE><B>Channel <font color=red>SCNL</font>                     ReadConfig              Earthworm setup  
    127 </B><!-- command args ... -->            
     126<PRE><B>Channel <font color=red>SCNL</font>                     ReadConfig              Earthworm setup 
     127</B><!-- command args ... --> 
    128128</PRE> 
    129129<BLOCKQUOTE> <!-- command description goes here --> 
     
    139139 
    140140<A NAME="CoincidentStaTriggers"></A> 
    141 <PRE><B>CoincidentStaTriggers                   ReadConfig              Earthworm setup  
    142 </B><!-- command args ... -->            
     141<PRE><B>CoincidentStaTriggers                   ReadConfig              Earthworm setup 
     142</B><!-- command args ... --> 
    143143</PRE> 
    144144<BLOCKQUOTE> <!-- command description goes here --> 
     
    154154 
    155155<A NAME="CompAsWild"></A> 
    156 <PRE><B>CompAsWild                      ReadConfig              Earthworm setup  
    157 </B><!-- command args ... -->            
    158 </PRE> 
    159 <BLOCKQUOTE> <!-- command description goes here --> 
    160 Flag with no value. If present, carlsubtrig will put the wildcard `*' in the trigger message  
    161 in place of component names. This can be used if you have multi-component stations but only  
    162 want to listen for station triggers from the vertical component.  
     156<PRE><B>CompAsWild                      ReadConfig              Earthworm setup 
     157</B><!-- command args ... --> 
     158</PRE> 
     159<BLOCKQUOTE> <!-- command description goes here --> 
     160Flag with no value. If present, carlsubtrig will put the wildcard `*' in the trigger message 
     161in place of component names. This can be used if you have multi-component stations but only 
     162want to listen for station triggers from the vertical component. 
    163163<PRE><!-- Default and example go here   --> 
    164164Default:  0  (flag not set) 
     
    168168<HR> 
    169169 
    170 <A NAME="Debug">  <!-- command name as anchor inside quotes -->  
    171 <PRE><B>Debug <font color=red>level</font>                      ReadConfig              Earthworm setup  
    172 </B><!-- command args ... -->            
    173 </PRE> 
    174 <BLOCKQUOTE> <!-- command description goes here --> 
    175 Sets the debug logging <font color=red>level</font> for CarlSubTrig. With <font color=red>level</font>  
     170<A NAME="Debug">  <!-- command name as anchor inside quotes --> 
     171<PRE><B>Debug <font color=red>level</font>                      ReadConfig              Earthworm setup 
     172</B><!-- command args ... --> 
     173</PRE> 
     174<BLOCKQUOTE> <!-- command description goes here --> 
     175Sets the debug logging <font color=red>level</font> for CarlSubTrig. With <font color=red>level</font> 
    176176set to zero minimal logging is done. Very verbose logging is obtained with <font color=red>level</font> set to 4. 
    177177<PRE><!-- Default and example go here   --> 
     
    182182<HR> 
    183183 
    184 <A NAME="DefStationDur">  <!-- command name as anchor inside quotes -->  
     184<A NAME="DefStationDur">  <!-- command name as anchor inside quotes --> 
    185185<PRE><B>DefStationDur <font color=red>nsecs</font>              ReadConfig              Station parameters 
    186  </B><!-- command args ... -->           
    187 </PRE> 
    188 <BLOCKQUOTE> <!-- command description goes here --> 
    189 Sets the default station trigger duration to <font color=red>nsecs</font> seconds. This  
     186 </B><!-- command args ... --> 
     187</PRE> 
     188<BLOCKQUOTE> <!-- command description goes here --> 
     189Sets the default station trigger duration to <font color=red>nsecs</font> seconds. This 
    190190value is used to terminate a station trigger only if no trigger-off message matching a 
    191191trigger-on message is received from CarlStaTrig. 
     
    197197<HR> 
    198198 
    199 <A NAME="GetEventsFrom">  <!-- command name as anchor inside quotes -->  
     199<A NAME="GetEventsFrom">  <!-- command name as anchor inside quotes --> 
    200200<PRE><B>GetEventsFrom <font color=red>inst mod_id</font>        ReadConfig              Earthworm setup 
    201  </B><!-- command args ... -->           
     201 </B><!-- command args ... --> 
    202202</PRE> 
    203203<BLOCKQUOTE> <!-- command description goes here --> 
     
    205205only process TYPE_CARLSTATRIG messages that come from module <font color=red>mod_id</font> 
    206206 at installation <font color=red>inst</font>. <font color=red>inst</font> and <font 
    207  color=red>mod_id</font> are character strings (valid  
    208 strings are listed in earthworm.h/earthworm.d) which are related to  
    209 single-byte numbers that uniquely identify each installation and  
    210 module.  Only one "GetSumFrom" command may be issued; wildcards  
     207 color=red>mod_id</font> are character strings (valid 
     208strings are listed in earthworm.h/earthworm.d) which are related to 
     209single-byte numbers that uniquely identify each installation and 
     210module.  Only one "GetSumFrom" command may be issued; wildcards 
    211211(INST_WILDCARD and MOD_WILDCARD) will force carlsubtrig to process all station 
    212212trigger messages, regardless of their place of origin. 
     
    218218<HR> 
    219219 
    220 <A NAME="HeartBeatInterval">  <!-- command name as anchor inside quotes -->      
     220<A NAME="HeartBeatInterval">  <!-- command name as anchor inside quotes --> 
    221221<PRE><B>HeartBeatInterval <font color=red>nsec</font>           ReadConfig              Earthworm setup 
    222 </B><!-- command args ... -->            
    223 </PRE> 
    224 <BLOCKQUOTE> <!-- command description goes here --> 
    225 Defines the number of seconds, <font color=red>nsec</font> between TYPE_HEARTBEAT  
     222</B><!-- command args ... --> 
     223</PRE> 
     224<BLOCKQUOTE> <!-- command description goes here --> 
     225Defines the number of seconds, <font color=red>nsec</font> between TYPE_HEARTBEAT 
    226226messages issued by carlsubtrig. 
    227227<PRE><!-- Default and example go here   --> 
     
    233233 
    234234<A NAME="IgnoreCoincident"></A> 
    235 <PRE><B>IgnoreCoincident                        ReadConfig              Earthworm setup  
     235<PRE><B>IgnoreCoincident                        ReadConfig              Earthworm setup 
    236236</B>IgnoreCoincident <font color=red>nsubs</font> 
    237 If more than the specified number of subnets <font color=red>nsubs</font> are coincidentally triggered, then the coincident check for  
     237If more than the specified number of subnets <font color=red>nsubs</font> are coincidentally triggered, then the coincident check for 
    238238triggers is not performed. The reason for this option is because the coincident check should only be 
    239239performed for a small number of subnets triggering since telemetry glitches would not cross more than 
     
    242242<BLOCKQUOTE> <!-- command description goes here --> 
    243243<PRE><!-- Default and example go here   --> 
    244 Default:  3   
     244Default:  3 
    245245Example:  IgnoreCoincident 4 
    246246</PRE> 
     
    248248<HR> 
    249249 
    250 <A NAME="Latency">  <!-- command name as anchor inside quotes -->        
     250<A NAME="Latency">  <!-- command name as anchor inside quotes --> 
    251251<PRE><B>Latency <font color=red>nsec</font>                     ReadConfig              Station parameters 
    252  </B><!-- command args ... -->           
    253 </PRE> 
    254 <BLOCKQUOTE> <!-- command description goes here --> 
    255 Specifies the number of seconds that carlsubtrig will wait for delivery of  
     252 </B><!-- command args ... --> 
     253</PRE> 
     254<BLOCKQUOTE> <!-- command description goes here --> 
     255Specifies the number of seconds that carlsubtrig will wait for delivery of 
    256256station trigger messages. This allows for slow telemetry paths and other delays. 
    257257<PRE><!-- Default and example go here   --> 
     
    263263 
    264264<A NAME="ListSubnets"></A> 
    265 <PRE><B>ListSubnets <font color=red>ls</font>           ReadConfig              Earthworm setup  
    266 </B><!-- command args ... -->            
    267 </PRE> 
    268 <BLOCKQUOTE> <!-- command description goes here --> 
    269 Flag for determining how which SCNLs will be listed in the trigger message. When  
    270 <B>ListSubnets</B> is absent or <font color=red>ls</font> is 0, the trigger  
     265<PRE><B>ListSubnets <font color=red>ls</font>           ReadConfig              Earthworm setup 
     266</B><!-- command args ... --> 
     267</PRE> 
     268<BLOCKQUOTE> <!-- command description goes here --> 
     269Flag for determining how which SCNLs will be listed in the trigger message. When 
     270<B>ListSubnets</B> is absent or <font color=red>ls</font> is 0, the trigger 
    271271message will include all triggered SCNLs. If 
    272272<font color=red>ls</font> is 1, the trigger list will include the untriggered 
    273273SCNLs as well as the triggered SCNLs from the triggered subnets (but will omit 
    274 triggered SCNLs that are NOT in the triggered subnets).  When  
    275 <B>ListSubnets</B> is 2, the trigger message will list all SCNLs from the  
     274triggered SCNLs that are NOT in the triggered subnets).  When 
     275<B>ListSubnets</B> is 2, the trigger message will list all SCNLs from the 
    276276triggered subnets, as well as all other triggered SCNLs (union of options 
    277 0 and 1). When  
     2770 and 1). When 
    278278<B>ListSubnets</B> is 3, the trigger message will list all SCNLs 
    279279in any subnets that have at least one triggered SCNL. However, if more than <A HREF="#AllSubnets">AllSubnets</A> have triggered, 
    280280then the SCN wildcard will be listed instead of a long list of non-triggered stations. 
    281 If this flag is absent, then carlsubtrig lists only stations that actually triggered during  
    282 the event.  
     281If this flag is absent, then carlsubtrig lists only stations that actually triggered during 
     282the event. 
    283283<P> The idea here is to adjust the number of SCNLs in the trigger message for a 
    284 small event. With <B>ListSubnets</B> at 1, we include untriggered SCNLs from  
     284small event. With <B>ListSubnets</B> at 1, we include untriggered SCNLs from 
    285285triggered subnets. If the subnets are layed out in small geographic areas, then 
    286286we might expect to have some seismic signal from all SCNLs in triggered subnets. By 
    287287including those SCNLs in the trigger message, we allow downstream analysis to have 
    288 the opportunity to look at the data from those SCNLs. If we increase  
     288the opportunity to look at the data from those SCNLs. If we increase 
    289289<font color=red>ls</font> to 3, then we are being more conservative in that we 
    290290save data for anything in subnets that had any SCNLs trigger. In practice, we find 
     
    298298<HR> 
    299299 
    300 <A NAME="MaxDuration">  <!-- command name as anchor inside quotes -->    
     300<A NAME="MaxDuration">  <!-- command name as anchor inside quotes --> 
    301301<PRE><B>MaxDuration <font color=red>nsec</font>         ReadConfig              Subnet parameters 
    302  </B><!-- command args ... -->           
     302 </B><!-- command args ... --> 
    303303</PRE> 
    304304<BLOCKQUOTE> <!-- command description goes here --> 
    305305Specifies the maximum duration of a network trigger as <font color=red>nsec</font> seconds. 
    306 This could be used to limit the size of datafiles retrieved from a wave server.  
     306This could be used to limit the size of datafiles retrieved from a wave server. 
    307307<PRE><!-- Default and example go here   --> 
    308308Default:  none 
     
    312312<HR> 
    313313 
    314 <A NAME="MaxTrigMsgLen">  <!-- command name as anchor inside quotes -->  
     314<A NAME="MaxTrigMsgLen">  <!-- command name as anchor inside quotes --> 
    315315<PRE><B>MaxTrigMsgLen <font color=red>nsec</font>               ReadConfig              Subnet parameters 
    316  </B><!-- command args ... -->           
     316 </B><!-- command args ... --> 
    317317</PRE> 
    318318<BLOCKQUOTE> <!-- command description goes here --> 
    319319Specifies the maximum length (bytes) of a triglist message; up to MAX_BYTES_PER_EQ (earthworm.h). 
    320320<PRE><!-- Default and example go here   --> 
    321 Default:  MAX_BYTES_PER_EQ  
     321Default:  MAX_BYTES_PER_EQ 
    322322Example:  MaxTrigMsgLen  30000</PRE> 
    323323</BLOCKQUOTE> 
    324324<HR> 
    325325 
    326 <A NAME="MyModuleId">  <!-- command name as anchor inside quotes -->     
     326<A NAME="MyModuleId">  <!-- command name as anchor inside quotes --> 
    327327<PRE><B>MyModuleId <font color=red>mod_id</font>                ReadConfig              Earthworm setup 
    328 </B><!-- command args ... -->            
    329 </PRE> 
    330 <BLOCKQUOTE> <!-- command description goes here --> 
    331 Sets the module id for labeling all outgoing trigger, heartbeat, and error messages.  
    332 <font color=red>mod_id</font> is a character string (valid strings are listed in earthworm.d) that relates  
    333 to a unique single-byte number.  
     328</B><!-- command args ... --> 
     329</PRE> 
     330<BLOCKQUOTE> <!-- command description goes here --> 
     331Sets the module id for labeling all outgoing trigger, heartbeat, and error messages. 
     332<font color=red>mod_id</font> is a character string (valid strings are listed in earthworm.d) that relates 
     333to a unique single-byte number. 
    334334<PRE><!-- Default and example go here   --> 
    335335Default:  none 
     
    339339<HR> 
    340340 
    341 <A NAME="NetTriggerDur">  <!-- command name as anchor inside quotes -->  
     341<A NAME="NetTriggerDur">  <!-- command name as anchor inside quotes --> 
    342342<PRE><B>NetTriggerDur <font color=red>nsecs</font>              ReadConfig              Subnet parameters 
    343  </B><!-- command args ... -->           
     343 </B><!-- command args ... --> 
    344344</PRE> 
    345345<BLOCKQUOTE> <!-- command description goes here --> 
    346346Sets the base network trigger duration to <font color=red>nsecs</font> seconds. The 
    347 minimum trigger duration is the sum of <A HREF="#PreEventTime">PreEventTime</A>,  
    348 <A HREF="#NetTriggerDur">NetTriggerDur</A> and <A HREF="#SubnetContrib">SubnetContrib</A>  
    349 times the number of subnets that triggered.  
     347minimum trigger duration is the sum of <A HREF="#PreEventTime">PreEventTime</A>, 
     348<A HREF="#NetTriggerDur">NetTriggerDur</A> and <A HREF="#SubnetContrib">SubnetContrib</A> 
     349times the number of subnets that triggered. 
    350350<PRE><!-- Default and example go here   --> 
    351351Default:  none 
     
    355355<HR> 
    356356 
    357 <A NAME="PreEventTime">  <!-- command name as anchor inside quotes -->   
     357<A NAME="PreEventTime">  <!-- command name as anchor inside quotes --> 
    358358<PRE><B>PreEventTime <font color=red>nsecs</font>               ReadConfig              Subnet parameters 
    359 </B><!-- command args ... -->            
     359</B><!-- command args ... --> 
    360360</PRE> 
    361361<BLOCKQUOTE> <!-- command description goes here --> 
     
    363363trigger to start the network trigger. This can be used to start saving waveform data 
    364364prior to the first phase arrivals. The 
    365 minimum trigger duration is the sum of <A HREF="#PreEventTime">PreEventTime</A>,  
    366 <A HREF="#NetTriggerDur">NetTriggerDur</A> and <A HREF="#SubnetContrib">SubnetContrib</A>  
     365minimum trigger duration is the sum of <A HREF="#PreEventTime">PreEventTime</A>, 
     366<A HREF="#NetTriggerDur">NetTriggerDur</A> and <A HREF="#SubnetContrib">SubnetContrib</A> 
    367367times the number of subnets that triggered. 
    368368<PRE><!-- Default and example go here   --> 
     
    373373<HR> 
    374374 
    375 <A NAME="RingNameIn">  <!-- command name as anchor inside quotes -->     
     375<A NAME="RingNameIn">  <!-- command name as anchor inside quotes --> 
    376376<PRE><B>RingNameIn <font color=red>ring</font>                  ReadConfig              Earthworm setup 
    377 </B><!-- command args ... -->            
     377</B><!-- command args ... --> 
    378378</PRE> 
    379379<BLOCKQUOTE> <!-- command description goes here --> 
    380380Tells carlsubtrig which shared memory region to use for input. <font color=red>ring</font> is a character 
    381381string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a 
    382 unique number for the key to the shared memory region.  
     382unique number for the key to the shared memory region. 
    383383<PRE><!-- Default and example go here   --> 
    384384Default:  none 
     
    388388<HR> 
    389389 
    390 <A NAME="RingNameOut">  <!-- command name as anchor inside quotes -->    
     390<A NAME="RingNameOut">  <!-- command name as anchor inside quotes --> 
    391391<PRE><B>RingNameOut <font color=red>ring</font>         ReadConfig              Earthworm setup 
    392 </B><!-- command args ... -->            
     392</B><!-- command args ... --> 
    393393</PRE> 
    394394<BLOCKQUOTE> <!-- command description goes here --> 
    395395Tells carlsubtrig which shared memory region to use for output. <font color=red>ring</font> is a character 
    396396string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a 
    397 unique number for the key to the shared memory region.  
     397unique number for the key to the shared memory region. 
    398398<PRE><!-- Default and example go here   --> 
    399399Default:  none 
     
    403403<HR> 
    404404 
    405 <A NAME="StationFile">  <!-- command name as anchor inside quotes -->    
     405<A NAME="StationFile">  <!-- command name as anchor inside quotes --> 
    406406<PRE><B>StationFile <font color=red>sta_file</font>             ReadConfig              Station parameters 
    407 </B><!-- command args ... -->            
    408 </PRE> 
    409 <BLOCKQUOTE> <!-- command description goes here --> 
    410 Specifies <font color=red>sta_file</font> as the file of stations to be monitored by carlsubtrig.  
     407</B><!-- command args ... --> 
     408</PRE> 
     409<BLOCKQUOTE> <!-- command description goes here --> 
     410Specifies <font color=red>sta_file</font> as the file of stations to be monitored by carlsubtrig. 
    411411This file can be the same station file as the one for CarlStaTrig. This file must list all 
    412412the stations that make up the <A HREF="#Subnet">Subnets</A>. This file lists each station 
     
    414414This is the number of seconds that each station trigger will be help active in CarlSubTrig 
    415415after CarlStaTrig reports the station trigger off. This <B>Trigger Time To Live</B> allows 
    416 for the seismic signal propagation time from each station to the other stations in the  
     416for the seismic signal propagation time from each station to the other stations in the 
    417417subnet. 
    418418<PRE><!-- Default and example go here   --> 
     
    441441<HR> 
    442442 
    443 <A NAME="Subnet">  <!-- command name as anchor inside quotes -->         
     443<A NAME="Subnet">  <!-- command name as anchor inside quotes --> 
    444444<PRE><B>Subnet <font color=red>code ntrig sta.comp.net ...</font>       ReadSubnet      Subnet parameters 
    445  </B><!-- command args ... -->           
    446 </PRE> 
    447 <BLOCKQUOTE> <!-- command description goes here --> 
    448 This command lists the subnet <font color=red>code</font>, number of stations  
    449 <font color=red>ntrig</font> required to trigger the subnet, and the list of stations  
     445 </B><!-- command args ... --> 
     446</PRE> 
     447<BLOCKQUOTE> <!-- command description goes here --> 
     448This command lists the subnet <font color=red>code</font>, number of stations 
     449<font color=red>ntrig</font> required to trigger the subnet, and the list of stations 
    450450making up the subnet. <font color=red>Code</font> is a string (up to 3 characters) that 
    451451is used to identify the subnet in logged messages. There may be any number of <B>Subnet</B> commands, and there may be up 
    452 to 20 stations in one subnet.  
    453 <P> 
    454 This command supports a "|" symbol in the list of stations.  It differenitates  
    455 those stations to be used in the trigger count (stations to the left of "|") and  
    456 those stations that are not.  All stations in a subnet are recorded if sufficient stations  
    457 to the left of the "|" are triggered.  
    458 <P> 
    459 The "subnet" command supports non-numeric subnet names of a maximum of 9 characters.   
     452to 20 stations in one subnet. 
     453<P> 
     454This command supports a "|" symbol in the list of stations.  It differenitates 
     455those stations to be used in the trigger count (stations to the left of "|") and 
     456those stations that are not.  All stations in a subnet are recorded if sufficient stations 
     457to the left of the "|" are triggered. 
     458<P> 
     459The "subnet" command supports non-numeric subnet names of a maximum of 9 characters. 
    460460These non-numeric names are now stored and passed through to later routines through the triglist2k message. 
    461 If the subnet name is numeric, no subnet name is passed through to later routines.  Currently, the subnet names  
     461If the subnet name is numeric, no subnet name is passed through to later routines.  Currently, the subnet names 
    462462are used only in filenames written by sudsputaway. 
    463463 
     
    469469<HR> 
    470470 
    471 <A NAME="SubnetContrib">  <!-- command name as anchor inside quotes -->  
     471<A NAME="SubnetContrib">  <!-- command name as anchor inside quotes --> 
    472472<PRE><B>SubnetContrib <font color=red>nsecs</font>              ReadConfig              Subnet parameters 
    473  </B><!-- command args ... -->           
     473 </B><!-- command args ... --> 
    474474</PRE> 
    475475Specifies the number of seconds <font color=red>nsecs</font> that each triggered subnet 
    476476contributes to the total duration of the network trigger. The 
    477 minimum trigger duration is the sum of <A HREF="#PreEventTime">PreEventTime</A>,  
    478 <A HREF="#NetTriggerDur">NetTriggerDur</A> and <A HREF="#SubnetContrib">SubnetContrib</A>  
     477minimum trigger duration is the sum of <A HREF="#PreEventTime">PreEventTime</A>, 
     478<A HREF="#NetTriggerDur">NetTriggerDur</A> and <A HREF="#SubnetContrib">SubnetContrib</A> 
    479479times the number of subnets that triggered. 
    480480<BLOCKQUOTE> <!-- command description goes here --> 
     
    485485</BLOCKQUOTE> 
    486486<HR> 
    487 <A NAME="TrigIdFilename">  <!-- command name as anchor inside quotes -->         
     487<A NAME="TrigIdFilename">  <!-- command name as anchor inside quotes --> 
    488488<PRE><B>TrigIdFilename <font color=red>filename</font>          ReadConfig              Earthworm setup 
    489 </B><!-- command args ... -->            
     489</B><!-- command args ... --> 
    490490</PRE> 
    491491<BLOCKQUOTE> <!-- command description goes here --> 
     
    514514Debug           2               # Write out debug messages? (0 = No, 
    515515                                #   1 = Minimal, 3 = Chatterbox ) 
    516 RingNameIn      PICK_RING       # Name of ring from which station triggers  
     516RingNameIn      PICK_RING       # Name of ring from which station triggers 
    517517                                #   will be read - REQUIRED. 
    518518RingNameOut     HYPO_RING       # Name of ring to which triggers will be 
     
    536536MaxDuration     500             # Maximum duration allowed for network trigger 
    537537DefStationDur   120             # Default number of seconds for station 
    538                                 #   trigger duration if the trigger-off  
     538                                #   trigger duration if the trigger-off 
    539539                                #   message is not received. REQUIRED. 
    540540ListSubnets     1               # Flag to list untriggered stations 
    541                                 #   =0 or command not present: list all  
    542                                 #        triggered stations  
     541                                #   =0 or command not present: list all 
     542                                #        triggered stations 
    543543                                #   =1 list all stations in triggered subnets 
    544                                 #   =2 list all stations in triggered subnets  
    545                                 #        plus any other triggered stations.  
     544                                #   =2 list all stations in triggered subnets 
     545                                #        plus any other triggered stations. 
    546546                                #   =3 list all stations in subnets that had 
    547547                                #        any stations triggered 
     
    559559# or you can use this now so you can place it somewhere else: 
    560560 
    561 TrigIdFilename  trig/trig_id.d   # a new way to specify where the trig_id.d command  
     561TrigIdFilename  trig/trig_id.d   # a new way to specify where the trig_id.d command 
    562562 
    563563# List the message logos to grab from transport ring 
     
    567567# Non-seismic or other channels that should be included in all event messages 
    568568# List one SCNL per line, as many as you need 
    569 Channel  *.TIM.UW  
     569Channel  *.TIM.UW 
    570570Channel  LON.LHZ.UW.-- 
    571571 
     
    576576# ------- ---  ------------------------------------------- 
    577577Subnet 0   3   CRF.EHZ.UW.-- EPH.EHZ.UW.-- GBL.EHZ.UW.-- MDW.EHZ.UW.-- OT3.EHZ.UW.-- RC1.EHZ.UW.-- VT2.EHZ.UW.-- WA2.EHZ.UW.-- WRD.EHZ.UW.-- 
    578 Subnet 1   4   BRV.EHZ.UW.-- ET3.EHZ.UW.00 GBL.EHZ.UW.00 MDW.EHZ.UW.00 OT3.EHZ.UW.-- PRO.EHZ.UW.-- RSW.EHZ.UW.-- WA2.EHZ.UW.--  
     578Subnet 1   4   BRV.EHZ.UW.-- ET3.EHZ.UW.00 GBL.EHZ.UW.00 MDW.EHZ.UW.00 OT3.EHZ.UW.-- PRO.EHZ.UW.-- RSW.EHZ.UW.-- WA2.EHZ.UW.-- 
    579579 
    580580</PRE> 
     
    598598  station   JCW       EHZ           UW --     10 
    599599 
    600 </PRE>   
    601 <CENTER>  
    602 <A HREF="../modules.html">Module Index</A> |  
     600</PRE> 
     601<CENTER> 
     602<A HREF="../modules.html">Module Index</A> | 
    603603<A HREF="../ovr/carltrig_ovr.html">CarlStaTrig/CarlSubTrig Overview</A> | 
    604604<A HREF="carlstatrig.html">CarlStaTrig Commands</A> 
     
    608608<HR> 
    609609<ADDRESS> 
    610 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     610Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    611611</ADDRESS> 
    612612</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/cleandir_cmd.html

    r2298 r4571  
    2323Contact: </address> 
    2424<address> Questions? Issues? <a 
    25  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    26  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     25 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     26 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    2727</body> 
    2828</html> 
  • trunk/ewdoc/WEB_DOC/cmd/cmd_k2ew.html

    r2351 r4571  
    1717On startup, k2ew reads the configuration file named on the command 
    1818line. Commands in this file set all the parameters used for configuring 
    19 the Earthworm k2ew module. In the control file, lines may begin with a  
     19the Earthworm k2ew module. In the control file, lines may begin with a 
    2020valid k2ew command (listed below) or with one of 2 special characters: 
    2121 
    2222<BLOCKQUOTE><PRE> 
    23 #  marks the line as a comment (example: # This is a comment).<BR>    
    24 @  allows control files to be nested; one control file can be  
    25    accessed from another with the command "@" followed by  
    26    a string representing the path name of the next control file  
     23#  marks the line as a comment (example: # This is a comment).<BR> 
     24@  allows control files to be nested; one control file can be 
     25   accessed from another with the command "@" followed by 
     26   a string representing the path name of the next control file 
    2727   (example: @model.d). 
    2828</BLOCKQUOTE></PRE> 
    2929Command names must be typed in the control file exactly as shown in this 
    30 document (upper/lower case matters!). Blank lines are also permitted in the  
     30document (upper/lower case matters!). Blank lines are also permitted in the 
    3131control file. 
    3232<P> 
    3333<A NAME="function"> 
    3434<H2>1.  FUNCTIONAL COMMAND LISTING</H2> 
    35 <P>   
     35<P> 
    3636<!-- ADD HERE: Paragraph "Below are the commands recognized..." --> 
    37 Below are the commands recognized by k2ew, grouped by the function  
    38 they influence.  Some of the commands are required, as noted. They may be specified  
     37Below are the commands recognized by k2ew, grouped by the function 
     38they influence.  Some of the commands are required, as noted. They may be specified 
    3939in any order in the control file, with the exception of the K2 communications mode settings: 
    4040these must be listed in the order shown here. 
     
    8484<H2>2.  ALPHABETIC COMMAND LISTING & DESCRIPTION</H2> 
    8585<P> 
    86 In the following section, all configuration file commands are listed  
    87 in alphabetical order.  Listed along with the command (bold-type) are  
    88 its arguments (in red), the name of the subroutine that processes the  
    89 command, and the function within the module that the command influences.  
     86In the following section, all configuration file commands are listed 
     87in alphabetical order.  Listed along with the command (bold-type) are 
     88its arguments (in red), the name of the subroutine that processes the 
     89command, and the function within the module that the command influences. 
    9090A detailed description of the command and is also given.  Default values 
    9191and example commands are listed after each command description. 
     
    9797<!-- ADD HERE: all commands; below is a sample command blank: --> 
    9898 
    99 <A NAME="BasePinno">  <!-- command name as anchor inside quotes -->  
     99<A NAME="BasePinno">  <!-- command name as anchor inside quotes --> 
    100100<PRE><B>BasePinno <font color=red>n</font>                                 K2ew Configuration 
    101 </B><!-- command args ... -->            
     101</B><!-- command args ... --> 
    102102</PRE> 
    103103<BLOCKQUOTE> <!-- command description goes here --> 
     
    113113 
    114114 
    115 <A NAME="ComPort">  <!-- command name as anchor inside quotes -->  
     115<A NAME="ComPort">  <!-- command name as anchor inside quotes --> 
    116116<PRE><B>ComPort <font color=red>n</font>                                     WindowsNT COM mode 
    117 </B><!-- command args ... -->            
     117</B><!-- command args ... --> 
    118118</PRE> 
    119119<BLOCKQUOTE> <!-- command description goes here --> 
    120120Set the WindowsNT communications port to COM<font color=red>n</font>. 
    121 This command can only be used with k2ew_com on WindowsNT. K2ew supports COM  
     121This command can only be used with k2ew_com on WindowsNT. K2ew supports COM 
    122122port numbers up to 256; the PC must be specially configured to use anything 
    123123besides COM port 1 or 2. 
     
    129129<HR> 
    130130 
    131 <A NAME="CommTimeout">  <!-- command name as anchor inside quotes -->  
     131<A NAME="CommTimeout">  <!-- command name as anchor inside quotes --> 
    132132<PRE><B>CommTimeout <font color=red>N</font>                                K2ew Buffer and Timing 
    133 </B><!-- command args ... -->            
     133</B><!-- command args ... --> 
    134134</PRE> 
    135135<BLOCKQUOTE> <!-- command description goes here --> 
     
    149149<HR> 
    150150 
    151 <A NAME="Debug">  <!-- command name as anchor inside quotes -->  
    152 <PRE><B>Debug <font color=red>N</font>                                     Earthworm setup  
    153 </B><!-- command args ... -->            
     151<A NAME="Debug">  <!-- command name as anchor inside quotes --> 
     152<PRE><B>Debug <font color=red>N</font>                                     Earthworm setup 
     153</B><!-- command args ... --> 
    154154</PRE> 
    155155<BLOCKQUOTE> <!-- command description goes here --> 
     
    163163<HR> 
    164164 
    165 <A NAME="DontQuit">  <!-- command name as anchor inside quotes -->  
     165<A NAME="DontQuit">  <!-- command name as anchor inside quotes --> 
    166166<PRE><B>DontQuit                                K2ew Buffer and Timing 
    167 </B><!-- command args ... -->            
    168 </PRE> 
    169 <BLOCKQUOTE> <!-- command description goes here --> 
    170 If present, this command tells k2ew not to quit on timeout conditions while  
     167</B><!-- command args ... --> 
     168</PRE> 
     169<BLOCKQUOTE> <!-- command description goes here --> 
     170If present, this command tells k2ew not to quit on timeout conditions while 
    171171attempting to read data from teh K2. Instead of quiting, a log entry will be 
    172172made when the timeout condition starts, and when k2ew resumes reading data 
     
    179179<HR> 
    180180 
    181 <A NAME="ExtStatus">  <!-- command name as anchor inside quotes -->  
     181<A NAME="ExtStatus">  <!-- command name as anchor inside quotes --> 
    182182<PRE><B>ExtStatus                                K2ew Status and Alarm Parameters 
    183 </B><!-- command args ... -->            
    184 </PRE> 
    185 <BLOCKQUOTE> <!-- command description goes here --> 
    186 Request K2 `extended' status in addition to the regular status messages. See  
     183</B><!-- command args ... --> 
     184</PRE> 
     185<BLOCKQUOTE> <!-- command description goes here --> 
     186Request K2 `extended' status in addition to the regular status messages. See 
    187187<A HREF="#StatusInterval">StatusInterval</A> for obtaining K2 status messages. 
    188188The extended status message includes temperature at the K2, last K2 restart 
     
    198198<HR> 
    199199 
    200 <A NAME="HeartbeatInterval">  <!-- command name as anchor inside quotes -->     
     200<A NAME="HeartbeatInterval">  <!-- command name as anchor inside quotes --> 
    201201<PRE><B>HeartbeatInterval <font color=red>nsec</font>                             Earthworm Setup 
    202 </B><!-- command args ... -->            
    203 </PRE> 
    204 <BLOCKQUOTE> <!-- command description goes here --> 
    205 Defines the number of seconds, <font color=red>nsec</font> between TYPE_HEARTBEAT  
     202</B><!-- command args ... --> 
     203</PRE> 
     204<BLOCKQUOTE> <!-- command description goes here --> 
     205Defines the number of seconds, <font color=red>nsec</font> between TYPE_HEARTBEAT 
    206206messages issued by k2ew. 
    207207<PRE><!-- Default and example go here   --> 
     
    212212<HR> 
    213213 
    214 <A NAME="HighTempAlarm">  <!-- command name as anchor inside quotes -->  
     214<A NAME="HighTempAlarm">  <!-- command name as anchor inside quotes --> 
    215215<PRE><B>HighTempAlarm <font color=red>N</font>                          K2ew Status and Alarm Parameters 
    216 </B><!-- command args ... -->            
     216</B><!-- command args ... --> 
    217217</PRE> 
    218218<BLOCKQUOTE> <!-- command description goes here --> 
     
    220220of a degree C. That is, for an alarm at 30 C, use a setting of 300 here. 
    221221When this threshold is exceeded, k2ew sends a status message to statmgr, 
    222 which can be configured to send email or pages.  
     222which can be configured to send email or pages. 
    223223<PRE><!-- Default and example go here   --> 
    224224Default:  1000   # (for an alarm at 100 C, essentially no alarm) 
     
    228228<HR> 
    229229 
    230 <A NAME="LogFile">  <!-- command name as anchor inside quotes -->      
     230<A NAME="LogFile">  <!-- command name as anchor inside quotes --> 
    231231<PRE><B>LogFile <font color=red>switch</font>                                     Earthworm Setup 
    232 </B><!-- command args ... -->            
    233 </PRE> 
    234 <BLOCKQUOTE> <!-- command description goes here --> 
    235 Sets the on-off switch for writing a log file to disk. If  
    236 <font color=red>switch</font> is 0, no log file will be written. If  
    237 <font color=red>switch</font> is non-zero, k2ew will write daily log file(s)  
     232</B><!-- command args ... --> 
     233</PRE> 
     234<BLOCKQUOTE> <!-- command description goes here --> 
     235Sets the on-off switch for writing a log file to disk. If 
     236<font color=red>switch</font> is 0, no log file will be written. If 
     237<font color=red>switch</font> is non-zero, k2ew will write daily log file(s) 
    238238called nnnnnxx.log_yyyymmdd where nnnnn is the name of the configuration file 
    239 (with the suffix `.d' removed), xx is k2ew's module id (set with  
    240 <A HREF="#ModuleId">ModuleId</A> command) and yyyymmdd is the current UTC  
    241 date (ex: 19960123) on the system clock. The file(s)  
    242 will be written in the EW_LOG directory (environment variable).  
    243 <P>The log file is particularly useful for k2ew because it records  
     239(with the suffix `.d' removed), xx is k2ew's module id (set with 
     240<A HREF="#ModuleId">ModuleId</A> command) and yyyymmdd is the current UTC 
     241date (ex: 19960123) on the system clock. The file(s) 
     242will be written in the EW_LOG directory (environment variable). 
     243<P>The log file is particularly useful for k2ew because it records 
    244244<A HREF="#StatusInterval">status</A> and event messages sent by the K2. These 
    245245messages also appear on the k2ew console window when running on WindowsNT. 
     
    251251<HR> 
    252252 
    253 <A NAME="OnBattery">  <!-- command name as anchor inside quotes -->  
     253<A NAME="OnBattery">  <!-- command name as anchor inside quotes --> 
    254254<PRE><B>OnBattery                           K2ew Status and Alarm Parameters 
    255 </B><!-- command args ... -->            
     255</B><!-- command args ... --> 
    256256</PRE> 
    257257<BLOCKQUOTE> <!-- command description goes here --> 
    258258If present, this command enables reporting of "loss of external power" alarm. 
    259259The K2 reports battery voltage in its status message. When external power is 
    260 provided, the K2 reports battery voltage as zero. Since a real battery  
     260provided, the K2 reports battery voltage as zero. Since a real battery 
    261261voltage of zero would not let the K2 do anything, this is reasonable. When 
    262262the K2 first reports battery voltage as non-zero (indicating external power 
     
    264264command applies to both internal and external batteries. But since the K2 
    265265does not normally have external power (from a 110 VAC power adapter) while 
    266 using an external battery, this command should not be used when using an  
     266using an external battery, this command should not be used when using an 
    267267external battery. Any provision for charging an external battery is separate 
    268268from the K2 and would not be monitored by k2ew. 
     
    274274<HR> 
    275275 
    276 <A NAME="LowBattAlarm">  <!-- command name as anchor inside quotes -->  
     276<A NAME="LowBattAlarm">  <!-- command name as anchor inside quotes --> 
    277277<PRE><B>LowBattAlarm <font color=red>N</font>                           K2ew Status and Alarm Parameters 
    278 </B><!-- command args ... -->            
    279 </PRE> 
    280 <BLOCKQUOTE> <!-- command description goes here --> 
    281 Set the low battery voltage alarm threshold to <font color=red>N</font>  
    282 tenths of a volt. When this threshold is exceeded, k2ew sends a status message  
     278</B><!-- command args ... --> 
     279</PRE> 
     280<BLOCKQUOTE> <!-- command description goes here --> 
     281Set the low battery voltage alarm threshold to <font color=red>N</font> 
     282tenths of a volt. When this threshold is exceeded, k2ew sends a status message 
    283283to statmgr, which can be configured to send email or pages. The K2 reports its 
    284284battery voltage in the <A HREF="#StatusInterval">status</A> message. When the 
    285285K2 is powered from external sources, it reports the voltage as `0'. The actual 
    286 battery voltage is reported only when the K2 is running off the internal  
     286battery voltage is reported only when the K2 is running off the internal 
    287287battery. See the K2 User Manual for recommended battery voltages and 
    288288maintenance. 
     
    294294<HR> 
    295295 
    296 <A NAME="LowTempAlarm">  <!-- command name as anchor inside quotes -->  
     296<A NAME="LowTempAlarm">  <!-- command name as anchor inside quotes --> 
    297297<PRE><B>LowTempAlarm <font color=red>N</font>                           K2ew Status and Alarm Parameters 
    298 </B><!-- command args ... -->            
     298</B><!-- command args ... --> 
    299299</PRE> 
    300300<BLOCKQUOTE> <!-- command description goes here --> 
     
    310310<HR> 
    311311 
    312 <A NAME="MaxRestartAge">  <!-- command name as anchor inside quotes -->  
     312<A NAME="MaxRestartAge">  <!-- command name as anchor inside quotes --> 
    313313<PRE><B>MaxRestartAge <font color=red>N</font>                           K2ew Buffer and Timing 
    314 </B><!-- command args ... -->            
     314</B><!-- command args ... --> 
    315315</PRE> 
    316316<BLOCKQUOTE> <!-- command description goes here --> 
     
    318318to <font color=red>N</font> seconds. When k2ew starts up, it reads the restart 
    319319file if it exists. If the restart file is younger than this limit, k2ew will 
    320 attempt to resume stream data from the K2 at the last packet k2ew sent before  
     320attempt to resume stream data from the K2 at the last packet k2ew sent before 
    321321last shut down. This will allow the trace data from this K2 to be sent to 
    322322earthworm in time-order, though it will be late in arriving at the earthworm 
    323 transport <A HREF="#RingName">ring</A>. <B>MaxRestartAge</B> should be less  
     323transport <A HREF="#RingName">ring</A>. <B>MaxRestartAge</B> should be less 
    324324than <A HREF="#WaitTime">WaitTime</A>. 
    325325For this restart feature to work, the K2 stream 
     
    328328<P> 
    329329Because of limitations in the K2, it is recommended that this value be limited 
    330 to about 120 seconds. When trying to recover from longer restarts, the K2 may  
    331 not be able to keep up with its processing. The result will be gaps in the  
     330to about 120 seconds. When trying to recover from longer restarts, the K2 may 
     331not be able to keep up with its processing. The result will be gaps in the 
    332332trace data with no accompanying gaps in packet sequence numbers. 
    333333<PRE><!-- Default and example go here   --> 
     
    339339 
    340340 
    341 <A NAME="MinDiskKB">  <!-- command name as anchor inside quotes -->  
     341<A NAME="MinDiskKB">  <!-- command name as anchor inside quotes --> 
    342342<PRE><B>MinDiskKB <font color=red>Na Nb</font>                            K2ew Status and Alarms 
    343 </B><!-- command args ... -->            
    344 </PRE> 
    345 <BLOCKQUOTE> <!-- command description goes here --> 
    346 Sets the alarm thresholds for low disk space for disk A to  
     343</B><!-- command args ... --> 
     344</PRE> 
     345<BLOCKQUOTE> <!-- command description goes here --> 
     346Sets the alarm thresholds for low disk space for disk A to 
    347347<font color=red>Na</font> KiloBytes and disk B to <font color=red>Nb</font> 
    348  KiloBytes. When this threshold is exceeded, k2ew sends a status message  
    349 to statmgr, which can be configured to send email or pages. The K2 reports  
     348 KiloBytes. When this threshold is exceeded, k2ew sends a status message 
     349to statmgr, which can be configured to send email or pages. The K2 reports 
    350350free disk space in the <A HREF="#StatusInterval">status</A> message. Some 
    351351K2s have a disk (actually a PCMCIA solid-state memory device) installed only 
     
    360360 
    361361 
    362 <A NAME="ModuleId">  <!-- command name as anchor inside quotes -->     
     362<A NAME="ModuleId">  <!-- command name as anchor inside quotes --> 
    363363<PRE><B>ModuleId <font color=red>mod_id</font>                                  Earthworm setup 
    364 </B><!-- command args ... -->            
    365 </PRE> 
    366 <BLOCKQUOTE> <!-- command description goes here --> 
    367 Sets the module id for labeling all outgoing trigger, heartbeat, and error  
     364</B><!-- command args ... --> 
     365</PRE> 
     366<BLOCKQUOTE> <!-- command description goes here --> 
     367Sets the module id for labeling all outgoing trigger, heartbeat, and error 
    368368messages. <font color=red>mod_id</font> is a character string (valid strings 
    369 are listed in earthworm.d) that relates to a unique single-byte number. In  
     369are listed in earthworm.d) that relates to a unique single-byte number. In 
    370370general, a different module ID is needed for each instance of k2ew. 
    371371<PRE><!-- Default and example go here   --> 
     
    376376<HR> 
    377377 
    378 <A NAME="Network">  <!-- command name as anchor inside quotes -->  
     378<A NAME="Network">  <!-- command name as anchor inside quotes --> 
    379379<PRE><B>Network <font color=red>net-code</font>                              K2 Configuration 
    380 </B><!-- command args ... -->            
    381 </PRE> 
    382 <BLOCKQUOTE> <!-- command description goes here --> 
    383 Sets the network name for earthworm trace packets to  
     380</B><!-- command args ... --> 
     381</PRE> 
     382<BLOCKQUOTE> <!-- command description goes here --> 
     383Sets the network name for earthworm trace packets to 
    384384<font color=red>net-code</font>. All earthworm trace packets are identified by 
    385385their station, component, and network names (SCN). K2ew obtains the station 
    386 name from the K2. (The K2 is configured separately from k2ew; see the K2 User  
    387 Manual from Kinemetrics.) The K2 may also have its component names configured  
     386name from the K2. (The K2 is configured separately from k2ew; see the K2 User 
     387Manual from Kinemetrics.) The K2 may also have its component names configured 
    388388in it. If so, k2ew will use these names; otherwise it will name the components 
    389 "CH1", "CH2", etc. The third part of the SCN is set by the <B>Network</B>  
     389"CH1", "CH2", etc. The third part of the SCN is set by the <B>Network</B> 
    390390command. 
    391391<PRE><!-- Default and example go here   --> 
     
    396396<HR> 
    397397 
    398 <A NAME="RestartFile">  <!-- command name as anchor inside quotes -->  
     398<A NAME="RestartFile">  <!-- command name as anchor inside quotes --> 
    399399<PRE><B>RestartFile <font color=red>filename</font>                              K2ew Buffer and Timing 
    400 </B><!-- command args ... -->            
     400</B><!-- command args ... --> 
    401401</PRE> 
    402402<BLOCKQUOTE> <!-- command description goes here --> 
     
    407407mechanism that k2ew uses with the K2. If <font color=red>filename</font> is the 
    408408null string (""), or the <B>Restart</B> command is absent, the restart 
    409 mechanism is disabled and now restart file will be written.  
    410  <P>The restart file name must be unique for each instance of k2ew. This is  
     409mechanism is disabled and now restart file will be written. 
     410 <P>The restart file name must be unique for each instance of k2ew. This is 
    411411because k2ew reads the station name from this file instead of from the K2. If 
    412412this file contains the wrong station name, then the trace data will be labeled 
     
    421421<HR> 
    422422 
    423 <A NAME="RingName">  <!-- command name as anchor inside quotes -->        
     423<A NAME="RingName">  <!-- command name as anchor inside quotes --> 
    424424<PRE><B>RingName <font color=red>ring</font>                                      Earthworm setup 
    425 </B><!-- command args ... -->            
     425</B><!-- command args ... --> 
    426426</PRE> 
    427427<BLOCKQUOTE> <!-- command description goes here --> 
    428428Tells k2ew which shared memory region to use for output. <font color=red>ring</font> is a character 
    429429string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a 
    430 unique number for the key to the shared memory region.  
     430unique number for the key to the shared memory region. 
    431431<PRE><!-- Default and example go here   --> 
    432432Default:  none 
     
    436436<HR> 
    437437 
    438 <A NAME="Speed">  <!-- command name as anchor inside quotes -->  
     438<A NAME="Speed">  <!-- command name as anchor inside quotes --> 
    439439<PRE><B>Speed <font color=red>N</font>                                     K2ew COM and TTY modes 
    440 </B><!-- command args ... -->            
     440</B><!-- command args ... --> 
    441441</PRE> 
    442442<BLOCKQUOTE> <!-- command description goes here --> 
    443443Set the serial port speed to <font color=red>N</font> bits per second. 
    444444This speed must match the speed setting of whatever device is connected to 
    445 the COM or TTY ports (on WindowsNT or Unix, respectively.) This may be the K2  
     445the COM or TTY ports (on WindowsNT or Unix, respectively.) This may be the K2 
    446446if it is connected directly to the computer by RS-232 cable, or another device 
    447447such as a <A HREF="http://www.lantronix.com">Lantronix</A> MSS100 for serial 
    448448tunneling over IP. This command is required, and must follow, after either 
    449 the <A HREF="#ComPort">ComPort</A> (on WindowsNT) or the  
     449the <A HREF="#ComPort">ComPort</A> (on WindowsNT) or the 
    450450<A HREF="#TtyName">TtyName</A></A> (on Unix) commands if they are used. 
    451451<PRE><!-- Default and example go here   --> 
     
    456456<HR> 
    457457 
    458 <A NAME="StatusInterval">  <!-- command name as anchor inside quotes -->  
     458<A NAME="StatusInterval">  <!-- command name as anchor inside quotes --> 
    459459<PRE><B>StatusInterval <font color=red>N</font>                           K2ew Buffer and Timing 
    460 </B><!-- command args ... -->            
    461 </PRE> 
    462 <BLOCKQUOTE> <!-- command description goes here --> 
    463 Commands k2ew to request a status message from the K2 every  
    464 <font color=red>N</font> minutes. If configured, the  
     460</B><!-- command args ... --> 
     461</PRE> 
     462<BLOCKQUOTE> <!-- command description goes here --> 
     463Commands k2ew to request a status message from the K2 every 
     464<font color=red>N</font> minutes. If configured, the 
    465465<A HREF="#ExtStatus">extended</A> status message will be requested at the 
    466466same time. The status message from the K2 includes K2 time, battery voltage, 
    467467hardware status flag (OK/FAULT), alarm and trigger status, and disk status. 
    468 All information from the status message is logged in the k2ew log file and  
     468All information from the status message is logged in the k2ew log file and 
    469469printed to the standard-error output stream. 
    470470<PRE><!-- Default and example go here   --> 
     
    475475<HR> 
    476476 
    477 <A NAME="TcpAddr">  <!-- command name as anchor inside quotes -->  
     477<A NAME="TcpAddr">  <!-- command name as anchor inside quotes --> 
    478478<PRE><B>TcpAddr <font color=red>address</font>                           K2 TCP communications 
    479 </B><!-- command args ... -->            
     479</B><!-- command args ... --> 
    480480</PRE> 
    481481<BLOCKQUOTE> <!-- command description goes here --> 
    482482Sets the IP <font color=red>address</font> of the network device that is 
    483 connected to the serial port of the K2, for TCP communications mode on  
     483connected to the serial port of the K2, for TCP communications mode on 
    484484WindowsNT and Unix. Note that the K2 does not have a network device installed, 
    485485this is a separate piece of hardware. This address can be a numerical IP 
     
    492492<HR> 
    493493 
    494 <A NAME="TcpPort">  <!-- command name as anchor inside quotes -->  
     494<A NAME="TcpPort">  <!-- command name as anchor inside quotes --> 
    495495<PRE><B>TcpPort <font color=red>N</font>                                K2 TCP Communication Mode 
    496 </B><!-- command args ... -->            
    497 </PRE> 
    498 <BLOCKQUOTE> <!-- command description goes here --> 
    499 Set TCP port number for the network device connected to the K2 to  
     496</B><!-- command args ... --> 
     497</PRE> 
     498<BLOCKQUOTE> <!-- command description goes here --> 
     499Set TCP port number for the network device connected to the K2 to 
    500500<font color=red>N</font>. This is the port number for establishing 
    501501communications through the network device to the K2. This command is 
     
    508508<HR> 
    509509 
    510 <A NAME="TtyName">  <!-- command name as anchor inside quotes -->  
     510<A NAME="TtyName">  <!-- command name as anchor inside quotes --> 
    511511<PRE><B>TtyName <font color=red>tty</font>                              K2 TTY Communications 
    512 </B><!-- command args ... -->            
     512</B><!-- command args ... --> 
    513513</PRE> 
    514514<BLOCKQUOTE> <!-- command description goes here --> 
     
    526526<HR> 
    527527 
    528 <A NAME="WaitTime">  <!-- command name as anchor inside quotes -->  
     528<A NAME="WaitTime">  <!-- command name as anchor inside quotes --> 
    529529<PRE><B>WaitTime <font color=red>N</font>                           K2ew Buffer and Timing 
    530 </B><!-- command args ... -->            
     530</B><!-- command args ... --> 
    531531</PRE> 
    532532<BLOCKQUOTE> <!-- command description goes here --> 
    533533Set the maximum time for which k2ew will wait for packets to be resent from 
    534534the K2 to <font color=red>N</font> seconds. After this time limit, these 
    535 packets will be skipped. K2ew will place `waiting' slots in its  
    536 internal buffer to be filled when it receives the requested packets from the  
     535packets will be skipped. K2ew will place `waiting' slots in its 
     536internal buffer to be filled when it receives the requested packets from the 
    537537K2. Output from k2ew to the transport ring will wait until either the requested 
    538538packet is received, the time limit expires for a waiting packet, or the number 
    539539of re-send requests is exceeded. This will action 
    540 ensure that trace packets are sent to other earthworm modules in time order.  
     540ensure that trace packets are sent to other earthworm modules in time order. 
    541541<PRE><!-- Default and example go here   --> 
    542542Default:  60 
     
    573573 
    574574BasePinno     1001              # Earthworm pin numbers are assigned by 
    575                                 # adding this base number to the stream  
    576                                 # number (0 - 5) of each packet  
     575                                # adding this base number to the stream 
     576                                # number (0 - 5) of each packet 
    577577                                # default: 0 
    578578 
     
    580580                                # a name for the restart file. It MUST be 
    581581                                # a unique name for this K2 or gross confusion 
    582                                 # will result!  
     582                                # will result! 
    583583                                # default: none 
    584584 
    585585MaxRestartAge    60             # Maximum age of the restart file, in seconds 
    586586                                # If the restart file is older than this 
    587                                 # when k2ew restarts, a normal start will  
     587                                # when k2ew restarts, a normal start will 
    588588                                # be used. 
    589589                                # Should be less than WaitTime (below) 
     
    631631<HR> 
    632632 
    633 <CENTER>  
    634 <A HREF="../modules.html">Module Index</A> |  
     633<CENTER> 
     634<A HREF="../modules.html">Module Index</A> | 
    635635<A HREF="../ovr/k2ew_ovr.html">K2ew Overview</A> 
    636636</CENTER> 
     
    639639<HR> 
    640640<ADDRESS> 
    641 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     641Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    642642</ADDRESS> 
    643643</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/coaxtoring_cmd.html

    r2369 r4571  
    66<BODY aLink=#ff0000 bgColor=#fadfaf link=#0000ee text=#000000 vLink=#551a8b> 
    77<CENTER> 
    8 <H1>Coaxtoring Configuration File Commands</H1><I>(last revised 29 July  
    9 1998)</I></CENTER>Page Index:<BR>1. <A  
    10 href="coaxtoring_cmd.html#example">Example  
    11 configuration file</A><BR>2. <A  
    12 href="coaxtoring_cmd.html#function">Functional  
    13 command listing</A><BR>3. <A  
    14 href="coaxtoring_cmd.html#alphabet">Alphabetic  
    15 command listing &amp; description</A>  
    16 <P><!-- ADD HERE: Paragraph "On startup, xxxx reads the..." -->On startup,  
    17 coaxtoring reads the configuration file named on the command line. Commands in  
    18 this file set up all parameters used in receiving UDP broadcast Earthworm  
    19 messages from the network and placing them into shared memory. In the control  
    20 file, lines may begin with a valid coaxtoring command (listed below) or with one  
    21 of 2 special characters:  
    22 <BLOCKQUOTE><PRE>#  marks the line as a comment (example: # This is a comment).<BR>    
    23 @  allows control files to be nested; one control file can be  
    24    accessed from another with the command "@" followed by  
    25    a string representing the path name of the next control file  
     8<H1>Coaxtoring Configuration File Commands</H1><I>(last revised 29 July 
     91998)</I></CENTER>Page Index:<BR>1. <A 
     10href="coaxtoring_cmd.html#example">Example 
     11configuration file</A><BR>2. <A 
     12href="coaxtoring_cmd.html#function">Functional 
     13command listing</A><BR>3. <A 
     14href="coaxtoring_cmd.html#alphabet">Alphabetic 
     15command listing &amp; description</A> 
     16<P><!-- ADD HERE: Paragraph "On startup, xxxx reads the..." -->On startup, 
     17coaxtoring reads the configuration file named on the command line. Commands in 
     18this file set up all parameters used in receiving UDP broadcast Earthworm 
     19messages from the network and placing them into shared memory. In the control 
     20file, lines may begin with a valid coaxtoring command (listed below) or with one 
     21of 2 special characters: 
     22<BLOCKQUOTE><PRE>#  marks the line as a comment (example: # This is a comment).<BR> 
     23@  allows control files to be nested; one control file can be 
     24   accessed from another with the command "@" followed by 
     25   a string representing the path name of the next control file 
    2626   (example: @model.d). 
    27 </PRE></BLOCKQUOTE><PRE></PRE>Command names must be typed in the control file exactly as shown in  
    28 this document (upper/lower case matters!).  
     27</PRE></BLOCKQUOTE><PRE></PRE>Command names must be typed in the control file exactly as shown in 
     28this document (upper/lower case matters!). 
    2929<P><A name=example></a> 
    3030<H2>1. EXAMPLE CONFIGURATION FILE</H2><PRE># 
     
    6060                                # Max value is system dependent 
    6161                                #  (typically 260000) 
    62                                 # If you set =0, it will default to the  
     62                                # If you set =0, it will default to the 
    6363                                        # system default. (typically 8192) 
    6464</PRE> 
    6565<P><A name=function></a> 
    6666<H2>2. FUNCTIONAL COMMAND LISTING</H2> 
    67 <P><!-- ADD HERE: Paragraph "Below are the commands recognized..." -->Below are  
    68 the commands recognized by coaxtoring, grouped by the function they influence.  
    69 All of the commands are required; they must be specified in the control file in  
     67<P><!-- ADD HERE: Paragraph "Below are the commands recognized..." -->Below are 
     68the commands recognized by coaxtoring, grouped by the function they influence. 
     69All of the commands are required; they must be specified in the control file in 
    7070order for coaxtoring to operate. <!-- ADD HERE: The pre-formatted functional command listing      --><!-- To make an anchor for each command, surround it with these: --><PRE>         Earthworm system setup: 
    7171                <A href="coaxtoring_cmd.html#HeartBeatInt">HeartBeatInt</A>             required 
     
    8888</PRE><A name=alphabet></a> 
    8989<H2>3. ALPHABETIC COMMAND LISTING &amp; DESCRIPTION</H2> 
    90 <P>In the following section, all configuration file commands are listed in  
    91 alphabetical order. Listed along with the command (bold-type) are its arguments  
    92 (in red), the name of the subroutine that processes the command, and the  
    93 function within the module that the command influences. A detailed description  
    94 of the command and is also given. Default values and example commands are listed  
     90<P>In the following section, all configuration file commands are listed in 
     91alphabetical order. Listed along with the command (bold-type) are its arguments 
     92(in red), the name of the subroutine that processes the command, and the 
     93function within the module that the command influences. A detailed description 
     94of the command and is also given. Default values and example commands are listed 
    9595after each command description. <PRE><B> 
    9696command <FONT color=red>arg1</FONT>                             processed by            function 
    9797</b></PRE> 
    9898<HR> 
    99 <!-- ADD HERE: all commands; below is a sample command blank: --><A  
    100 name=BufferReportInt></a><!-- command name as anchor inside quotes --><PRE><B>BufferReportInt <FONT color=red>nbytes</FONT>                     coaxtoring_config       msg handling</B><!-- command args ... -->                
    101 </PRE> 
    102 <BLOCKQUOTE><!-- command description goes here -->Print high buffer count  
     99<!-- ADD HERE: all commands; below is a sample command blank: --><A 
     100name=BufferReportInt></a><!-- command name as anchor inside quotes --><PRE><B>BufferReportInt <FONT color=red>nbytes</FONT>                     coaxtoring_config       msg handling</B><!-- command args ... --> 
     101</PRE> 
     102<BLOCKQUOTE><!-- command description goes here -->Print high buffer count 
    103103  every n seconds <PRE><!-- Default and example go here   --> 
    104104Default:  none 
     
    106106</PRE></BLOCKQUOTE> 
    107107<HR> 
    108 <A name=HeartBeatInt></a><!-- command name as anchor inside quotes --><PRE><B>HeartBeatInt <FONT color=red>nsec</FONT>                  coaxtoring_config       Earthworm setup</B><!-- command args ... -->             
    109 </PRE> 
    110 <BLOCKQUOTE><!-- command description goes here -->Defines the number of  
    111   seconds <FONT color=red>nsec</FONT> between TYPE_HEARTBEAT messages issued by  
     108<A name=HeartBeatInt></a><!-- command name as anchor inside quotes --><PRE><B>HeartBeatInt <FONT color=red>nsec</FONT>                  coaxtoring_config       Earthworm setup</B><!-- command args ... --> 
     109</PRE> 
     110<BLOCKQUOTE><!-- command description goes here -->Defines the number of 
     111  seconds <FONT color=red>nsec</FONT> between TYPE_HEARTBEAT messages issued by 
    112112  coaxtoring. <PRE><!-- Default and example go here   --> 
    113 Default:  none   
     113Default:  none 
    114114Calnet:   HeartBeatInt 5 
    115115</PRE></BLOCKQUOTE> 
    116116<HR> 
    117 <A name=InAddress></a><!-- command name as anchor inside quotes --><PRE><B>InAddress <FONT color=red>a.b.c.d</FONT>                     coaxtoring_config       network info</B><!-- command args ... -->                
    118 </PRE> 
    119 <BLOCKQUOTE><!-- command description goes here -->Tells coaxtoring the TCP/IP  
    120   address of the ethernet line that it should listen to. <FONT  
    121   color=red>a.b.c.d</FONT> is a character string in tcp/ip's standard  
    122   dotted-decimal notation that coaxtoring uses along with the port number from  
    123   the "PortNumber" command to set up a socket from which it will receive UDP  
    124   Datagram packets. Under Solaris, the "d" part of the address should be set to  
    125   255 (for example a.b.c.255). Under NT, the "d" part of the address should be  
     117<A name=InAddress></a><!-- command name as anchor inside quotes --><PRE><B>InAddress <FONT color=red>a.b.c.d</FONT>                     coaxtoring_config       network info</B><!-- command args ... --> 
     118</PRE> 
     119<BLOCKQUOTE><!-- command description goes here -->Tells coaxtoring the TCP/IP 
     120  address of the ethernet line that it should listen to. <FONT 
     121  color=red>a.b.c.d</FONT> is a character string in tcp/ip's standard 
     122  dotted-decimal notation that coaxtoring uses along with the port number from 
     123  the "PortNumber" command to set up a socket from which it will receive UDP 
     124  Datagram packets. Under Solaris, the "d" part of the address should be set to 
     125  255 (for example a.b.c.255). Under NT, the "d" part of the address should be 
    126126  set to the complete local address, eg 192.168.4.107. <PRE><!-- Default and example go here   --> 
    127 Default:  none                   
     127Default:  none 
    128128Example:  InAddress 130.118.49.255 (Solaris) 
    129 Example:  InAddress 192.168.4.107 (NT)  
    130 </PRE></BLOCKQUOTE> 
    131 <HR> 
    132 <A name=LogFile></a><!-- command name as anchor inside quotes --><PRE><B>LogFile <FONT color=red>switch</FONT>                          coaxtoring_config       output</B><!-- command args ... -->              
    133 </PRE> 
    134 <BLOCKQUOTE><!-- command description goes here -->Sets the on-off switch for  
    135   writing a log file to disk. If <FONT color=red>switch</FONT> is 0, no log file  
    136   will be written. If <FONT color=red>switch</FONT> is 1, coaxtoring will write  
    137   a daily log file(s) called coaxtoringxx.log_yymmdd where xx is coaxtoring's  
    138   module id (set with "MyModuleId" command) and yymmdd is the current UTC date  
    139   (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG  
     129Example:  InAddress 192.168.4.107 (NT) 
     130</PRE></BLOCKQUOTE> 
     131<HR> 
     132<A name=LogFile></a><!-- command name as anchor inside quotes --><PRE><B>LogFile <FONT color=red>switch</FONT>                          coaxtoring_config       output</B><!-- command args ... --> 
     133</PRE> 
     134<BLOCKQUOTE><!-- command description goes here -->Sets the on-off switch for 
     135  writing a log file to disk. If <FONT color=red>switch</FONT> is 0, no log file 
     136  will be written. If <FONT color=red>switch</FONT> is 1, coaxtoring will write 
     137  a daily log file(s) called coaxtoringxx.log_yymmdd where xx is coaxtoring's 
     138  module id (set with "MyModuleId" command) and yymmdd is the current UTC date 
     139  (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG 
    140140  directory (environment variable). <PRE><!-- Default and example go here   --> 
    141141Default:  none 
    142142</PRE></BLOCKQUOTE> 
    143143<HR> 
    144 <A name=MsgMaxBytes></a><!-- command name as anchor inside quotes --><PRE><B>MsgMaxBytes <FONT color=red>nbytes</FONT>                  coaxtoring_config       msg handling</B><!-- command args ... -->                
    145 </PRE> 
    146 <BLOCKQUOTE><!-- command description goes here -->Sets the size, in bytes, of  
    147   the working buffers that coaxtoring uses for rebuilding complete Earthworm  
    148   messages out of the UDP packets. <FONT color=red>nbytes</FONT> should be the  
    149   size of the largest message you expect coaxtoring to receive. If coaxtoring  
    150   receives a message larger than <FONT color=red>nbytes</FONT>, it will drop the  
    151   entire message and issue a TYPE_ERROR message containing the string "Message  
     144<A name=MsgMaxBytes></a><!-- command name as anchor inside quotes --><PRE><B>MsgMaxBytes <FONT color=red>nbytes</FONT>                  coaxtoring_config       msg handling</B><!-- command args ... --> 
     145</PRE> 
     146<BLOCKQUOTE><!-- command description goes here -->Sets the size, in bytes, of 
     147  the working buffers that coaxtoring uses for rebuilding complete Earthworm 
     148  messages out of the UDP packets. <FONT color=red>nbytes</FONT> should be the 
     149  size of the largest message you expect coaxtoring to receive. If coaxtoring 
     150  receives a message larger than <FONT color=red>nbytes</FONT>, it will drop the 
     151  entire message and issue a TYPE_ERROR message containing the string "Message 
    152152  buffer overflow" and the logo of the dropped message. <PRE><!-- Default and example go here   --> 
    153153Default:  none 
     
    155155</PRE></BLOCKQUOTE> 
    156156<HR> 
    157 <A name=MyModuleId></a><!-- command name as anchor inside quotes --><PRE><B>MyModuleId <FONT color=red>mod_id</FONT>                    coaxtoring_config       Earthworm setup</B><!-- command args ... -->             
    158 </PRE> 
    159 <BLOCKQUOTE><!-- command description goes here -->Sets the module id for  
    160   labeling all outgoing heartbeat and error messages. <FONT  
    161   color=red>mod_id</FONT> is a character string (valid strings are listed in  
    162   earthworm.d) that relates (in earthworm.d) to a unique single-byte number. All  
    163   messages that coaxtoring receives from ethernet are tagged with their original  
     157<A name=MyModuleId></a><!-- command name as anchor inside quotes --><PRE><B>MyModuleId <FONT color=red>mod_id</FONT>                    coaxtoring_config       Earthworm setup</B><!-- command args ... --> 
     158</PRE> 
     159<BLOCKQUOTE><!-- command description goes here -->Sets the module id for 
     160  labeling all outgoing heartbeat and error messages. <FONT 
     161  color=red>mod_id</FONT> is a character string (valid strings are listed in 
     162  earthworm.d) that relates (in earthworm.d) to a unique single-byte number. All 
     163  messages that coaxtoring receives from ethernet are tagged with their original 
    164164  logos when they are placed into shared memory. <PRE><!-- Default and example go here   --> 
    165 Default:  none                           
     165Default:  none 
    166166Calnet:   MyModuleId MOD_COAXTORING 
    167167</PRE></BLOCKQUOTE> 
    168168<HR> 
    169 <A name=nMsgBuf></a><!-- command name as anchor inside quotes --><PRE><B>nMsgBuf <FONT color=red>nbuf</FONT>                            coaxtoring_config       msg handling</B><!-- command args ... -->                
    170 </PRE> 
    171 <BLOCKQUOTE><!-- command description goes here -->Defines the number of  
    172   working buffers <FONT color=red>nbuf</FONT> that coaxtoring should allocate.  
    173   Coaxtoring uses the buffers for rebuilding complete Earthworm messages out of  
    174   the UDP packets it receives from ethernet. There should be at least one buffer  
    175   for each different message logo that coaxtoring might see. The maximum allowed  
    176   number of buffers is controlled by MAX_BUF, currently defined to be 16 in  
     169<A name=nMsgBuf></a><!-- command name as anchor inside quotes --><PRE><B>nMsgBuf <FONT color=red>nbuf</FONT>                            coaxtoring_config       msg handling</B><!-- command args ... --> 
     170</PRE> 
     171<BLOCKQUOTE><!-- command description goes here -->Defines the number of 
     172  working buffers <FONT color=red>nbuf</FONT> that coaxtoring should allocate. 
     173  Coaxtoring uses the buffers for rebuilding complete Earthworm messages out of 
     174  the UDP packets it receives from ethernet. There should be at least one buffer 
     175  for each different message logo that coaxtoring might see. The maximum allowed 
     176  number of buffers is controlled by MAX_BUF, currently defined to be 16 in 
    177177  coaxtoring.c. The size of each buffer is set with the "MsgMaxBytes" command. <PRE><!-- Default and example go here   --> 
    178178Default:  none 
     
    180180</PRE></BLOCKQUOTE> 
    181181<HR> 
    182 <A name=PortNumber></a><!-- command name as anchor inside quotes --><PRE><B>PortNumber <FONT color=red>port</FONT>                              coaxtoring_config       network info</B><!-- command args ... -->                
    183 </PRE> 
    184 <BLOCKQUOTE><!-- command description goes here -->Defines the well-known port  
    185   number <FONT color=red>port</FONT> which coaxtoring will listen to. <FONT  
    186   color=red>port</FONT> is an integer that coaxtoring uses along with the  
    187   address from the "InAddress" command to set up a socket from which it will  
    188   receive UDP Datagram packets. <BR><FONT color=red>NOTE:</FONT> The port number  
     182<A name=PortNumber></a><!-- command name as anchor inside quotes --><PRE><B>PortNumber <FONT color=red>port</FONT>                              coaxtoring_config       network info</B><!-- command args ... --> 
     183</PRE> 
     184<BLOCKQUOTE><!-- command description goes here -->Defines the well-known port 
     185  number <FONT color=red>port</FONT> which coaxtoring will listen to. <FONT 
     186  color=red>port</FONT> is an integer that coaxtoring uses along with the 
     187  address from the "InAddress" command to set up a socket from which it will 
     188  receive UDP Datagram packets. <BR><FONT color=red>NOTE:</FONT> The port number 
    189189  must be greater than 1024. Smaller port numbers require root permission. <PRE><!-- Default and example go here   --> 
    190190Default:  none 
     
    192192</PRE></BLOCKQUOTE> 
    193193<HR> 
    194 <A name=RcvBufSize></a><!-- command name as anchor inside quotes --><PRE><B>RcvBufSize <FONT color=red>ring</FONT>                              coaxtoring_config       Earthworm setup</B><!-- command args ... -->             
    195 </PRE> 
    196 <BLOCKQUOTE><!-- command description goes here -->Tells coaxtoring the size of  
    197   the socket receive buffer, in bytes. Set RcvBufSize to a large number to avoid  
    198   dropping packets. Maximum value is system dependent, typically 260000. If no  
     194<A name=RcvBufSize></a><!-- command name as anchor inside quotes --><PRE><B>RcvBufSize <FONT color=red>ring</FONT>                              coaxtoring_config       Earthworm setup</B><!-- command args ... --> 
     195</PRE> 
     196<BLOCKQUOTE><!-- command description goes here -->Tells coaxtoring the size of 
     197  the socket receive buffer, in bytes. Set RcvBufSize to a large number to avoid 
     198  dropping packets. Maximum value is system dependent, typically 260000. If no 
    199199  buffering desired, use the system default size, typically 8192. To determine the default size, set RcvBufSize to zero.  When coaxtoring is restarted, it will log a message giving you the default buffer size. The maximum size can be found by trial and error.  If the value exceeds the maximum value, coaxtoring will log the message: "Error resetting receive buffer size" and exit. 
    200200<PRE><!-- Default and example go here   --> 
    201 Default:  none                           
     201Default:  none 
    202202Example:  RcvBufSize 260000 
    203203</PRE></BLOCKQUOTE> 
    204204<HR> 
    205 <A name=RingName></a><!-- command name as anchor inside quotes --><PRE><B>RingName <FONT color=red>ring</FONT>                          coaxtoring_config       Earthworm setup</B><!-- command args ... -->             
    206 </PRE> 
    207 <BLOCKQUOTE><!-- command description goes here -->Tells coaxtoring which  
    208   shared memory region to use for output. <FONT color=red>ring</FONT> is a  
    209   character string (valid strings are listed in earthworm.d) that relates (in  
    210   earthworm.d) to a unique number for the key to the shared memory region. All  
    211   messages that coaxtoring receives from ethernet are tagged with their original  
     205<A name=RingName></a><!-- command name as anchor inside quotes --><PRE><B>RingName <FONT color=red>ring</FONT>                          coaxtoring_config       Earthworm setup</B><!-- command args ... --> 
     206</PRE> 
     207<BLOCKQUOTE><!-- command description goes here -->Tells coaxtoring which 
     208  shared memory region to use for output. <FONT color=red>ring</FONT> is a 
     209  character string (valid strings are listed in earthworm.d) that relates (in 
     210  earthworm.d) to a unique number for the key to the shared memory region. All 
     211  messages that coaxtoring receives from ethernet are tagged with their original 
    212212  logos when they are placed into shared memory. <PRE><!-- Default and example go here   --> 
    213 Default:  none                           
     213Default:  none 
    214214Example:  RingName WAVE_RING 
    215215</PRE></BLOCKQUOTE> 
    216216<HR> 
    217 <A name=ScrnMsg></a><!-- command name as anchor inside quotes --><PRE><B>ScrnMsg <FONT color=red>switch</FONT>                          coaxtoring_config       output</B><!-- command args ... -->              
    218 </PRE> 
    219 <BLOCKQUOTE><!-- command description goes here -->Sets a switch for writing  
    220   messages to the screen. If <FONT color=red>switch</FONT> is 1, a line is  
    221   printed to the screen detailing the logo and the sequence number of each  
    222   Earthworm message received from the ethernet. If <FONT color=red>switch</FONT>  
     217<A name=ScrnMsg></a><!-- command name as anchor inside quotes --><PRE><B>ScrnMsg <FONT color=red>switch</FONT>                          coaxtoring_config       output</B><!-- command args ... --> 
     218</PRE> 
     219<BLOCKQUOTE><!-- command description goes here -->Sets a switch for writing 
     220  messages to the screen. If <FONT color=red>switch</FONT> is 1, a line is 
     221  printed to the screen detailing the logo and the sequence number of each 
     222  Earthworm message received from the ethernet. If <FONT color=red>switch</FONT> 
    223223  is 0, no messages are written to the screen. <PRE><!-- Default and example go here   --> 
    224224Default:  none 
     
    227227<HR> 
    228228 
    229 <CENTER><A href="../modules.html">Module Index</A> | <A  
    230 href="../ovr/coaxtoring_ovr.html">Coaxtoring Overview</A>  
     229<CENTER><A href="../modules.html">Module Index</A> | <A 
     230href="../ovr/coaxtoring_ovr.html">Coaxtoring Overview</A> 
    231231</CENTER><!-- USGS-required stuff at the end --> 
    232232<HR> 
    233233<address>Questions? Issues? <a 
    234  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    235  target="_blank">Subscribe to the Earthworm List (earthw). </a></address></BODY></HTML> 
     234 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     235 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></BODY></HTML> 
  • trunk/ewdoc/WEB_DOC/cmd/compress_UA_cmd.html

    r2351 r4571  
    1616OutRing             COMP_RING   # Transport ring to write output to, 
    1717HeartBeatInterval   15          # Heartbeat interval, in seconds, 
    18 LogFile             1           # 0=write log to stderr/stdout, not to disk  
     18LogFile             1           # 0=write log to stderr/stdout, not to disk 
    1919                                # 1=write a log file to disk 
    2020                                # 2=write a module log but not to stderr/stdout 
     
    2424                        #          on outgoing TYPE_TRACE_COMP_UA msg 
    2525 
    26 # instead of getting specific LOGOS, we are only interested in  
     26# instead of getting specific LOGOS, we are only interested in 
    2727# messages of TYPE_TRACEBUF, but we may want to specify messages 
    2828# with particular SCN codes of interest 
     
    3838#GetEventsFrom  HGS VHZ NC      INST_WILDCARD      MOD_WILDCARD 
    3939</pre> 
    40 <CENTER>  
    41 <A HREF="../modules.html">Module Index</A> |  
     40<CENTER> 
     41<A HREF="../modules.html">Module Index</A> | 
    4242<A HREF="../ovr/compress_UA_ovr.html">Compress/Decompress Overview</A> 
    4343</CENTER> 
     
    4747<HR> 
    4848<ADDRESS> 
    49 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     49Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    5050</ADDRESS> 
    5151</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/condenselogo_cmd.html

    r2525 r4571  
    77<CENTER> 
    88  <H1>Condenselogo Configuration File Commands</H1> 
    9   <I>(last revised 22 November 2006)</I>  
     9  <I>(last revised 22 November 2006)</I> 
    1010</CENTER> 
    1111<H2> EXAMPLE CONFIGURATION FILE</H2> 
    1212<PRE><font face="Courier New, Courier, mono"># condenselogo configuration file 
    13 #   Reads messages from a list of logos from one transport ring  
     13#   Reads messages from a list of logos from one transport ring 
    1414#   and writes them to another ring using its own installation and 
    15 #   moduleid in the logo.  Does not alter the contents of the  
     15#   moduleid in the logo.  Does not alter the contents of the 
    1616#   message in any way. 
    1717 
    1818#  Basic Earthworm setup: 
    1919# 
    20 MyModuleId    MOD_K2ALL      # module id for this instance of condenselogo  
     20MyModuleId    MOD_K2ALL      # module id for this instance of condenselogo 
    2121InRing        TRACEBUFGEN_RING        # shared memory ring for input 
    2222OutRing       TEST_RING_1      # shared memory ring for output 
    2323HeartbeatInt  30             # seconds between heartbeats 
    24 LogFile       1              # 0 log to stderr/stdout only  
     24LogFile       1              # 0 log to stderr/stdout only 
    2525                             # 1 log to stderr/stdout and to disk file 
    2626                             # 2 log to disk file only 
     
    4141                             # If non-zero, use original installation_id in 
    4242                             #   outgoing logo (replace only the module_id).</font> 
    43                               
     43 
    4444 
    4545</PRE> 
    46 <P><A name=function></a>  
     46<P><A name=function></a> 
    4747<HR> 
    4848 
    4949<CENTER> 
    50   <A href="../modules.html">Module Index</A>  
     50  <A href="../modules.html">Module Index</A> 
    5151</CENTER><!-- USGS-required stuff at the end --> 
    5252<HR> 
    5353<address>Questions? Issues? <a 
    54  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    55  target="_blank">Subscribe to the Earthworm List (earthw). </a></address></BODY></HTML> 
     54 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     55 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></BODY></HTML> 
  • trunk/ewdoc/WEB_DOC/cmd/config_ws_cmd.html

    r2273 r4571  
    2424Contact: </address> 
    2525<address> Questions? Issues? <a 
    26  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    27  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     26 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     27 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    2828</body> 
    2929</html> 
  • trunk/ewdoc/WEB_DOC/cmd/copystatus.html

    r2351 r4571  
    1010<I>(last revised 7 January 1999)</I></CENTER> 
    1111<BR> 
    12 Copystatus does not use a command file like other earthworm modules. Instead,  
     12Copystatus does not use a command file like other earthworm modules. Instead, 
    1313it takes two command-line arguments: the input and output transport rings. 
    1414Example: 
     
    1717</PRE> 
    1818<BR> 
    19 <CENTER>  
    20 <A HREF="../modules.html">Module Index</A> |  
     19<CENTER> 
     20<A HREF="../modules.html">Module Index</A> | 
    2121<A HREF="../ovr/copystatus.html">Copystatus Overview</A> 
    2222</CENTER> 
     
    2525<HR> 
    2626<ADDRESS> 
    27 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     27Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    2828</ADDRESS> 
    2929</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/debias_cmd.html

    r3805 r4571  
    2828                              # When exceeded, channel is restarted. 
    2929 
    30 # TestMode                     # If you want Debias to compute and log  
     30# TestMode                     # If you want Debias to compute and log 
    3131                              # its filter coefficients and then 
    3232                              # exit, specify "TestMode". 
     
    4040# Installation and module may be wildcarded. 
    4141# The only valid messages types are TYPE_TRACEBUF and TYPE_TRACEBUF2 
    42 # Output message type will be the same as the input message type.  
     42# Output message type will be the same as the input message type. 
    4343#-------------------------------------------------------------------------- 
    44  GetWavesFrom    INST_WILDCARD MOD_WILDCARD TYPE_TRACEBUF2  
     44 GetWavesFrom    INST_WILDCARD MOD_WILDCARD TYPE_TRACEBUF2 
    4545 
    4646# List SCNL codes of trace messages to decimate and their output SCNL codes. 
     
    5151 GetSCNL  NP2 BHE ZZ --   DEBI HHE NP BS 
    5252</pre> 
    53 <CENTER>  
    54 <A HREF="../modules.html">Module Index</A> |  
     53<CENTER> 
     54<A HREF="../modules.html">Module Index</A> | 
    5555<A HREF="../ovr/debias_ovr.html">Debias Overview</A> 
    5656</CENTER> 
     
    6060<HR> 
    6161<ADDRESS> 
    62 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     62Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    6363</ADDRESS> 
    6464</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/decimate_cmd.html

    r3499 r4571  
    2121#Debug                           # Write out debug messages (optional) 
    2222 
    23 # Specify the decimation rates as one or more integer values greater than 1,  
     23# Specify the decimation rates as one or more integer values greater than 1, 
    2424# all on one "DecimationRates" line, enclosed in quotes. 
    2525# These will be used in successive stages of decimation. The overall 
     
    4141# 
    4242# Specify logo of the messages to grab from the InRing. 
    43 # TYPE_TRACEBUF2 is assumed, therefore only module ID and  
     43# TYPE_TRACEBUF2 is assumed, therefore only module ID and 
    4444# installation ID need to be specified 
    4545# 
     
    5454 
    5555</pre> 
    56 <CENTER>  
    57 <A HREF="../modules.html">Module Index</A> |  
     56<CENTER> 
     57<A HREF="../modules.html">Module Index</A> | 
    5858<A HREF="../ovr/decimate_ovr.html">Decimate Overview</A> 
    5959</CENTER> 
     
    6363<HR> 
    6464<ADDRESS> 
    65 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     65Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    6666</ADDRESS> 
    6767</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/decompress_UA_cmd.html

    r2351 r4571  
    2727                                #          on outgoing TYPE_TRACEBUF msg 
    2828</pre> 
    29 <CENTER>  
    30 <A HREF="../modules.html">Module Index</A> |  
     29<CENTER> 
     30<A HREF="../modules.html">Module Index</A> | 
    3131<A HREF="../ovr/compress_UA_ovr.html">Compress/decompress Overview</A> 
    3232</CENTER> 
     
    3434<HR> 
    3535<ADDRESS> 
    36 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     36Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    3737</ADDRESS> 
    3838</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/diskmgr_cmd.html

    r2888 r4571  
    1818<address>Contact: <b> 
    1919<address> Questions? Issues? <a 
    20  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    21  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     20 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     21 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
    2222</b><br> 
    2323</address> 
  • trunk/ewdoc/WEB_DOC/cmd/earth2sac.html

    r2351 r4571  
    2222earth2sac 
    2323</B> 
    24 [  
     24[ 
    2525<!--. BI \-d " directory"--> 
    2626<B> 
     
    116116needs 
    117117a start-time and duration for trace data. It will get these two from one of 
    118 several sources:  
     118several sources: 
    119119<!--. I start-time--> 
    120120<I> 
    121121start-time 
    122122</I> 
    123 and  
     123and 
    124124<!--. I duration --> 
    125125<I> 
     
    135135</I> 
    136136or read from standard input. Additional 
    137 information can be given to  
     137information can be given to 
    138138<!--. B earth2sac --> 
    139139<B> 
     
    141141</B> 
    142142through the command options, but default 
    143 values are built in.  
     143values are built in. 
    144144<!--. LP --> 
    145145<P> 
    146 A single seismic trace is identified by its  
     146A single seismic trace is identified by its 
    147147<!--. I station --> 
    148148<I> 
     
    150150</I> 
    151151name (geographical 
    152 location within a network),  
     152location within a network), 
    153153<!--. IR component , --> 
    154154<I> 
     
    157157, 
    158158 
    159 and  
     159and 
    160160<!--. I network--> 
    161161<I> 
     
    164164name (e.g., UW for 
    165165University of Washington.) This three-part identification is sometimes known 
    166 as the  
     166as the 
    167167<!--. IR SCN . --> 
    168168<I> 
     
    192192Set the directory in which the SAC directory will be created. If this 
    193193option is not given, then the SAC directory will be created in the current 
    194 directory.  
     194directory. 
    195195<!--. TP --> 
    196196</P> 
     
    203203</I> 
    204204Specify an event file from which to get start-time and duration for saving 
    205 data. See  
     205data. See 
    206206<!--. I "Event Files"--> 
    207207<I> 
     
    227227Set the gap threshold in number of sample periods. If there is a gap of more 
    228228than this periodd of time in the trace data, then it will be filled with 
    229 zero's.  
     229zero's. 
    230230<!--. I Tracesave--> 
    231231<I> 
     
    255255</I> 
    256256option if it is given. Otherwise the SAC directory will be created in the 
    257 current directory.  
    258 <!--. B earth2sac--> 
    259 <B> 
    260 earth2sac 
    261 </B> 
    262 appends the station, component and network names to the  
     257current directory. 
     258<!--. B earth2sac--> 
     259<B> 
     260earth2sac 
     261</B> 
     262appends the station, component and network names to the 
    263263<!--. I basename--> 
    264264<I> 
     
    278278colon: e.g., -s verme:16022  This flag and option may be specified more 
    279279than once to use more than one wave server. It may be used in conjunction with 
    280 the  
     280the 
    281281<!--. BI \-S " server-file"--> 
    282282<B> 
     
    285285 server-file 
    286286</I> 
    287 option as well. If neither the  
     287option as well. If neither the 
    288288<!--. I \-s --> 
    289289<I> 
    290290-s 
    291291</I> 
    292 or  
     292or 
    293293<!--. I \-S --> 
    294294<I> 
     
    296296</I> 
    297297options are used, 
    298 then  
     298then 
    299299<!--. B earth2sac--> 
    300300<B> 
     
    304304/wormdata/run/params/servers. The order of servers is significant in that a 
    305305given SCN will be retrieved from the first wave server that has it in its 
    306 menu.  
     306menu. 
    307307<!--. TP --> 
    308308</P> 
     
    315315</I> 
    316316adds the servers listed in the file to the list from which to get wave 
    317 traces. This option may be used in conjunction with the  
     317traces. This option may be used in conjunction with the 
    318318<!--. BI \-s " server:port"--> 
    319319<B> 
     
    325325above, which see. The server file is a simple ASCII list of server names or IP address 
    326326and port number separated by whitespace, one pair to a line. Comment lines 
    327 have a  
     327have a 
    328328<!--. B # --> 
    329329<B> 
     
    356356time interval requested is not yet held by the server at the first request, 
    357357the server will report a wait-time after which it expects the waves to have 
    358 arrived. After the lesser of  
     358arrived. After the lesser of 
    359359<!--. I delaytime--> 
    360360<I> 
    361361delaytime 
    362362</I> 
    363 or wait-time,  
     363or wait-time, 
    364364<!--. B earth2sac--> 
    365365<B> 
     
    376376</B> 
    377377Urgent mode; don't retry connections to servers; don't wait for waves to get 
    378 to server. Normally, if the connection to a server fails,  
    379 <!--. B earth2sac--> 
    380 <B> 
    381 earth2sac 
    382 </B> 
    383 will try once to re-establish that connection.  
     378to server. Normally, if the connection to a server fails, 
     379<!--. B earth2sac--> 
     380<B> 
     381earth2sac 
     382</B> 
     383will try once to re-establish that connection. 
    384384<!--. TP --> 
    385385</P> 
     
    398398-h 
    399399</B> 
    400 Give the usage for  
     400Give the usage for 
    401401<!--. B earth2sac--> 
    402402<B> 
     
    407407</P> 
    408408<P> 
    409 Trace start-time and duration may be given as arguments to  
     409Trace start-time and duration may be given as arguments to 
    410410<!--. BR earth2sac .--> 
    411411<B> 
     
    414414. 
    415415 
    416 The start-time is up to 14 digits in the format  
     416The start-time is up to 14 digits in the format 
    417417<!--. IR "YYMMDDHHMMSS.SS" , --> 
    418418<I> 
     
    427427integer. The duration must be given if the start-time is specified. If neither 
    428428start-time and duration, nor event file are specified on the command line, 
    429 then  
     429then 
    430430<!--. B earth2sac--> 
    431431<B> 
     
    438438Event Files 
    439439</H2> 
    440 Event files for  
     440Event files for 
    441441<!--. B earth2sac--> 
    442442<B> 
     
    445445may be in one of two formats. One format is the 
    446446UW2-format pickfile, identified by the presence of the `A' card at the start 
    447 of the file.  
     447of the file. 
    448448<!--. B earth2sac--> 
    449449<B> 
     
    463463with one or more lines of station, channel, network, start-time and duration, 
    464464all separated by white space. Any of station, channel or network may be the 
    465 wildcard character  
     465wildcard character 
    466466<!--. IR * , --> 
    467467<I> 
     
    472472which will match any SCNs which also match the 
    473473non-wildcarded components. The start-time in the trigger file is up to 14 
    474 digits in the format  
     474digits in the format 
    475475<!--. IR "YYMMDDHHMMSS.SS" .--> 
    476476<I> 
     
    480480 
    481481Missing digits on the right will be 
    482 treated as zero's. The  
     482treated as zero's. The 
    483483<!--. I duration--> 
    484484<I> 
     
    489489</P> 
    490490<P> 
    491 When the data file name is not specified on the command line (with  
     491When the data file name is not specified on the command line (with 
    492492<!--. I \-o--> 
    493493<I> 
     
    501501 
    502502then the data file name is obtained as follows.  If the pickfile 
    503 name is known (because it was specified on the command line with the  
     503name is known (because it was specified on the command line with the 
    504504<!--. BI \-e " eventfile"--> 
    505505<B> 
     
    509509</I> 
    510510option, then the data file name will be obtained by replacing the final letter 
    511 in the pickfile name with  
     511in the pickfile name with 
    512512<!--. IR W . --> 
    513513<I> 
     
    522522YYMMDDHHMMS 
    523523</I> 
    524 concatenated with the letter  
     524concatenated with the letter 
    525525<!--. IR W .--> 
    526526<I> 
     
    548548part of the requested trace data is available, the server will send back all 
    549549that it can. If there is a gap in the trace data within the requested 
    550 interval, it may be filled with zero's by  
     550interval, it may be filled with zero's by 
    551551<!--. B earth2sac--> 
    552552<B> 
     
    600600component 
    601601</I> 
    602 for the  
     602for the 
    603603<!--. B UW--> 
    604604<B> 
     
    627627channel header bias field. If a gap happens to occur within the first 1000 
    628628samples, the mean value will include only those samples before the gap. Gaps 
    629 in data are filled with zeros  
     629in data are filled with zeros 
    630630<!--. I after--> 
    631631<I> 
     
    647647the assigned packet times, not in the sample period. Thus, these apparent gaps 
    648648in sample data should NOT be filled with zero's, since they are artifacts of 
    649 the system and not real gaps. If  
     649the system and not real gaps. If 
    650650<!--. B earth2sac--> 
    651651<B> 
     
    660660) 
    661661 
    662 few have been filled, these gaps should be eliminated be repeating the  
    663 <!--. B earth2sac--> 
    664 <B> 
    665 earth2sac 
    666 </B> 
    667 command with the  
     662few have been filled, these gaps should be eliminated be repeating the 
     663<!--. B earth2sac--> 
     664<B> 
     665earth2sac 
     666</B> 
     667command with the 
    668668<!--. I "gap threshold"--> 
    669669<I> 
     
    689689<HR> 
    690690<ADDRESS> 
    691 Contact: <B>Pete Lombard, <A HREF="mailto:<address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address>"> 
    692 <address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></A></B><BR> 
     691Contact: <B>Pete Lombard, <A HREF="mailto:<address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address>"> 
     692<address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></A></B><BR> 
    693693</ADDRESS> 
    694694 
  • trunk/ewdoc/WEB_DOC/cmd/earth2uw.html

    r2351 r4571  
    2323earth2uw 
    2424</B> 
    25 [  
     25[ 
    2626<!--. BI \-d " directory"--> 
    2727<B> 
     
    112112needs 
    113113a start-time and duration for trace data. It will get these two from one of 
    114 several sources:  
     114several sources: 
    115115<!--. I start-time--> 
    116116<I> 
    117117start-time 
    118118</I> 
    119 and  
     119and 
    120120<!--. I duration --> 
    121121<I> 
     
    131131</I> 
    132132or read from standard input. Additional 
    133 information can be given to  
     133information can be given to 
    134134<!--. B earth2uw --> 
    135135<B> 
     
    137137</B> 
    138138through the command options, but default 
    139 values are built in.  
     139values are built in. 
    140140<!--. LP --> 
    141141<P> 
    142 A single seismic trace is identified by its  
     142A single seismic trace is identified by its 
    143143<!--. I station --> 
    144144<I> 
     
    146146</I> 
    147147name (geographical 
    148 location within a network),  
     148location within a network), 
    149149<!--. IR component , --> 
    150150<I> 
     
    153153, 
    154154 
    155 and  
     155and 
    156156<!--. I network--> 
    157157<I> 
     
    160160name (e.g., UW for 
    161161University of Washington.) This three-part identification is sometimes known 
    162 as the  
     162as the 
    163163<!--. IR SCN . --> 
    164164<I> 
     
    188188Set the directory in which the output data file will be created. If this 
    189189option is not given, then the data file will be created in the current 
    190 directory.  
     190directory. 
    191191<!--. TP --> 
    192192</P> 
     
    199199</I> 
    200200Specify an event file from which to get start-time and duration for saving 
    201 data. See  
     201data. See 
    202202<!--. I "Event Files"--> 
    203203<I> 
     
    223223Set the gap threshold in number of sample periods. If there is a gap of more 
    224224than this periodd of time in the trace data, then it will be filled with 
    225 zero's.  
     225zero's. 
    226226<!--. I Tracesave--> 
    227227<I> 
     
    263263colon: e.g., -s verme:16022  This flag and option may be specified more 
    264264than once to use more than one wave server. It may be used in conjunction with 
    265 the  
     265the 
    266266<!--. BI \-S " server-file"--> 
    267267<B> 
     
    270270 server-file 
    271271</I> 
    272 option as well. If neither the  
     272option as well. If neither the 
    273273<!--. I \-s --> 
    274274<I> 
    275275-s 
    276276</I> 
    277 or  
     277or 
    278278<!--. I \-S --> 
    279279<I> 
     
    281281</I> 
    282282options are used, 
    283 then  
     283then 
    284284<!--. B earth2uw--> 
    285285<B> 
     
    289289/wormdata/run/params/servers. The order of servers is significant in that a 
    290290given SCN will be retrieved from the first wave server that has it in its 
    291 menu.  
     291menu. 
    292292<!--. TP --> 
    293293</P> 
     
    300300</I> 
    301301adds the servers listed in the file to the list from which to get wave 
    302 traces. This option may be used in conjunction with the  
     302traces. This option may be used in conjunction with the 
    303303<!--. BI \-s " server:port"--> 
    304304<B> 
     
    310310above, which see. The server file is a simple ASCII list of server names or IP address 
    311311and port number separated by whitespace, one pair to a line. Comment lines 
    312 have a  
     312have a 
    313313<!--. B # --> 
    314314<B> 
     
    323323-n 
    324324</B> 
    325 Put the network code in the  
     325Put the network code in the 
    326326<!--. I chid--> 
    327327<I> 
     
    333333earth2uw 
    334334</B> 
    335 puts &quot;0&quot; in the  
     335puts &quot;0&quot; in the 
    336336<!--. I chid --> 
    337337<I> 
     
    369369time interval requested is not yet held by the server at the first request, 
    370370the server will report a wait-time after which it expects the waves to have 
    371 arrived. After the lesser of  
     371arrived. After the lesser of 
    372372<!--. I delaytime--> 
    373373<I> 
    374374delaytime 
    375375</I> 
    376 or wait-time,  
     376or wait-time, 
    377377<!--. B earth2uw--> 
    378378<B> 
     
    397397-h 
    398398</B> 
    399 Give the usage for  
     399Give the usage for 
    400400<!--. B earth2uw--> 
    401401<B> 
     
    406406</P> 
    407407<P> 
    408 Trace start-time and duration may be given as arguments to  
     408Trace start-time and duration may be given as arguments to 
    409409<!--. BR earth2uw .--> 
    410410<B> 
     
    413413. 
    414414 
    415 The start-time is up to 14 digits in the format  
     415The start-time is up to 14 digits in the format 
    416416<!--. IR "YYMMDDHHMMSS.SS" , --> 
    417417<I> 
     
    426426integer. The duration must be given if the start-time is specified. If neither 
    427427start-time and duration, nor event file are specified on the command line, 
    428 then  
     428then 
    429429<!--. B earth2uw--> 
    430430<B> 
     
    437437Event Files 
    438438</H2> 
    439 Event files for  
     439Event files for 
    440440<!--. B earth2uw--> 
    441441<B> 
     
    444444may be in one of two formats. One format is the 
    445445UW2-format pickfile, identified by the presence of the `A' card at the start 
    446 of the file.  
     446of the file. 
    447447<!--. B earth2uw--> 
    448448<B> 
     
    462462with one or more lines of station, channel, network, start-time and duration, 
    463463all separated by white space. Any of station, channel or network may be the 
    464 wildcard character  
     464wildcard character 
    465465<!--. IR * , --> 
    466466<I> 
     
    471471which will match any SCNs which also match the 
    472472non-wildcarded components. The start-time in the trigger file is up to 14 
    473 digits in the format  
     473digits in the format 
    474474<!--. IR "YYMMDDHHMMSS.SS" .--> 
    475475<I> 
     
    479479 
    480480Missing digits on the right will be 
    481 treated as zero's. The  
     481treated as zero's. The 
    482482<!--. I duration--> 
    483483<I> 
     
    488488</P> 
    489489<P> 
    490 When the data file name is not specified on the command line (with  
     490When the data file name is not specified on the command line (with 
    491491<!--. I \-o--> 
    492492<I> 
     
    500500 
    501501then the data file name is obtained as follows.  If the pickfile 
    502 name is known (because it was specified on the command line with the  
     502name is known (because it was specified on the command line with the 
    503503<!--. BI \-e " eventfile"--> 
    504504<B> 
     
    508508</I> 
    509509option, then the data file name will be obtained by replacing the final letter 
    510 in the pickfile name with  
     510in the pickfile name with 
    511511<!--. IR W . --> 
    512512<I> 
     
    521521YYMMDDHHMMS 
    522522</I> 
    523 concatenated with the letter  
     523concatenated with the letter 
    524524<!--. IR W .--> 
    525525<I> 
     
    547547part of the requested trace data is available, the server will send back all 
    548548that it can. If there is a gap in the trace data within the requested 
    549 interval, it may be filled with zero's by  
     549interval, it may be filled with zero's by 
    550550<!--. B earth2uw--> 
    551551<B> 
     
    599599component 
    600600</I> 
    601 for the  
     601for the 
    602602<!--. B UW--> 
    603603<B> 
     
    626626channel header bias field. If a gap happens to occur within the first 1000 
    627627samples, the mean value will include only those samples before the gap. Gaps 
    628 in data are filled with zeros  
     628in data are filled with zeros 
    629629<!--. I after--> 
    630630<I> 
     
    646646the assigned packet times, not in the sample period. Thus, these apparent gaps 
    647647in sample data should NOT be filled with zero's, since they are artifacts of 
    648 the system and not real gaps. If  
     648the system and not real gaps. If 
    649649<!--. B earth2uw--> 
    650650<B> 
     
    659659) 
    660660 
    661 few have been filled, these gaps should be eliminated be repeating the  
    662 <!--. B earth2uw--> 
    663 <B> 
    664 earth2uw 
    665 </B> 
    666 command with the  
     661few have been filled, these gaps should be eliminated be repeating the 
     662<!--. B earth2uw--> 
     663<B> 
     664earth2uw 
     665</B> 
     666command with the 
    667667<!--. I "gap threshold"--> 
    668668<I> 
     
    698698<HR> 
    699699<ADDRESS> 
    700 Contact: <B>Pete Lombard, <A HREF="mailto:<address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address>"> 
    701 <address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></A></B><BR> 
     700Contact: <B>Pete Lombard, <A HREF="mailto:<address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address>"> 
     701<address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></A></B><BR> 
    702702</ADDRESS> 
    703703 
  • trunk/ewdoc/WEB_DOC/cmd/ellipse2arc_cmd.html

    r2369 r4571  
    3030#  Basic Earthworm setup: 
    3131# 
    32 MyModuleId      MOD_ELLIPSE2ARC    # module id for this instance of template  
     32MyModuleId      MOD_ELLIPSE2ARC    # module id for this instance of template 
    3333InRing      SOLN_RING          # shared memory ring for input 
    3434OutRing         HYPO_RING          # shared memory ring for output 
     
    4646</PRE> 
    4747<hr><address>Questions? Issues? <a 
    48  href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
    49  target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     48 href="http://groups.google.com/group/earthworm_forum?hl=en" 
     49 target="_blank">Subscribe to the Earthworm Google Groups List. </a></address> 
  • trunk/ewdoc/WEB_DOC/cmd/eqalarm_ew.html

    r2351 r4571  
    99<CENTER><H1>Eqalarm_ew Configuration File Commands</H1> 
    1010<I>(last revised 5 December 1996)</I></CENTER> 
    11                                                           
     11 
    1212Page Index:<BR> 
    13131.  <A HREF=#example>Example configuration file</A><BR> 
     
    1717<!-- ADD HERE: Paragraph "On startup, xxxx reads the..." --> 
    1818On startup, eqalarm_ew reads the configuration file named on the command 
    19 line.  Commands in this file set up all parameters used in issuing  
    20 earthquake notifications.  In the control file, lines may begin with a  
     19line.  Commands in this file set up all parameters used in issuing 
     20earthquake notifications.  In the control file, lines may begin with a 
    2121valid eqalarm_ew command (listed below) or with one of 2 special characters: 
    2222 
    2323<BLOCKQUOTE><PRE> 
    24 #  marks the line as a comment (example: # This is a comment).<BR>    
    25 @  allows control files to be nested; one control file can be  
    26    accessed from another with the command "@" followed by  
    27    a string representing the path name of the next control file  
     24#  marks the line as a comment (example: # This is a comment).<BR> 
     25@  allows control files to be nested; one control file can be 
     26   accessed from another with the command "@" followed by 
     27   a string representing the path name of the next control file 
    2828   (example: @model.d). 
    2929</BLOCKQUOTE></PRE> 
     
    5656<A NAME="function"> 
    5757<H2>2.  FUNCTIONAL COMMAND LISTING</H2> 
    58 <P>   
     58<P> 
    5959<!-- ADD HERE: Paragraph "Below are the commands recognized..." --> 
    60 Below are the commands recognized by eqalarm_ew, grouped by the function  
    61 they influence.  All of the commands are required; they must be specified  
     60Below are the commands recognized by eqalarm_ew, grouped by the function 
     61they influence.  All of the commands are required; they must be specified 
    6262in the control file in order for eqalarm_ew to operate. 
    6363 
     
    8181<H2>3.  ALPHABETIC COMMAND LISTING & DESCRIPTION</H2> 
    8282<P> 
    83 In the following section, all configuration file commands are listed  
    84 in alphabetical order.  Listed along with the command (bold-type) are  
    85 its arguments (in red), the name of the subroutine that processes the  
    86 command, and the function within the module that the command influences.  
    87 A detailed description of the command and is also given.  Default values  
     83In the following section, all configuration file commands are listed 
     84in alphabetical order.  Listed along with the command (bold-type) are 
     85its arguments (in red), the name of the subroutine that processes the 
     86command, and the function within the module that the command influences. 
     87A detailed description of the command and is also given.  Default values 
    8888and example commands are listed after each command description. 
    8989<PRE><B> 
     
    9494<!-- ADD HERE: all commands; below is a sample command blank: --> 
    9595 
    96 <A NAME="GetSumFrom">  <!-- command name as anchor inside quotes -->     
    97 <PRE><B>GetSumFrom <font color=red>inst</font> <font color=red>mod_id</font>                    eqalarm_config          Earthworm setup</B><!-- command args ... -->             
    98 </PRE> 
    99 <BLOCKQUOTE> <!-- command description goes here --> 
    100 Controls the hypocenter messages input to eqalarm_ew.  eqalarm_ew will  
    101 only process TYPE_H71SUM messages that come from module <font color=red>mod_id</font> at  
    102 installation <font color=red>inst</font>.  <font color=red>inst</font> and <font color=red>mod_id</font> are character strings (valid  
    103 strings are listed in earthworm.h/earthworm.d) which are related to  
    104 single-byte numbers that uniquely identify each installation and  
    105 module.  Only one "GetSumFrom" command may be issued; wildcards  
    106 (INST_WILDCARD and MOD_WILDCARD) will force eqalarm_ew to process  
    107 all hypocenter messages, regardless of their place of origin.   
    108 <PRE><!-- Default and example go here   --> 
    109 Default:  none                           
     96<A NAME="GetSumFrom">  <!-- command name as anchor inside quotes --> 
     97<PRE><B>GetSumFrom <font color=red>inst</font> <font color=red>mod_id</font>                    eqalarm_config          Earthworm setup</B><!-- command args ... --> 
     98</PRE> 
     99<BLOCKQUOTE> <!-- command description goes here --> 
     100Controls the hypocenter messages input to eqalarm_ew.  eqalarm_ew will 
     101only process TYPE_H71SUM messages that come from module <font color=red>mod_id</font> at 
     102installation <font color=red>inst</font>.  <font color=red>inst</font> and <font color=red>mod_id</font> are character strings (valid 
     103strings are listed in earthworm.h/earthworm.d) which are related to 
     104single-byte numbers that uniquely identify each installation and 
     105module.  Only one "GetSumFrom" command may be issued; wildcards 
     106(INST_WILDCARD and MOD_WILDCARD) will force eqalarm_ew to process 
     107all hypocenter messages, regardless of their place of origin. 
     108<PRE><!-- Default and example go here   --> 
     109Default:  none 
    110110Example:  GetSumFrom  INST_WILDCARD  MOD_WILDCARD 
    111111</PRE> 
     
    113113<HR> 
    114114 
    115 <A NAME="LogSwitch">  <!-- command name as anchor inside quotes -->      
    116 <PRE><B>LogSwitch <font color=red>switch</font>                 eqalarm_config          output</B><!-- command args ... -->              
     115<A NAME="LogSwitch">  <!-- command name as anchor inside quotes --> 
     116<PRE><B>LogSwitch <font color=red>switch</font>                 eqalarm_config          output</B><!-- command args ... --> 
    117117</PRE> 
    118118<BLOCKQUOTE> <!-- command description goes here --> 
    119119Sets the on-off switch for writing a log file to disk.  If <font color=red>switch</font> 
    120 is 0, no log file will be written.  If <font color=red>switch</font> is 1, eqalarm_ew  
    121 will write a daily log file(s) called eqalarm_ewxx.log_yymmdd  
    122 where xx is eqalarm_ew's module id (set with "MyModuleId" command)  
    123 and yymmdd is the current UTC date (ex: 960123) on the system clock.   
    124 The file(s) will be written in the EW_LOG directory (environment  
    125 variable).   
    126 <PRE><!-- Default and example go here   --> 
    127 Default:  none 
    128 </PRE> 
    129 </BLOCKQUOTE> 
    130 <HR> 
    131  
    132 <A NAME="MagThreshold">  <!-- command name as anchor inside quotes -->   
    133 <PRE><B>MagThreshold <font color=red>mag</font>                 eqalarm_config          EQ notification</B><!-- command args ... -->             
     120is 0, no log file will be written.  If <font color=red>switch</font> is 1, eqalarm_ew 
     121will write a daily log file(s) called eqalarm_ewxx.log_yymmdd 
     122where xx is eqalarm_ew's module id (set with "MyModuleId" command) 
     123and yymmdd is the current UTC date (ex: 960123) on the system clock. 
     124The file(s) will be written in the EW_LOG directory (environment 
     125variable). 
     126<PRE><!-- Default and example go here   --> 
     127Default:  none 
     128</PRE> 
     129</BLOCKQUOTE> 
     130<HR> 
     131 
     132<A NAME="MagThreshold">  <!-- command name as anchor inside quotes --> 
     133<PRE><B>MagThreshold <font color=red>mag</font>                 eqalarm_config          EQ notification</B><!-- command args ... --> 
    134134</PRE> 
    135135<BLOCKQUOTE> <!-- command description goes here --> 
     
    144144<HR> 
    145145 
    146 <A NAME="MyModuleId">  <!-- command name as anchor inside quotes -->     
    147 <PRE><B>MyModuleId <font color=red>mod_id</font>                        eqalarm_config          Earthworm setup</B><!-- command args ... -->             
     146<A NAME="MyModuleId">  <!-- command name as anchor inside quotes --> 
     147<PRE><B>MyModuleId <font color=red>mod_id</font>                        eqalarm_config          Earthworm setup</B><!-- command args ... --> 
    148148</PRE> 
    149149<BLOCKQUOTE> <!-- command description goes here --> 
     
    152152relates (in earthworm.d) to a unique single-byte number. 
    153153<PRE><!-- Default and example go here   --> 
    154 Default:  none                           
     154Default:  none 
    155155Example:  MyModuleId MOD_EQALARM_EW 
    156156</PRE> 
     
    158158<HR> 
    159159 
    160 <A NAME="PagerGroup">  <!-- command name as anchor inside quotes -->     
    161 <PRE><B>PagerGroup <font color=red>group</font>                 eqalarm_config          EQ notification</B><!-- command args ... -->             
     160<A NAME="PagerGroup">  <!-- command name as anchor inside quotes --> 
     161<PRE><B>PagerGroup <font color=red>group</font>                 eqalarm_config          EQ notification</B><!-- command args ... --> 
    162162</PRE> 
    163163<BLOCKQUOTE> <!-- command description goes here --> 
    164164Controls which pagers will receive event notifications.  <font color=red>group</font> is 
    165165a character string (which may or may not be enclosed in double-quotes) 
    166 which is registered as a "pager group" with a Pageit computer.   
     166which is registered as a "pager group" with a Pageit computer. 
    167167<font color=red>group</font> is written to the beginning of each pager message issued. 
    168 eqalarm_ew places the pager message into shared memory where it can be  
    169 found by the pagerfeeder module who then sends it to a Pageit computer  
     168eqalarm_ew places the pager message into shared memory where it can be 
     169found by the pagerfeeder module who then sends it to a Pageit computer 
    170170via the serial port. 
    171171<PRE><!-- Default and example go here   --> 
     
    176176<HR> 
    177177 
    178 <A NAME="RingName">  <!-- command name as anchor inside quotes -->       
    179 <PRE><B>RingName <font color=red>ring</font>                            eqalarm_config          Earthworm setup</B><!-- command args ... -->             
     178<A NAME="RingName">  <!-- command name as anchor inside quotes --> 
     179<PRE><B>RingName <font color=red>ring</font>                            eqalarm_config          Earthworm setup</B><!-- command args ... --> 
    180180</PRE> 
    181181<BLOCKQUOTE> <!-- command description goes here --> 
    182182Tells eqalarm_ew which shared memory region to use for input/output. 
    183 <font color=red>ring</font> is a character string (valid strings are listed in earthworm.d)  
     183<font color=red>ring</font> is a character string (valid strings are listed in earthworm.d) 
    184184that relates (in earthworm.d) to a unique number for the key to the 
    185185shared memory region. 
    186186<PRE><!-- Default and example go here   --> 
    187 Default:  none                           
     187Default:  none 
    188188Example:  RingName HYPO_RING 
    189189</PRE> 
     
    191191<HR> 
    192192 
    193 <CENTER>  
    194 <A HREF="../modules.html">Module Index</A> |  
     193<CENTER> 
     194<A HREF="../modules.html">Module Index</A> | 
    195195<A HREF="../ovr/eqalarm_ew.html">Eqalarm_ew Overview</A> 
    196196</CENTER> 
     
    199199<HR> 
    200200<ADDRESS> 
    201 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
     201Contact: <B><address> Questions? Issues? <a href="http://groups.google.com/group/earthworm_forum?hl=en" target="_blank">Subscribe to the Earthworm Google Groups List. </a></address></B><BR> 
    202202</ADDRESS> 
    203203</BODY> 
  • trunk/ewdoc/WEB_DOC/cmd/eqassemble_cmd.html

    r3129 r4571  
    99<CENTER><H1>Eqassemble Configuration File Commands</H1> 
    1010<I>(last revised February 13, 2007)</I></CENTER> 
    11                                                           
     11 
    1212Page Index:<BR> 
    13131.  <A HREF="#example">Example configuration file</A><BR> 
     
    2626 
    2727    #  marks the line as a comment (example: # This is a comment). 
    28         
    29     @  allows control files to be nested; one control file can be  
    30        accessed from another with the command "@" followed by  
    31        a string representing the path name of the next control file  
     28 
     29    @  allows control files to be nested; one control file can be 
     30       accessed from another with the command "@" followed by 
     31       a string representing the path name of the next control file 
    3232       (example: @model.d). 
    3333 
     
    4646 RingName     PICK_RING     # Ring to get input from 
    4747 HeartbeatInt 30            # seconds between heartbeats to statmgr 
    48  LogFile      1             # 0 = turn off disk log file;  
     48 LogFile      1             # 0 = turn off disk log file; 
    4949                            # 1 = turn on disk log 
    5050                            # 2 = write disk log but not to stderr/stdout 
     
    5555 GetPicksFrom   INST_WILDCARD    MOD_WILDCARD    # pick2k & coda2k 
    5656 GetAssocFrom   INST_MENLO       MOD_BINDER      # quake2k & link2k 
    57    
     57 
    5858# Send output to the following command (uncomment one): 
    5959#------------------------------------------------------ 
     
    8383 ReportS      0     # 0 = do not send S-phases to next process 
    8484                    # non-zero = do send S-phases to next process 
    85  HypCheckInterval  5.0  # interval (sec) at which to check all hypocenters    
     85 HypCheckInterval  5.0  # interval (sec) at which to check all hypocenters 
    8686                    #   to see if it's time to report an event 
    8787 
     
    9898#       RapidRule numPhases seconds SinceDetection 
    9999#               Event2K message released with version 1 <seconds> since 
    100 #               origin or detection time provided <numPhases> P phases  
     100#               origin or detection time provided <numPhases> P phases 
    101101#               associated. 
    102102#       FinalRule numPhases seconds [WaitForCodas] 
    103103#               Event2K message released with version 2 when solution has 
    104104#               been stable for <seconds>, has <numPhases> P phases associated, 
    105 #               and optionally after codas have arrived.  
     105#               and optionally after codas have arrived. 
    106106# Codas are reported only with the FinalRule and only if the 
    107107# WaitForCodas flag is included in the FinalRule command 
     
    137137<A NAME="function"> 
    138138<H2>2.  FUNCTIONAL COMMAND LISTING</H2> 
    139 <P>   
     139<P> 
    140140<!-- Paragraph "Below are the commands recognized..." --> 
    141 Below are the commands recognized by eqassemble, grouped by the function they  
     141Below are the commands recognized by eqassemble, grouped by the function they 
    142142influence.  Some of the commands are marked "required"; they describe the 
    143 Earthworm system setup and the network model.  These commands must be  
     143Earthworm system setup and the network model.  These commands must be 
    144144specified in the control file in order for eqassemble to operate. 
    145145 
     
    153153                <A HREF="#PickFifo">pick_fifo_length</A> 
    154154                <A HREF="#QuakeFifo">quake_fifo_length</A> 
    155                  
     155 
    156156        Seismic network/model definition: 
    157157                <A HREF="#lay">lay</A>             required 
     
    180180<H2>3.  ALPHABETIC COMMAND LISTING & DESCRIPTION</H2> 
    181181<P> 
    182 In the following section, all configuration file commands are listed  
    183 in alphabetical order.  Listed along with the command (bold-type) are  
    184 its arguments (in red), the name of the subroutine that processes the  
    185 command, and the function within the module that the command influences.  
    186 A detailed description of the command and is also given.  Default values  
     182In the following section, all configuration file commands are listed 
     183in alphabetical order.  Listed along with the command (bold-type) are 
     184its arguments (in red), the name of the subroutine that processes the 
     185command, and the function within the module that the command influences. 
     186A detailed description of the command and is also given.  Default values 
    187187and the values used by Calnet are listed after each command description. 
    188188<PRE><B> 
     
    191191<HR> 
    192192 
    193 <A NAME="CodaFromInst">  <!-- command name as anchor inside quotes -->   
    194  
    195 <PRE><B>CodaFromInst <font color=red>inst_id</font>             eqas_config             Event Notification</B>   <!-- command args ... -->               
    196 </PRE> 
    197 <BLOCKQUOTE> <!-- command description goes here --> 
    198 Identify from which installations (by <font color=red>inst_id</font>)  
     193<A NAME="CodaFromInst">  <!-- command name as anchor inside quotes --> 
     194 
     195<PRE><B>CodaFromInst <font color=red>inst_id</font>             eqas_config             Event Notification</B>   <!-- command args ... --> 
     196</PRE> 
     197<BLOCKQUOTE> <!-- command description goes here --> 
     198Identify from which installations (by <font color=red>inst_id</font>) 
    199199eqassemble should wait for coda messages for the <A HREF="#FinalRule">FinalRule</A>, other than the local inst_id. This optional command is only useful if the 
    200200FinalRule is turned on and configured to WaitForCodas. If you are importing 
     
    206206 
    207207<PRE><!-- Default and example go here   --> 
    208 Default:  none                           
     208Default:  none 
    209209Calnet:   CodaFromInst  INST_UCB 
    210210</PRE> 
     
    212212<HR> 
    213213 
    214 <A NAME="DataSrc">  <!-- command name as anchor inside quotes -->        
    215  
    216 <PRE><B>DataSrc <font color=red>name</font>             eqas_config             Event Notification</B>   <!-- command args ... -->               
    217 </PRE> 
    218 <BLOCKQUOTE> <!-- command description goes here --> 
    219 Identify the source of the phase data with a single-character  
    220 <font color=red>name</font>. This code will be inserted into the hypoinverse  
    221 input message by eqcoda and will be passed through hypoinverse to show up in  
     214<A NAME="DataSrc">  <!-- command name as anchor inside quotes --> 
     215 
     216<PRE><B>DataSrc <font color=red>name</font>             eqas_config             Event Notification</B>   <!-- command args ... --> 
     217</PRE> 
     218<BLOCKQUOTE> <!-- command description goes here --> 
     219Identify the source of the phase data with a single-character 
     220<font color=red>name</font>. This code will be inserted into the hypoinverse 
     221input message by eqcoda and will be passed through hypoinverse to show up in 
    222222the hypoinverse archive message as the Data Source Code (column 109 in the 
    223223phase lines.) 
    224224 
    225225<PRE><!-- Default and example go here   --> 
    226 Default:  " "                            
     226Default:  " " 
    227227Calnet:   DataSrc  W 
    228228</PRE> 
     
    230230<HR> 
    231231 
    232 <A NAME="FinalRule">  <!-- command name as anchor inside quotes -->      
    233  
    234 <PRE><B>FinalRule <font color=red>Np Msec WaitForCodas</font>           eqas_config             Event Notification</B>   <!-- command args ... -->               
    235 </PRE> 
    236 <BLOCKQUOTE> <!-- command description goes here --> 
    237 The final TYPE_EVENT2K message will be released after binder has not changed  
    238 the solution (no TYPE_QUAKE2K messages) in <font color=red>Msec</font> seconds,  
     232<A NAME="FinalRule">  <!-- command name as anchor inside quotes --> 
     233 
     234<PRE><B>FinalRule <font color=red>Np Msec WaitForCodas</font>           eqas_config             Event Notification</B>   <!-- command args ... --> 
     235</PRE> 
     236<BLOCKQUOTE> <!-- command description goes here --> 
     237The final TYPE_EVENT2K message will be released after binder has not changed 
     238the solution (no TYPE_QUAKE2K messages) in <font color=red>Msec</font> seconds, 
    239239provided there are at least <font color=red>Np</font> P phases associated 
    240240with the event. If the optional string <font color=red>WaitForCodas</font> is 
     
    253253will not be applied and no version 2 event messages will be released from 
    254254eqassemble. However, you must have at least one of <A 
    255 HREF="#PrelimRule">PrelimRule</A>, <A HREF="#RapidRule">RapidRule</A>,  
    256 <B>FinalRule</B>, or eqassemble won't have anything to do.  
    257  
    258 <PRE><!-- Default and example go here   --> 
    259 Default:  none                           
     255HREF="#PrelimRule">PrelimRule</A>, <A HREF="#RapidRule">RapidRule</A>, 
     256<B>FinalRule</B>, or eqassemble won't have anything to do. 
     257 
     258<PRE><!-- Default and example go here   --> 
     259Default:  none 
    260260Calnet:   FinalRule     4 60 WaitForCodas 
    261261</PRE> 
     
    263263<HR> 
    264264 
    265 <A NAME="GetAssocFrom">  <!-- command name as anchor inside quotes -->   
    266  
    267 <PRE><B>GetAssocFrom <font color=red>inst mod_id</font>         eqas_config             Earthworm setup</B>      <!-- command args ... -->               
    268 </PRE> 
    269 <BLOCKQUOTE> <!-- command description goes here --> 
    270 Controls the association messages input to eqassemble.  Eqassemble will only  
    271 process quakes and links that come from module <font color=red>mod_id</font> at installation  
    272 <font color=red>inst</font>.  <font color=red>inst</font> and <font color=red>mod_id</font> are character strings (valid strings are  
    273 listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module.   
    274 Only 2 "Get*From" commands may be issued; wildcards (INST_WILDCARD and  
    275 MOD_WILDCARD) will force eqassemble to process all quakes & links,  
    276 regardless of their place of origin.   
    277  
    278 <PRE><!-- Default and example go here   --> 
    279 Default:  none                           
     265<A NAME="GetAssocFrom">  <!-- command name as anchor inside quotes --> 
     266 
     267<PRE><B>GetAssocFrom <font color=red>inst mod_id</font>         eqas_config             Earthworm setup</B>      <!-- command args ... --> 
     268</PRE> 
     269<BLOCKQUOTE> <!-- command description goes here --> 
     270Controls the association messages input to eqassemble.  Eqassemble will only 
     271process quakes and links that come from module <font color=red>mod_id</font> at installation 
     272<font color=red>inst</font>.  <font color=red>inst</font> and <font color=red>mod_id</font> are character strings (valid strings are 
     273listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module. 
     274Only 2 "Get*From" commands may be issued; wildcards (INST_WILDCARD and 
     275MOD_WILDCARD) will force eqassemble to process all quakes & links, 
     276regardless of their place of origin. 
     277 
     278<PRE><!-- Default and example go here   --> 
     279Default:  none 
    280280Calnet:   GetAssocFrom  INST_MENLO  MOD_BINDER 
    281281</PRE> 
     
    283283<HR> 
    284284 
    285 <A NAME="GetPicksFrom">  <!-- command name as anchor inside quotes -->   
    286 <PRE><B>GetPicksFrom <font color=red>inst mod_id</font>         eqas_config             Earthworm setup</B>      <!-- command args ... -->               
    287 </PRE> 
    288 <BLOCKQUOTE> <!-- command description goes here --> 
    289  
    290 Controls the pick and coda message input to eqassemble.  Eqassemble will only  
    291 process picks and codas that come from module <font color=red>mod_id</font> at installation  
    292 <font color=red>inst</font>.  <font color=red>inst</font> and <font color=red>mod_id</font> are character strings (valid strings are  
    293 listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module.   
    294 Only 2 "Get*From" commands may be issued; wildcards (INST_WILDCARD and  
    295 MOD_WILDCARD) will force eqassemble to process all picks & codas,  
    296 regardless of their place of origin.<BR>   
     285<A NAME="GetPicksFrom">  <!-- command name as anchor inside quotes --> 
     286<PRE><B>GetPicksFrom <font color=red>inst mod_id</font>         eqas_config             Earthworm setup</B>      <!-- command args ... -->