source: trunk/release_notes.working @ 2171

Revision 2171, 61.9 KB checked in by dietz, 14 years ago (diff)

* empty log message *

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1***
2***  THIS FILE IS UNDER RCS - DO NOT MODIFY UNLESS YOU HAVE
3***  CHECKED IT OUT USING THE COMMAND CHECKOUT.
4***
5***    $Id$
6***
7
8Release Notes:  Earthworm Version "working"
9Cleaned out after release of v6.2 on 4/15/2003
10Note that v6.3 was a CVS snapshot that was released on 9/21/2005
11
12NEW MODULES:
13***********
14
15pkfilter:
16The purpose of pkfilter is to reduce the number of "duplicate" picks
17from a given "station". For pkfilter, all components which have
18matching station code and network code are considered to be the from the
19same "station". The rules for what are considered "duplicate" picks
20can be found in the file:
21vX.X/src/seismic_processing/pkfilter/pkfilter.designspecs.txt
22Pkfilter is location-code friendly and will handle both the TYPE*2K
23and TYPE*SCNL versions picks and codas.  LDD 5/5/2004
24
25statrigfilter:
26The purpose of statrigfilter is to eliminate "duplicate" triggers
27from a given "station". For statrigfilter, all channels which have
28matching station code and network code are considered to be the from the
29same "station". The rules for what are considered "duplicate" triggers
30can be found in the file:
31vX.X/src/seismic_processing/statrigfilter/statrigfilter.designspecs.txt
32Statrigfilter is location-code friendly and will handle both
33TYPE_CARLSTATRIG_SCNL and TYPE_CARLSTATRIG messages.  LDD 11/23/2005
34
35putpick:
36   Putpick is a command-line testing tool which allows one to replay
37a file containing picks and/or codas into an Earthworm ring.
38     Usage: putpick <pickfile> <RING_NAME> <pause: y/n>
39Putpick reads a file containing a series of pick/coda msgs
40and write them to shared memory.  The file can contain a mix
41of TYPE_PICK2K, TYPE_PICK_SCNL, TYPE_CODA2K, TYPE_CODA_SCNL,
42and also comments.  Only valid TYPE_PICK* and TYPE_CODA* msgs
43will be written to shared memory; all other lines will be ignored.
44   Putpick is useful for replaying picks into binder - binder's
45logfile (or a portion of it) can be used as the input file
46to putpick, or the picks can be placed in a separate file.
47   If pause = y, the relative timing of writing msgs to ring is
48based on delta-t in the timestamps in the picks.
49   If pause = n, the msgs are written to the ring as fast
50as they are read from the file.   LDD 6/25/2004
51
52ws_clientIIx:
53Added a new set of ws_client routines (ws_clientIIx), that are used by
54ora_trace_fetch.  The new routines were designed to streamline and
55simplify access to the wave_servers while conserving wave_server
56resources.  (The routines handle connect/disconnect for the caller,
57and if given a list of requests, the routines will sort the request
58by wave_server, so that it will connect to one wave_server, retrieve
59the appropriate data, disconnect from the first and connect to the
60second, retrieve the appropriate data, and so on.
61The routines were written in 2001, (derived from ws_clientII) and have
62never been as thoroughly tested as ws_clientII.
63The routines have not been scheduled for SCNLizing.
64DK 072004
65
66scn2scnl,scnl2scn:
67A pair of conversion modules (code resides in data_exchange/scn_convert)
68to change trace data, picks and codas from the original Earthworm formats
69with site,component,network codes to the new Earthworm formats using
70site,component,network,location codes and visa versa.  Written by Will
71Kohler, modified by Pete Lombard to do SCN->SCNL lookups.
72LDD 10/21/2004
73
74slink2ew:
75A seedlink client for acquiring data from seedlink servers (e.g. IRIS)
76and converting to tracebuf2 (or optionally tracebuf). Much more robust
77than liss2ew. Written by Chad Trabant of IRIS; modified for tracebuf2
78and debugged by Chad Trabant and Jim Luetgert.
79JHL 4/19/05
80PAF Updated with version 1.3 on 1/30/2006
81
82export_ack, export_scnl_ack:
83  This new version of export expects to receive an acknowledgment packet
84for every packet it writes to the socket. Creation of this new version
85was desired because we observed during the export of continuous trace
86data that during a communication failure, export was able to successfully
87write several messages to the (broken?) socket, but import never received
88them. When the socket was re-established, those messages were lost forever.
89  Acknowledgments are received asynchronously by the socket-reading thread.
90A circular buffer, SendQueue, tracks the status of msgs after they been
91pulled from the MessageStacker queue. If the socket is broken/reconnected,
92export*ack re-sends any msgs in the SendQueue which haven't been
93acknowledged. In normal operation, if export*ack laps the SendQueue and
94finds a message that has been sent but not ACKed, it will sleep 10ms and
95then check status again, looping until an ACK is received before preparing
96to send the next message.
97  The SendQueue length is configurable, from 1 to 254 messages (default=100). 
98Using a shorter SendQueue can cause a decrease in the rate at which
99export will send messages. A slower rate might be desireable so
100that an import system is not flooded by data after a prolonged
101communication break. In testing with export and import on the same
102machine, these are export's approximate maximum data rates:
103  SendQueueLength =   1,   10 messages/second
104  SendQueueLength =  10,   90 messages/second
105  SendQueueLength = 100,  350 messages/second
106Using the default SendQueueLength, export*ack's data rate was not
107observably different than export_generic's data rate. 
108  export*ack requires using the new import_ack to communicate properly.
109Since the receipt of ACKs is asynchronous, we may now have the opposite
110problem to that we had before (duplicate data instead of lost data). It
111is now possible that import_ack actually received a packet, but export_ack
112didn't get the ACK before the socket broke. In this is case, export_ack
113will re-send the packet and import_ack will see the same packet more than
114once. The system running import_ack must be prepared for duplicate data.
115LDD 4/29/2005
116
117import_ack:
118  This new version of import is required as the data exchange partner
119for the new export*ack modules. However, it can communicate with either
120old or new-protocol export modules, and can therefore be used anywhere
121in place of import_generic.
122  From the first message received per socket connection, import_ack
123discovers what flavor of export it's talking to. It will do either
124old non-ACK or new ACK protocol as appropriate on the fly.
125  Import_ack has been modified to use same configuration commands as
126export for setting up the server connection and socket heartbeat
127strings and intervals. It still recognizes the original import_generic
128commands. 
129  Since the receipt of ACKs by export_ack is asynchronous, we may now
130have the opposite problem to that we had before (duplicate data instead
131of lost data). It is now possible that import_ack received a packet,
132but the socket broke before export_ack received the ACK. In this is case,
133export_ack will re-send the packet and import_ack will see the same packet
134more than once. Therefore, the system running import_ack as a partner to
135export_ack must be prepared to handle duplicate data.  LDD 4/29/2005
136
137wftimefilter:
138  This new module was created to "sanitize" incoming waveform data
139streams to the liking of Earthworm modules. It reads waveform data
140(compressed or uncompressed) from one transport ring and writes it
141to another ring, filtering out duplicate data, time overlaps and
142bogus future timestamped data. Timestamp checks are done for each
143channel independently. The check for bogus future timestamps requires
144that the system clock is set to network time.
145  Wftimefilter can be configured to output the messages using the
146original installation/moduleid or its own installation/moduleid.
147However, it does not alter the contents of the message in any way.
148  Systems which are importing data using import_ack/export*ack should
149probably use wftimefilter to remove possible duplicate data after
150an import/export reconnect. Systems importing waveform data from
151non-Earthworm data sources should also consider running wftimefilter
152to ensure that only chronological timeseries enter their own Earthworm
153processing.  LDD 5/10/2005
154  Modifed to allow additional optional behavior:
155   1)rejecting packets that have a sample-rate different than the expected one for the
156     channel. 
157   2)Limiting per-channel logging, to limit logfile size and increase readability.
158   3)Adding per-channel daily summaries of errors and warnings.
159   4)Adding the ability to issue a STATUS message to a ring as a part of the daily summary.
160  Default behavior should be unchanged.
161DK 2006/03/27
162
163startstop_service:
164(added to CVS by Paul Friberg 6/29/2005, authored by Mark Morrison)
165From the README.txt found in the src/system_control/startstop_sevice:
166startstop_service is identical to the old startstop_nt, except that
167it runs as a Windows service.  This means that the parameters are all the
168same - read from startstop_nt.d - but that startstop isn't just executed
169from a command window or via the scheduler.  Note that this version is
170taken from startstop_nt, so I haven't compiled or tested any of this under
171Solaris or other systems.  I believe it's generally felt, however,
172that these modifications don't apply to Solaris.
173
174srparxchewsend: as a new data source. This is contributed by Symmetric
175Research for their digitizers. It was installed in data_sources by
176Paul Friberg Jan 5, 2005.
177
178rayloc_ew:
179(last revised 13 July, 2004) Ilya Dricker at www.isti.com
180Rayloc_ew is an Earthworm Module to perform global relocation of
181earthquakes and travel time computation.  Rayloc_ew is an Earthworm-style
182wrapper around a Fortran program RayLoc written by Ray Bulland.
183Rayloc_ew attaches itself to the input ring and monitors the ring buffer
184for the TYPE_LOC_GLOBAL
185<http://folkworm.ceri.memphis.edu/ew-doc/PROGRAMMER/GlobalMessages.html>
186messages.  Rayloc_ew reformats the input and calls FORTRAN RayLoc processing
187machinery. The output of rayloc_ew is TYPE_RAYLOC
188<http://www.isti.com/~ilya/Message_Format_TYPE_RAYLOC.html> message,
189which is written to the output ring.  The rayloc_ew program is compiled
190and tested out on a Solaris platform (with gcc and g77 compilers).
191
192startstop_unix:
193Added in this Linux'ified version of startstop (uses a startstop_unix.d file)
194from Alexandre Nercessian: PAF 9/7/2005
195
196raypicker:
197Added this from the HYDRA package for Mitch Withers. This is the picker
198that is used by NEIC to feed glass. Only compile tested under Windows
199at this point since that is where NEIC uses it.
200PAF 01/30/2006
201
202glass:
203Add this from older NEIC distro. This is a global associator written
204by Carl Johnson. This module will only compile/run under Windows.
205PAF 01/30/2006
206
207eqfilterII:
208Added in this new module from Mitch WIthers for handling arc, global,
209and rayloc message types.
210PAF 01/30/2006
211
212geqproc:
213Same tasks as eqproc, but this takes global messages instead of
214arc messages. Part of global event processing chain.
215PAF 01/30/2006
216
217globalproc:
218Moved globalproc from NEIC v0.1 to v7.0.  Recall that globalproc
219listens to the glass chatter, assembles quake, pick, and amp messages
220into a global loc message, and sends it to the ring when appropriate.
221Combined with geqproc, the two accomplish the same thing as what
222eqproc did for binder.  This strays from the original intent of globalproc
223allowing a tweaked eqproc and globalproc to "eat" glass output simultaneously
224but given that we have rayloc, geqproc only needs to locate local events
225so this lashup was easier and does the job. Comments by Mitch Withers:
226PAF 01/30/2006
227
228config_ws:
229This module will listen on a wave_ring for scn or scnl type trace_buf[2]
230messages and create a waveserverV configuration file for the tanks. It
231has a number of configuration options to specify how many tanks and of
232what size they should be.
233This nifty little module is contributed by John Patton of the Hydra
234group and installed by Paul Friberg (only compiles under Windows).
235PAF 02/09/2006
236
237reconfigure:
238This command line tool sends a reconfigure request to startstop. Startstop
239will then re-read startstop_*.d and start up any new rings or modules it
240finds. Duplicate module names and duplicate ring names are not allowed.
241Necessary for this to work is the addition of
242Message  TYPE_RECONFIG       112
243to the earthworm.d file.
244s.lisowski 20060405
245
246
247
248MODIFICATIONS/BUG FIXES TO EXISTING MODULES:
249********************************************
250
251
252startstop:
253Reconfigure or 'recon' command added to startstop module. The command can
254either be given by running the command-line 'reconfigure' tool, or by typing
255'recon' or 'reconfigure' into the interactive EARTHWORM STATUS interface.
256Startstop will then re-read startstop_*.d and start up any new rings or
257modules it finds. Duplicate module names and duplicate ring names are not
258allowed. Necessary for this to work is the addition of
259Message  TYPE_RECONFIG       112
260to the earthworm.d file.
261Also some startstop commonalities for all four platforms (Windows, Windows
262Service, Linux, Solaris) were added to libsrc/util/startstop_lib.c, commonalities
263between Solaris and Linux were added to libsrc/util/startstop_unix_generic,
264commonalities between Windows and Windows Service were added to
265libsrc/winnt/startstop_winlib.c.
266s.lisowski 20060405
267
268statmgr:
269Modified to allow up to 10 pagegroup commands in statmgr config file.
270Modified descriptor files to allow optional module-specific settings for
271pagegroup (up to 10) and mail (up to 10) recipients. Any pagegroup or
272mail setting in a descriptor file overrides the statmgr config settings.
273This will allow the user to fine-tune on a per-module basis the recipients
274of various Earthworm notifications.
275Modified logfile name to use the name of the statmgr config file (had
276been hard-coded to 'statmgr*'.
277Modified logging of configuration and descriptor files.
278LDD 2006/4/25
279Added new command "From" to allow user to set the "From" field of outgoing
280email messages. This command is used only in the Windows version of statmgr.
281If the "From" command is ommitted, the email "From" field will be filled
282using environment variables %USERNAME%@%COMPUTERNAME%. Previous versions
283of SendMail() defaulted to root@mailserver. LDD 2006/05/19
284
285logit:
286Made it so that logit now appends a platform-specific slash to EW_LOG if
287there isn't one. This allows for a more consistent entry on in the
288environment/ew_<platform>.{cmd,bash} file.
289s.lisowski 20060405
290
291gmew:
292Added in SCNL capability (no longer available for just SCN) and upgraded
293to the new version of ShakeMapXML (v3.1). I also patched a minor wave server
294warning message to be more explicit (empty menu) and added versioning
295to the program itself.
296PAF 03/15/2006
297
298heli_ewII:
299Added in SCNL capability (no longer available for just SCN).
300PAF 03/15/2006
301
302libsrc/solaris/sleep_ew.c:
303Added: #include <string.h>   WMK 3/22/04
304
305libsrc/solaris/transport.c:
306Added: #include <stdlib.h>
307Function tport_bufthr() now returns NULL.  WMK 3/22/04
308
309libsrc/winnt/transport.c:
310Added: #include <stdlib.h>
311
312libsrc/util/kom.c
313Changed: "static struct k_buf" to "struct k_buf"   WMK 3/22/04
314
315libsrc/util/trheadconv.c
316New function to convert TYPE_TRACEBUF headers to
317TYPE_TRACEBUF2 headers.  WMK 4/29/04
318
319libsrc/winnt/sendmail.c
320Increased BUFFSIZE from 200 to 250, to accomodate more email recipients.
321This is a kludgy fix.  It might better to allocate the buffer on the fly,
322to accommodate any number of email messages.  Also, note that I did not
323increase BUFFSIZE in libsrc/solaris/sendmail.c  WMK 6/11/03
324
325libsrc/util/getutil.c
326Added new functions: GetKeyName, GetInstName, GetModIdName, GetTypeName.
327These functions take a numeric value (shared memory key, installation id,
328module id or message type) as their argument and return a pointer to its
329corresponding character string name from the earthworm*d tables.  If the
330numeric value is not in the earthworm*d tables, the functions return a
331NULL pointer.
332Added new function, GetLocalInstName, which return a pointer to the
333environment variable EW_INSTALLATION.
334LDD 7/29/2004
335
336libsrc/util/rw_strongmotionII.c:
337Changed rd_strongmotionII() to interpret both "-" and "?" as NULL strings
338when reading the QID: line qid and qauthor fields.  Previously only
339accepted "?" as a NULL string.  Change was required by CISN data which
340uses "-" as a NULL string in those fields.  LDD 2/13/2004
341
342adsend:
343Modified to produce tracebuf messages with trace2 headers.
344These headers contain location code and header version number.
345Old-style tracebuf messages (w/o location code) are no longer
346made.  WMK 4/22/04
347
348pick_ew:
349  Modified to create picks and codas containing SCNLs.
350Input waveform messages may be of either TYPE_TRACEBUF or
351TYPE TRACEBUF2.  WMK 4/29/04
352  Added new optional config file command so that pick_ew can choose
353which messages to process: GetLogo <instid> <modid> <msgtype>
354There's no limit to the number of GetLogo commands that can be used.
355If no GetLogo commands are used, then pick_ew will process all
356TYPE_TRACEBUF and TYPE_TRACEBUF2 messages in InRing. LDD 4/8/2005
357
358carlstatrig:
359  Modified for location code. Reads TYPE_TRACEBUF2 and produces
360TYPE_CARLSTATRIG_SCNL messages. PNL 5/5/2004
361  Added new optional config command so that carlstatrig can choose
362which messages to process: GetWavesFrom <instid> <modid>
363There's no limit to the nubmer of GetWavesFrom commands that can
364be used. If no GetWavesFrom commands are listed, then carlstatrig
365defaults to "GetWavesFrom INST_WILDCARD MOD_WILDCARD". LDD 4/12/2005
366
367binder_ew:
368  Modified to use TYPE_PICK_SCNL as input.  Required changes to the
369station file reading library, site.c, and to the hypoinverse site file.
370LDD 5/17/2004
371  Modified to attempt pick association with entire quake list before
372attempting a new stack. Previously only attempted association with
373the 10 most recent events.  This should allow picks to arrive fairly
374late (out-of-real-time) and still be associated with an event. This
375will prevent such picks from restacking into a new, duplicate event.
376This modification requires that binder keep track of the earliest
377pick sequence number associated with each quake so that no hypocenter
378updates are attempted if some of the supporting picks are no longer
379in the pick FIFO. If a Pick  associates with an event that can't
380be updated, a TYPE_LINK message will go out, but no relocation will
381be done, and no new TYPE_QUAKE2K message will be issued.
382LDD 10/21/2004
383  grid.c changes: Added sanity check on mStack value; modified grid_stack
384to go thru pick list from newest to oldest pick.
385LDD 10/29/2004
386  bind.c: Modified to make the pick and quake FIFO lengths configurable.
387Added two optional config file commands:
388pick_fifo_length xxxx (default = 1000 = previous hardcoded length)
389quake_fifo_length yyy (default =  100 = previous hardcoded length)
390Only large networks should need to consider using these commands to
391increase FIFO sizes. Care must be taken to ensure that eqproc/eqprelim
392FIFO lengths are the same length (or larger) than binder_ew's FIFOs.
393LDD 3/9/2005
394  Modified to shut down cleanly on termination request. LDD 4/15/2005
395  binder_ew.c: Added two optional commands:
396BufferRing  ringname (default = BINDER_RING = previous hardcoded string)
397            This defines which ring binder will use for private storage
398            space for incoming picks. ringname must exist in an earthworm.d
399            "Ring" line.
400EventIdFile filename (default = quake_id.d  = previous hardcoded string)
401            This defines the name of the file that will contain the
402            next valid eventid for binder to apply to a new association.
403Having these two items hardcoded had made it extremely tricky to run
404multiple instances of binder on the same host without them competing for
405common resources. Now it will be a simple matter of different configuration
406files to run multiple instances. This could be useful in testing
407different binder configurations.  LDD 8/1/2005
408
409eqproc:
410Modified to use TYPE_PICK_SCNL and TYPE_CODA_SCNL as input.
411Modified to produce TYPE_EVENT_SCNL as output.
412LDD 5/17/2004
413  Modified to make four more operational parameters configurable.
414All are set with new optional config file commands and default to
415the previous hardcoded values if their commands are ommitted.
4161. pick FIFO length ('pick_fifo_length' command, default = 1000)
4172. quake FIFO length ('quake_fifo_length' command, default = 100)
418For proper event reporting, eqproc's pick and quake FIFO lengths must
419greater than or equal in length to binder's FIFOs.
4203. heartbeat interval ('HeartbeatInt' command, default = 0.3*tReport)
4214. time interval at which quake FIFO is checked for events that are
422ready to send downstream ('rpt_check' command, default = 0.3*tReport)
423Items 3 & 4 were previously a hardcoded fraction of tReport, which is
424configured with the optional 'rpt_dwell' command (default = 30 s).
425These changes should allow eqproc to send events downstream in a more
426timely fashion.  LDD 3/10/2005
427
428eqprelim:
429Modified to use TYPE_PICK_SCNL and TYPE_CODA_SCNL as input.
430Modified to produce TYPE_EVENT_SCNL as output.
431LDD 5/17/2004
432  Modified to make two more operational parameters configurable.
433Both are set with new optional config file commands and default to
434the previous hardcoded values if their commands are ommitted.
4351. pick FIFO length ('pick_fifo_length' command, default = 1000)
4362. quake FIFO length ('quake_fifo_length' command, default = 100)
437For proper event reporting, eqprelim's pick and quake FIFO lengths must
438greater than or equal in length to binder's FIFOs.  LDD 3/11/2005
439
440eqcoda:
441Modified to use TYPE_EVENT_SCNL as input and to write location codes
442in the TYPE_HYP2000ARC message it puts out. Added new optional command
443"LogArcMsg" to control whether output TYPE_HYP200ARC msg is written to
444eqcoda's log file (0=don't log; non-zero=do log it).  LDD 5/20/2004
445
446hyp2000:
447Grabbed Fred Klein's most recent version of hyp2000 which is location-code
448compliant.  LDD 7/01/2004
449Grabbed Fred Klein's most recent version of hyp2000 which has a new
450command 'DI1' to set a different distance weighting scheme for early
451iterations.  Normal distance weighting is still set with the 'DIS'
452command. This change was prompted by trouble locating the Parkfield
453mainshock of 9/2004.  LDD 12/8/2004
454Grabbed Fred Klein's most recent version of hyp2000 which has added
455logic to allow location codes "  " and "--" to match (they both
456represent a "blank" location code). LDD 10/5/2005
457
458ew2file:
459Added optional command "TimeBasedFilename X" to control whether a
460time string derived from the message contents is added to the beginning 
461of the output file names. If X is zero (default), original file naming
462convention is used (SequenceNumber.suffix). If X is non-zero, a time
463string is prepended to the filename (YYYYMMDD-HHMMSS.SequenceNumber.suffix).
464This option is only applicable for TYPE_PICK2K, TYPE_PICK_SCNL, and
465TYPE_HYP2000ARC messages. All other message types will be named
466according to the original convention regardless of the TimeBaseFilename
467setting.  Other messages types containing timestamps could be added
468to the new naming scheme in the future.  LDD 11/11/2005
469
470evanstrig:
471Modified to use TYPE_TRACEBUF2 as input and to write TYPE_LPTRIG_SCNL
472as output. Both message types include location codes.  Changed config
473file command "MaxSCN" to "MaxSCNL".  Added location code as the fourth
474argument to the "TriggerOn" command. LDD 5/21/2004
475
476evansassoc:
477Added location code; modified to use TYPE_LPTRIG_SCNL as input and to
478write TYPE_TRIGLIST_SCNL as output.  Added location code as the fourth
479argument to the "AddChannel" command. LDD 5/24/2004
480
481putter:
482Modified to read files of TYPE_PICK_SCNL and TYPE_CODA_SCNL. Added
483optional second argument, ringname (name of ring to write msgs to).
484Previously was hardcoded to write to PICK_RING. Will still work with
485TYPE_PICK2K and TYPE_CODA2K msgs as long as the installation id and
486moduleid are less than 100.  LDD 5/17/2004
487
488findwave:
4891. Modified to read both TYPE_TRACEBUF2 and TYPE_TRACEBUF msgs.
4902. Modified "d" output (debug) to include pin number and message logo as 
491both character strings from earthworm*.d and numeric values. If a field
492of the logo is not in the local earthworm*d files, the debug output will
493show one or more of these strings: inst_unlisted, mod_unlisted, type_unlisted. 
494If the channel's installation id is different from the local installation id
495(set by the EW_INSTALLATION environment variable), the module_id string will
496read: mod_not_local.
4973. Modified "w" output (wave_serverV) to include the actual installation
498and module id strings from earthworm*d files.  If the installation is not
499in the earthworm_global.d file, it will be listed as INST_WILDCARD.  If the
500moduleid is not in the earthworm.d file, it will be listed as MOD_WILDCARD.
501If the channel's installation id is different from the local installation id
502(set by the EW_INSTALLATION environment variable), the module will be listed
503as MOD_WILDCARD.
5044. Modified all output to be space-delimited rather than tab-delimited.
505LDD 7/29/2004
506
507findwave:
508  Merged Hydra changes into findwave.  The default findwave behavior is unchanged.
509  Hydra changes include:
510     Option:  have tanks segmented by HD based on a HardDrive size
511     Option:  have findwave truncate tanksizes to 1GB, to comply with
512              wave_serverV maximum safe tank size.
513     Option:  have findwave massage the record sizes to be a fixed size
514              for all tanks.
515     Option:  have findwave massage the record sizes for variable-record-length
516              channels to be slightly larger than the largest record received for that channel.
517   Run findwave with no arguments for more information.
518
519gaplist:
520Added a "Total Gap" column to the output tables.  "Total Gap" is the
521total, in seconds, of the length of all gaps for a particular channel.
522"Total Gap" gets reset to 0 when the day rolls over.  Also, added a
523column named "Dead Time", which is the elapsed time since a channel
524died.  If "Dead Time" is blank, the channel is currently alive.
525"Dead Time" does NOT reset to 0 when the day rolls over. WMK 1/8/04
526
527gaplist: Slight table reformat.  WMK 1/20/04
528
529gaplist: Now accepts TYPE_TRACEBUF and/or TYPE_TRACEBUF2 messages.
530The config file (gaplist.d) now contains a list of SCNLs to monitor,
531rather than SCNs.  WMK 4/30/04
532
533gaplist: Added system-clock timestamp to logging of gaps/overlaps.
534Made slight formatting changes in logging.  LDD 5/7/2004
535
536gaplist: Now, the scnl array is allocated using realloc, so any number
537of Scnl and Label lines are permitted in the config file.
538Fixed two bugs:
539Label strings longer than 31 characters weren't null-terminated in the
540program.  Now, they are, so long labels are correctly truncated.
541Also, the label array, defined in gaplist.h, had a length of 31
542characters, which caused some values in the scnl array to get clobbered.
543This resulted in continuous dead/alive messages being sent to statmgr.
544WMK 5/11/04
545 
546gaplist: Added new optional command: GetLogo <instid> <modid> <msgtype>
547If no GetLogo cmds are given, gaplist will process all TYPE_TRACEBUF
548and TYPE_TRACEBUF2 messages (previous default behavior).
549Modified to allow processing of TYPE_TRACE_COMP_UA and TYPE_TRACE2_COMP_UA
550messages (headers are NOT compressed!). LDD 4/11/2005
551
552evtK2ora:
553Fixed endTime bug in makeEwSnippet(). Thanks Jim L.
554Alex 5/9/03
555
556shakemapfeed:
557The last two arguments to ewdb_api_GetSMDataWithChannelInfo were
558reversed. That meant that the number of returned SM messages would be
559incorrect IF that number exceeded MaxDataPerEvent. The result would be an
560out-of-bounds memory access and corrupted SM data. PNL 6/9/03
561
562shakemapfeed:
563Changed the sorting used in Filter_SM_data. Now SM messages are sorted by SCNL
564instead of by idchan. That means that the output XML will have components of
565one station listed consecutively, a big help for shakemap. PNL 10/30/03
566
567shakemapfeed:
568Changed the length of the long station name in the mapping file from
56920 to 50 characters.  LDD 2/5/04
570
571skakemapfeed:  (EWDB API - Strong Motion) ewdb_internal_GetAllSMMessages()
572(Note: This function is called by ewdb_api_GetSMDataWithChannelInfo())
573Fixed a bug in PostGetAllSMMessages().  The idEvent field may be null
574for some records, and Oracle  does not appear to be writing a 0 value to
575the memory area for the null field, so that record assumes the
576idEvent of the previous record located at that point
577in the internal buffer.  The result is data corruption, such that you get
578messages that are unassociated with an Event, but they appear to be associated
579with an event.
580DK 02/12/04
581
582shakemapfeed: Added new optional command, SMQueryMethod, to control how SM data
583is requested from the DBMS. Default behavior is original 2-stage query (get
584all SM data associated with this eventid, then get all UNassociated SM data
585in a space/time box). If SMQueryMethod is non-zero, shakemapfeed will request
586all SM data in a space/time box. This will return SM data associated with this
587event, SM data associated with other events, and UNassociated SM data.
588Regardless of query method, post-query filtering will be performed on eventid,
589external eventid, and external author.  SM data associated with a different
590eventid but with the same author will be rejected.  Data with a different
591author will be allowed - this is most likely data imported from another
592network and its eventids are meaningless in our DBMS.  LDD 02/13/2004
593
594shakemapfeed: Changed the auto-feed scheduling logic to allow for variable
595time intervals between feeds to shakemap.  Feeds are scheduled at
596fixed times after the arrival of the archive message by using the new
597command, ScheduleFeed (one time per ScheduleFeed command, up to 20 allowed).
598Auto-feeds will continue at the last ScheduleFeed interval until UpdateDuration
599minutes after the event origin time.  ScheduleFeed replaces the original
600DelayFirstFeed and UpdateInterval commands. These original commands are still
601accepted and will set up the auto-feed schedule in the original manner in the
602absence of ScheduleFeed commands.  LDD 3/4/2004
603
604k2ew:
605The channel bitmap bug reported below has been fixed. K2ew now reads the
606correct bitmap to determine which channels are streaming. PNL 6/9/03
607
608k2ew:
609Version 2.38: K2ew will now, optionally, obtain network code from the K2
610headers, rather than from the configuration file.  For this to work, network
611codes need to be entered into the K2 using Altus File Assistant. A different
612network code may be entered for each stream.  The K2 must be running
613application firmware version 3.02 or later.  The "Network" parameter, in the
614config file, is now optional.  WMK 3/25/05
615
616liss2ew, ew2liss, dumpseed:
617There was a bug on Microsoft based systems that caused the user defined
618types BYTE, WORD, and LONG to be ignored.  This was a problem specifically
619with the type WORD, which was changed from a signed 16-bit value to an
620unsigned 16-bit value, causing many problems, most noteably with the
621signed seed varibles for sample rate and sample rate multiplier.  All
622liss based modules have had this problem corrected. JMP 06/17/2003
623
624getfile_ew:
625There was a feature in getfile_ew that could cause more cpu to be
626used than necessary by checking time since last heartbeat more
627often than necessary.  Added sleep_ew(1000) within heartbeat
628loop. MMW 06/29/2003
629
630getfileII:
631Ported getfileII to FreeBSD.  Two new files are in the source directory:
632makefile.bsd and socket_bsd.c.  No other changes to files. WMK 11/25/03
633
634getfileII:
635Added more string-length checking to config.c and to the incoming file
636names and output paths to avoid overflowing character arrays. Changed
637version number to 1.1.  LDD 7/28/2004
638
639sudsputaway:
640Added functions to properly initialize SUDS structures to
641Banfill's default values. CJB 10/3/2003
642
643sudshead.h:
644Updated to make more compatible with suds.h in current
645release of PCSUDS. CJB 10/3/2003
646
647file2ew:
648Fixed bug in raw2ew.c which caused file2ew to exit when the
649SuffixType command contained only 2 arguments.  The third
650argument (installation ID) was supposed to be optional, and
651now is!  LDD 10/3/2003
652
653ew2file:
654Fixed bug in timing of heartbeat file generation.
655Had been using HeartBeatInt instead of HeartFileInt to control
656the production loop.  Caused continuous heartbeat file generation
657when HeartFileInt==0.  LDD 11/24/2003
658
659sniffwave:
660Changed to sniff headers of both TYPE_TRACEBUF and TYPE_TRACE_COMP_UA msgs.
661Will only print data values for TYPE_TRACEBUF messages.  Changed to accept
662the any of these strings as wildcards in SCN: "wild", "WILD", "*".
663LDD 10/31/2003
664
665Modified to list both the Quality value and (if TRACE2_HEADER the Version
666value) in the header output.
667DK 2005/03/27
668
669sniffwave:
670Modified to sniff headers of TYPE_TRACEBUF2 and TYPE_TRACE2_COMP_UA msgs.
671Added new command-line argument <location> to support these new message
672types. LDD 4/13/2004
673
674vX.X/src/data_exchange/Makefile:
675Added directives for STANDALONE_MODULES (right now getfileII and sendfileII)
676so that their executables, which are created in their source directories,
677are also copied to the vX.X/bin directory.  LDD 11/27/2003
678
679sendfileII:
680Ported to BSD Unix.  Added a new makefile, named makefile.bsd.
681To compile, type "make -f makefile.bsd".  Otherwise, everything is the
682same as on Solaris.  WMK 2/17/04.
683
684sendfileII:
685Added optional config command "-SendPause xxx" where xxx is a time in
686milliseconds (default = 0). sendfileII will sleep SendPause millseconds
687before trying to open a file for shipping.  This gives file writers of
688unknown behavior some time to finish writing and to close the file before
689sendfileII wisks it away. Windows fopen_excl() was supposed to keep us
690from opening a file that another process was using, but I don't think
691it's working the way we expected. Besides, Solaris never had the
692fopen_excl() option, so SendPause helps us there.  LDD 3/23/2006
693
694EWDB - Station Information:
695Modified the two stored procedures that handle the processing of SCNL
696from station list tools (stalist_XXX2ora) and automatic data (trace feed,
697automatic pick feed, strong motion, etc.).
698Modified the procedures to properly process the Location Code of the
699SCNL.  Prior to this, Location codes weren't properly being handled.
700Because this change is to SQL procedures and not C code, you must
701refresh the DB stored procedures by updating with the SQL scripts from
702"working".  (run ewdb_load_external_utils.sql from schema/sql_scripts).
703DK 02/17/04
704
705naqs2ew:
706  Modified to produce TYPE_TRACEBUF2 messages to support location codes.
707Can optionally be configured to produce the original TYPE_TRACEBUF msg.
708New config file commands: OutputMsgType (optional) and RequestChanSCNL.
709See sample configuration file for details. LDD 4/14/2004
710  Modified to output all packets (regardless of time-order) to Earthworm
711when RequestChanSCNL "delay" is -1.  This will allow out-of-chronological
712order data and possibly duplicate data into the EW system. For delay>=0,
713out-of-order packets will be ignored (previous behavior). LDD 11/22/2005
714  Added new command "RepackageNmx" (optional) to control how Nmx packets
715are repackaged into Earthworm messages.  If set to 1, naqs2ew will create
716one EW msg from each Nmx packet. If the Nmx packet contains more than
717MaxSamplePerMsg samples, multiple EW msgs will be created. The entire Nmx
718packet will be converted immediately.  If set to 2 (the default), naqs2ew
719will repackage Nmx packets into 1-second EW msgs.  If an Nmx packet
720contains more or less than 1-second of data, some samples will be buffered
721until the receipt of the next Nmx packet for that channel.  Some shorter
722EW messages will be generated if time tears are present.  LDD 11/23/2005
723  Fixed bug in how compression bits of raw Nmx compressed data packets
724are interpreted in unpack_tsdata_bundle() of nmxp_packet.c. Now, if both
725compression bits are 0, it is interpreted as "this data set contains no data"
726and the 4-byte data set is ignored. Previously, if both compression bits
727were 0, it was (mis)intrepreted to mean that compression was not used and
728that the data set contained a single non-differenced data value. This bug
729would have added extra bogus samples to the output, but probably only when
730a data packet was partially full. Since I can't think of a reason why a
731datalogger would not fill each data packet fully, I'm guessing that this
732bug was very rarely, if ever, encountered. LDD 1/4/2006
733
734
735reftek2ew:
736Modified to produce TYPE_TRACEBUF2 messages to support location codes.
737Config command "SCNFile" was replaced by the "SCNLFile" command.
738Location code was added to the SCNLFile (which maps between
739DAS#,stream,channel and SCNL,pin) as the 7th of 8 fields on each line.
740Added a new config file command "SendUnknownChan" to control whether
741channels not listed in the SCNLFile are written as TYPE_TRACEBUF2 msgs.
742If SendUnknownChan is non-zero, reftek2ew makes up the SCNL as follows:
743Station is the DAS serial number, component is "Cxx" where xx is the
744channel number from the DAS, network is "Sy" where y is the stream number
745from the DAS, and location code is "--" (the NULL location).
746If SendUnknownChan is zero, data from channels not listed in SCNLFile
747is ignored.  LDD 5/25/2004
748
749compress_UA:
750Modified to produce TYPE_TRACE2_COMP_UA messages when handling
751TYPE_TRACEBUF2 messages as input. Compress_UA can still take TYPE_TRACEBUF
752packets as input and will produce TYPE_TRACE_COMP_UA messages as output.
753Eliminated "GetWavesFrom" command and replaced it with two new commands:
754"GetLogo" to supply the logos to process and "CompressSCNL" to supply
755the list of channels to process.  If handling TYPE_TRACEBUF messages,
756the location code in the CompressSCNL command is ignored, but it still
757must be provided.  LDD 4/16/2004
758
759decompress_UA:
760Modified to work on both TYPE_TRACE2_COMP_UA and TYPE_TRACE_COMP_UA msgs.
761Produces TYPE_TRACEBUF2 messages if input is TYPE_TRACE2_COMP_UA.
762Produces TYPE_TRACEBUF messages is input is TYPE_TRACE_COMP_UA.
763Eliminated "GetWavesFrom" command and replaced it with "GetLogo" command.
764LDD 4/16/2004
765
766decimate:
767Modified to work on either TYPE_TRACEBUF and/or TYPE_TRACEBUF2 messages
768to support the addition of location codes to network processing.
769Output message will be of same type as input message.  Changed the
770GetWavesFrom command to require a third argument specifying the input
771message type (must be either TYPE_TRACEBUF or TYPE_TRACEBUF2). If the
772input message type is TYPE_TRACEBUF, location codes are ignored. Replaced
773the GetSCN command with GetSCNL to support the addition of location codes. 
774If the GetSCN command is used, the input and output location codes are
775set to "--".  LDD 5/11/2004
776
777sniffring:
778Modified so it does not attempt to print the contents of two new binary
779message types: TYPE_TRACEBUF2 and TYPE_TRACE2_COMP_UA.  LDD 4/16/2004
780
781export_actv, export_scn_actv:
782Moved source code from data_exchange/export_actv into data_exchange/export
783to avoid duplication of the supporting export filtering code.  The versions
784of the filters in export_actv had not had bug fixes in quite a while and
785were not location-code compliant.  LDD 4/20/2004
786
787export_scn, export_scn_pri, export_scn_actv:
788Modified the scnfilter code to include location code as well.  Replaced
789Send_scn and Send_scn_remap config commands with Send_scnl and Send_scnl_remap.
790If old commands are used, the location code will be set to * (wildcard).
791Modified to work with all the new location-code friendly Earthworm messages:
792TYPE_TRACEBUF2, TYPE_TRACE2_COMP_UA, TYPE_PICK_SCNL and TYPE_CODA_SCNL.
793Still works with old format messages.  LDD 4/21/2004
794
795export_generic,export_scn
796Added logging under "Verbose" mode concerning the queue status of each
797message to be exported. This will generate VERY LARGE log files, but
798could be useful in debugging.  LDD 3/23/2005
799
800write_cta:
801Program now reads TYPE_TRACEBUF and TYPE_TRACEBUF2 messages from the
802transport ring.  All TYPE_TRACEBUF messages are converted to TYPE_TRACEBUF2,
803before writing to tape.  Tape files now begin with "wu" (instead of "wt"),
804to indicate that they contain TYPE_TRACEBUF2 messages.  WMK 5/11/04
805
806read_cta:
807Program now reads tape files whose names begin with "wt" and "wu".
808"wu" files contain TYPE_TRACEBUF2 messages.  WMK 5/11/04
809
810cta2cusp:
811Cosmetic changes.  Program will process cta files beginning with wt or wu.
812Only old version triglist messages, without location code, will work.
813If there are multiple channels with the same SCN, they will be interleaved
814in the file sent to CUSP.  This is bad.  WMK 5/12/04
815
816tankplayer:
817Added support for TypeTraceBuf2, which was missing from the get_time function
818that is used to determine the time of the packet from the trace header.
819Changed the program's behavior when Tracebuf2 packets are encountered with
820VERSION fields that don't match those compiled into the program.  Previously
821the program always quit at the first sign of a tracebuf with a mismatched version
822number.  Now depending on the value of the IgnoreTBVersionNumbers config command,
823the program attempts to parse and either play or skip the message based on
824the value of the command.  (TRUE = play, FALSE= ignore).
825Added a log message when tankplayer comes across a large delay between packets.
826Modified the sleep code that executes between packets, so that it sleeps
827in small intervals and continues to issue heartbeats even during a large gap.
828Added additional debugging info for dealing with problems encountered in tracebuf files.
829DK 2006/03/09
830
831tankplayer:
832odified to read TYPE_TRACEBUF2 files in addition to the original file
833types (TYPE_TRACEBUF and TYPE_ADBUF).  LDD 5/21/2004
834
835remux_tbuf:
836Added WaveMsg2MakeLocal() call to report and filter out tracebufs
837with headers that don't checksum.
838Replaced fprintf(stdout) commands with logit().
839Added a progress indicator that prints a ".' to the screen each time
840100 tracebufs have been processed.
841DK 2006/03/09
842
843time_ew.c (timegm_ew())
844Fixed bugs in timegm_ew() that appeared on machines not set to UTC timezone.
845DK 07/12/2004
846
847import_generic:
848  Moved the generation of Earthworm TYPE_HEARTBEAT messages out of the
849Heartbeat thread and into the main() thread. EW heartbeats will be generated
850in both the "connect to server" loop and the main working loop. This means
851that import will keep beating its EW heart when its export server becomes
852inaccessible, avoiding unnecessary restarts by statmgr/startstop. The
853former Heartbeat thread was renamed the SocketHeartbeat thread because
854its sole job is to write heartbeats (alive strings) to the socket. Also
855changed names of variables related to the socket heartbeat thread to
856avoid confusion.  LDD 3/15/2005
857  Restructured the "connect to server" loop to be easier to follow and
858reworded the messages logged during connection attempts. LDD 3/17/2005
859
860import_gen_pasv:
861Incorporated Richard Godbee's bug fixes in the accept_ew loop (fixed
862mis-placed end-while bracket, uninitialized variables) and increased
863the length of the RingName and MyModName variables. Reformatted the
864entire file with proper, readable indenting, changed accept_ew timeout
865to HeartBeatInt (had been hard-coded to 9 seconds), added inter-connection
866time interval to logging, generally cleaned up comments. LDD 4/13/2006
867
868Most Modules:
869  Linux Makefiles (makefile.ux) have been added to a number of modules and
870in some cases _LINUX compile directives have been added into the code. The
871list of codes to which this has been done will be provided as a separate
872note. 8/11/2005 Paul Friberg
873
874startstop_nt:
875Added in restart command to Interactive() function. This nice modification
876was provided by Murray McGowan. Tested and added by Paul Friberg 9/7/2005
877
878startstop_unix/startstop_solaris:
879Added in the same restart command as above. It's a nice feature to have. (9/7/2005)
880
881
882CHANGES TO CONFIGURATION FILES and DESCRIPTOR FILES:
883****************************************************
884
885earthworm.d: Added this earthworm type to allow sending a reconfigure
886command through rings.
887Message  TYPE_RECONFIG       112
888
889statmgr.d: Up to 10 pagegroup commands are now allowed (at least one is
890required).  LDD 2006/4/25
891
892*.desc:
893Modified descriptor files to allow optional module-specific settings for
894pagegroup (up to 10) and mail (up to 10) recipients. Any "pagegroup" or
895"mail" commands in a descriptor file override the statmgr config settings.
896This will allow the user to fine-tune on a per-module basis the recipients
897of various Earthworm notifications.  LDD 2006/4/25
898
899shakemapfeed.d: Added new optional command, SMQueryMethod, to control how SM
900data is requested from the DBMS. Default behavior (SMQueryMethod 0) is original
9012-stage query (get all SM data associated with this eventid, then get all
902UNassociated SM data in a space/time box). If SMQueryMethod is non-zero,
903shakemapfeed will request all SM data in a space/time box. This will return
904SM data associated with this event, SM data associated with other events,
905and UNassociated SM data.
906  Regardless of query method, post-query filtering will be performed on eventid,
907external eventid, and external author.  SM data associated with a different
908eventid but with the same author will be rejected.  Data with a different
909author will be allowed - this is most likely data imported from another
910network and its eventids are meaningless in our DBMS.  LDD 02/13/2004
911
912shakemapfeed.d: New command "ScheduleFeed <minutes(float) after receiving event>"
913sets the shakemap feeding schedule. Up to 20 ScheduleFeed commands are
914allowed, setting one time per command.  Auto-feeds will continue at the
915last ScheduleFeed interval until UpdateDuration minutes after the event
916origin time. ScheduleFeed replaces the original DelayFirstFeed and UpdateInterval
917commands. These original commands are still accepted and will set up
918the auto-feed schedule in the original manner in the absence of ScheduleFeed
919commands.  LDD 3/4/2004
920
921naqs2ew.d: Two new commands to support location code addition:
922"OutputMsgType <TYPE_TRACEBUF or TYPE_TRACEBUF2>" to choose output format.
923   If the OutputMsgType command is omitted, naqs2ew will produce
924   TYPE_TRACEBUF2 messages by default.
925"RequestChanSCNL" replaces the "RequestChannel" command. It has all the
926   same arguments with the addition of the <location code> argument.
927   LDD 4/14/2004
928
929binder_ew.d:
930Two new optional commands:
931"pick_fifo_length <npick>" set the length of the pick FIFO (default=1000)
932"quake_fifo_length <nquake>" sets the length of the quake FIFO (default=100).
933If a command is omitted, the corresponding fifo will be set to the previous
934hardcoded length.  LDD 2/9/2005
935
936eqproc.d
937Four new optional commands. If any of these commands is omitted, the
938corresponding parameter will be set to its previous hardcoded value.
939"pick_fifo_length <npick>" set the length of the pick FIFO (default=1000)
940"quake_fifo_length <nquake>" sets the length of the quake FIFO (default=100).
941For proper event reporting, eqproc's pick/quake FIFO lengths must be
942greater than or equal to binder's pick/quake FIFO lengths!
943"HeartbeatInt <hbsec>" sets the interval (seconds) between TYPE_HEARTBEAT
944messages (default=0.3*tReport).
945"rpt_check" <chksec>" sets the interval (seconds) at which the quake FIFO
946will be inspected to see if it's time to send an event to downstream
947modules (default=0.3*tReport).
948The parameter tReport is set with the 'rpt_dwell' command (default=30s).
949LDD 3/11/2005
950
951eqprelim.d
952Added two optional commands. If either of these commands is omitted, the
953corresponding parameter will be set to its previous hardcoded value.
954"pick_fifo_length <npick>" set the length of the pick FIFO (default=1000)
955"quake_fifo_length <nquake>" sets the length of the quake FIFO (default=100).
956For proper event reporting, eqprelim's pick/quake FIFO lengths must be
957greater than or equal to binder's pick/quake FIFO lengths!
958LDD 3/11/2005
959
960compress_UA.d:
961Eliminated "GetWavesFrom" command and replaced it with two new commands:
962"GetLogo <Inst_id> <Mod_id> <msg_type>"
963 Inst_id and/or Mod_id fields can be wildcards, but msg_type field must
964 be either TYPE_TRACEBUF or TYPE_TRACEBUF2. Multiple GetLogo commands may
965 be supplied (no limit on number).
966"CompressSCNL <sta> <comp> <net> <loc>"
967 The wildcard character '*' (without quotes) can be used in any of
968 the fields.  Use as many CompressSCNL commands as needed to define the
969 list of channels to be processed.  If input is TYPE_TRACEBUF, the <loc>
970 field will be ignored, but it must still be provided.
971 LDD 4/16/2004
972
973decompress_UA.d:
974Eliminated "GetWavesFrom" command and replaced it with new command:
975"GetLogo <Inst_id> <Mod_id> <msg_type>"
976 Inst_id and/or Mod_id fields can be wildcards, but msg_type field must
977 be either TYPE_TRACE_COMP_UA or TYPE_TRACE2_COMP_UA. Multiple GetLogo
978 commands may be supplied (no limit on number).
979LDD 4/16/2004
980
981decimate.d:
982GetWavesFrom: added a third requires argument specifying the input
983message type.  Only valid messages types are TYPE_TRACEBUF and TYPE_TRACEBUF2.
984Replaced the GetSCN command with GetSCNL to support the addition of location
985codes.  GetSCNL requires 8 arguments, input SCNL and output SCNL. No wildcards
986are permitted.  LDD 5/11/2004
987
988export_scn*.d:
989Added two new commands, Send_scnl and Send_scnl_remap, to implement location
990code filtering.  If old commands (Send_scn and Send_scn_remap) are used,
991the location code is set to * (wildcard). LDD 4/21/2004
992
993wave_serverV:
994Modified behavior so that wave_server does not Abort On A Single Tank Failure,
995unless the AbortOnSingleTankFailure flag is set in config file. 
996(This was the documented behavior).
997
998wave_serverV:
999Wave server now limits tank sizes to 1GB.  This applies only to NEW tanks, not
1000existing tankfiles.
1001The default behavior is for wave server to EXIT if it comes across a tank in the
1002config file that is >= 1GB.
1003If the "TruncateTanksTo1GBAndContinue" command is set in the config file, then
1004wave server will trunctate any >= 1GB tank files to just under 1GB, and continue
1005normal operation.
1006This was done to prevent users from creating unsafe large tanks, after a bug was
1007discovered that limits the safe wave server tank size to ~1GB.
1008DK 2005/03/17
1009
1010Added code to check the return value from call to WaveMsg2MakeLocal(),
1011and reject packets for which WaveMsg2MakeLocal() reported and error.
1012Updated the wave_serverV version and timestamp.  This will cause
1013wave_serverV to filter out packets with header issues that weren't previously
1014filtered out before.
1015Fixed a bug where wave_serverV would filter out packets that contained only
1016one sample.
1017DK 2006/03/27
1018
1019wave_serverV / wave_viewer / ws_clientII.c:
1020Modified wave_server protocol slightly to better differentiate between SCN vs. SCNL
1021clients and servers.  New wave_server clients should be backwards compatible with
1022previous SCNL wave_servers, but the new wave_serverV is not backwards compatible
1023with any clients.
1024The new wave_viewer works with ALL wave_servers (SCN, old SCNL, new SCNL), and
1025the new ws_clientII library works with ALL SCNL wave_servers.
1026DK 2005/04/22
1027
1028
1029wave_serverV / wave_viewer / ws_clientII.c:
1030Fixed bug in wave_server (server_thread.c ParseMsg()) that was incorrectly reading
1031the Ascii FILL value from the "endtime" field instead of the "fill" field.
1032This fix only affects ascii wave_server clients on gappy channels.
1033Fixed more bugs in the ASCII protocol logic between ws_clientII and wave_serverV.
1034DK 2005/09/07
1035
1036ringtocoax:
1037Changed tport_getmsg to tport_copyfrom so that it can distinguish missed messages
1038(overlapped in ring) from sequence gaps in the ring. This can be useful for
1039fine-tuning the BurstCount and BurstInterval configuration settings.
1040LDD 2005/4/8
1041
1042localmag:
1043Does not compile under latest release of earthworm (needs to be SCNL'ized). It
1044will compile with earlier versions however and 3 new options have been
1045added in: useMedian, minStationsMl, require2Horizontals
1046which are all explained in the localmag/Doc/localmag_cmd.html file.
1047The program now has a version number to distinguish different released versions.
1048Upgraded as per requests from Univ of Utah and HVO on 8/10/2005 by Paul Friberg (PAF)
1049I upgraded localmag to use SCNL now and tested it at Utah 3/01/2006 PAF
1050
1051
1052
1053KNOWN BUGS:
1054***********
1055
1056liss2ew:
1057liss2ew has been observed intermittantly producing malformed
1058TRACE_BUF messages.  Currently the conditions for causing this problem
1059are unknown.  Due to this, liss2ew should be treated as suspect.  Use at
1060your own risk.  JMP 6-18-2003
1061
1062k2ew:
1063k2ew uses the k2hdr.rwParms.misc.channel_bitmap parameter to decide
1064which channels it will see as streams from the K2.  This is actually the
1065parameter which the K2 uses to decide which channels to record in an event
1066file (see K2's <bitmap> command).  The K2's <sdstreams bitmap> is the parameter
1067that shows which channels the K2 is streaming out.  This is the parameter
1068that k2ew should be using to decide what data it will see.  The big problem
1069is that none of the header files from Kinemetrics (nkwhdrs.h) seem to
1070show this parameter anywhere. This issue is only a problem for those folks
1071who want to record more channels on the K2 than they want to stream continuously.
1072Terry Dye (Univ of Utah) discovered this problem when trying to stream only
10733 channels of a 12 channel K2.  LDD 4/11/2002    FIXED PNL, 6/9/03
1074
1075
1076wave_serverV:
1077it occasionally sends the following error to statmgr:
1078   UTC_Thu Sep 06 03:30:14 2001  WSV1/wave_serverV_nano ReadBlockData
1079   failed for tank [z:\nano57.tnk], with offset[999908] and record
1080   size[64]! errno[0] Mail sent.
1081The nominal tank size is 1 megabyte, and the actual tank size is 999908.
1082It looks like waveserver is trying to read off the end of the tank.
1083WMK 9/6/01
1084
1085wave_serverV:
1086appears not to reply to requests for a single sample of data. I noticed
1087when testing wave_viewer, that if the start time and end time of a request were
1088equal (in which case there should be one sample of data) then wave_serverV did
1089not reply to the request (ASCII request) at all. No Data, No Flags, No Reply,
1090No Nothing.  It needs to issue a reply to every request.
1091DavidK 09/25/01
1092
1093wave_serverV:
1094Wave server appears to be limited (on 32-bit systems) to 1GB tank sizes.
1095A bug (a signed integer overflow of tmpoE at Line 1155 of
1096       serve_trace.c  (LocateRoughOffset()))
1097prevents data retrieval from the tank under certain conditions when the
1098tank size exceeds 1 GB.
1099DavidK & PNL 09/27/04
1100
1101Automatic restarts of adsend (using the "restartMe" line in the descriptor
1102file) can cause an NT system to hang. Therefore, you should never
1103use the autorestart feature with adsend, but you should bring down
1104the entire Earthworm system if adsend needs to be restarted.
1105LDD 5/31/2000 Comments added to adsend.desc, but leave this warning here!
1106
1107libsrc/utils/site.c: The strings used for station, channel and network are
1108required to be fixed length with trailing spaces added to short names. If
1109the strings given to site_index do not have these trailing blanks, SCN names
1110will not match. This is not documented anywhere.  PNL 10/15/00
1111
1112socket_ew: (libsrc/util/socket_ew_common.c libsrc/solaris/socket_ew.c
1113            libsrc/winnt/socket_ew.c include/socket_ew.h)
1114Fixed a bug in the connect_ew function().
1115When run in non-blocking mode (clients connecting to
1116a server - using a timeout value), there was a bug in
1117the connection code(discovered on Solaris) that caused
1118the function to return a timeout-error when there was
1119any kind of error during connection.
1120The bug was discovered when connecting to a non-existent socket.
1121When trying to connect to a non-existent wave_server on a machine,
1122the underlying socket library was returning a Connection-Refused error,
1123but the socket_ew library was passing back a timeout error.
1124-
1125The change only applies when a socket-error occurs while the function is
1126waiting for the connect to happen.  The instance where you will most-likely
1127see a difference, is when you try connecting to a non-existent socket.
1128Previously the function would return TIMEOUT, now it will return
1129connection REFUSED.
1130-
1131Added a new function: socketSetError_ew(),
1132and defined a new socket_ew return code: CONNREFUSED_EW.
1133DK 2003/02/04
1134
1135sm_ew2ora:
1136There is a bug in sm_ew2ora that involves having multipe time intervals for
1137components and channels.  If a strong motion message containing information
1138for a channel that the DB has never seen before is loaded into the DB, and
1139then later another message for the same channel with an earlier timestamp
1140is loaded, the load of the second message will fail, due to problems with
1141overlapping time intervals, and the call that sm_ew2ora uses to create
1142those time intervals.  This problem only affects stations that were
1143not previously loaded via one of the station loader programs stalist*2ora,
1144and only when receiving SM data that is timestamped with a time that is
1145prior to the original time for that channel.  The bug lies in the logic
1146of ewdb_api_PutSMMessage(), and not in the underlying code.
1147Davidk 05/25/01
1148
1149A change was made to ewdb_api_PutSMMessage() that dramatically affects
1150sm_ew2ora.  Please see the note about that function.  Davidk 2001/07/26
1151
1152ewdb_api_CreateWaveform()  (ewdb_internal_CreateSnippet.c
1153                            ewdb_internal_CreateWaveformDesc.c)
1154Added a call to release the cursors used by the internal functions, when they
1155fail.  Fixes a bug which resulted in a DB cursor leak when a call to stuff
1156a snippet into the DB failed.
1157DK 2003/02/04
1158
1159logit.c:
11601) Added a new function logit_core()
1161int logit_core( char *flag, char *format, va_list ap);
1162This function is the same as logit(), except that it takes a va_list argument
1163for the variable length parameter instead of '...', and it has an int
1164return value.
1165This function can be called by other functions that receive a '...' variable
1166argument list, where as logit() cannot.  logit_core() is to logit()
1167what vsprintf() is to sprintf().
1168-
11692) Moved all of the functionality in logit() to logit_core(), and modify
1170logit to call logit_core().
1171-
11723)  Added a new function get_prog_name2(), as an intended replacement
1173of get_prog_name().  get_prog_name2() includes an additional
1174parameter (the buffer length of the output buffer).
1175-
11764)  Modified logit_init() to use get_prog_name2() instead of get_prog_name()
1177-
1178All four(4) of these changes should be backwards compatible with all existing
1179earthworm code, and the modified logit.c has already been tested with several
1180earthworm modules.
1181-
1182
1183
1184ewdb_api:
1185Added new function ewdb_api_GetEventSummaryInfo() to retrieve summary
1186information for an event(including the preferred szSource and szSourceEventID
1187of the event).   011904 DK
1188
1189
1190
1191KNOWS DEFICIENCIES:
1192*******************
1193
1194ringtocoax:
1195In Windows NT, the time resolution of sleep_ew() is about 16 msec (one clock
1196tick).  On Solaris, the resolution is about 10 msec.  This is a problem for
1197ringtocoax, since packet delays need to be set to a few milliseconds.
1198
1199statmgr: A space is needed between "tsec:" and the value.
1200If it isn't there, things fail. Artifcat of the kom routines. (Alex)
1201
1202threads functions: The KillThread function on WindowsNT and Solaris
1203terminate the thread without ensuring that no mutexes are held. If a thread
1204holds a mutex when it dies, no other thread can get that mutex. PNL 1/12/2000
1205
1206carlsubtrig:
1207The system time must be set to GMT and ew_nt.cmd must have
1208TZ=GMT for carlsubtrig to work.  Comments in ew_nt.cmd done 5/25/00. Barbara
1209       
1210localmag:
1211needs GMT set on the system
1212
1213ew2seisvole:
1214on NT, exits with horrible crash when system is stopped.
1215
1216NUMBER OF RINGS LIMITED ON SOLARIS:
1217Under Solaris 2.6 (and probably other versions as well), the maximum number
1218of shared memory segments is six. This means that on an out-of-the-box machine
1219you can only configure six rings. If you try to configure more than that, you
1220will see a cryptic message from tport_create about too many open files.  The
1221fix to this problem is to add the following lines to the /etc/system
1222file, and then reboot the system.
1223
1224 set shmsys:shminfo_shmmax = 4294967295
1225 set shmsys:shminfo_shmmin = 1
1226 set shmsys:shminfo_shmmni = 100
1227 set shmsys:shminfo_shmseg = 20
1228 set semsys:seminfo_semmns = 200
1229 set semsys:seminfo_semmni = 70
1230
1231This allows for 20 rings.
1232
1233     Lucky Vidmar (7/6/2000)
1234
1235startstop_solaris:
1236Fixed bug in call to logit_init().
1237The program was printing error messages:
1238  Invalid arguments passed in.
1239  Call to get_prog_name failed.
1240  WARNING: Call logit_init before logit.
1241
1242startstop_solaris:
1243There MAY be a problem with the signal that
1244startstop sends to modules during the shutdown sequence. The shutdown
1245sequence is started (after typing "quit" to startstop or running "pau")
1246by startstop placing a terminate message on all transport rings. Modules
1247should see this message and start their own shutdown. After a configurable
1248delay, startstop checks to see that all modules have exitted. Any that are
1249still running are sent a signal to terminate them. Currently that signal
1250is SIG_TERM. But since wave_serverV has a handler for SIG_TERM, wave_serverV
1251sees that as essentially the same as a terminate message. So if wave_serverV
1252is having problems completing its shutdown, SIG_TERM won't do anything. The
1253result is that startstop may give up and exit, leaving wave_serverV running.
1254If that happens, the operator will have to terminate wave_serverV by doing
1255"kill -9 <wave_serverV-pid>". That may leave shared memory and semaphores
1256stranded in the kernel: run the command "ipcs -a" to see. If necessary,
1257the stranded shared memory and semaphores may be cleaned up with the
1258ipcrc command; must be run as root; see the man page.
1259This problem only exists on Solaris/Unix, not on WindowsNT.
1260PNL, 10/4/2000
1261
1262libsrc/utils/kom.c:  fix comment in k_open()
1263
1264The comment above k_open() says that only one file can
1265be open at a time. Yet the Kbuf array has slots for MAXBUF (currently 4) open
1266files. Does this work, or is the comment to be taken at it's word?
1267PNL 10/15/00
1268
1269libsrc/utils/logit.c: logit_init() requires a module_id number, which it uses
1270to construct the log file name. This is not helpful, since the module_id
1271number is not meaningful to people. Worse, it requires that the config file be
1272read and earthworm.d lookups be completed before logit calls can be made. Thus
1273errors in the config file can only be reported to stderr or stdout instead of
1274being saved in a file.  PNL 11/29/00
1275
1276libsrc/util/k2evt2ew.c: This library supports a maximum EVT data size
1277of 800000 samples per channel per EVT file.  This value is hardcoded
1278as MAXTRACELTH in include/k2evt2ew.h.  k2evt2ew() will return a warning
1279if the EVT file exceeds this size, and process as much as the EVT file
1280as the hardcoded limit allows.
1281DK 2003/01/18
1282
1283import_ida:  Modified to build under WIN32(#ifdef'd a couple of includes
1284and modified the NT makefiles.)  (saved under tag HYDRA_V1-20)
1285Modified for SCNL and Tracebuf2.
1286DK 2005/04/22
1287
1288
1289TRACEBUF messages.
1290The definition of `endtime' of the TRACEBUF message is not documented.
1291Some programmers are taking it as the "expected start time of the next
1292TRACEBUF packet (if the sample interval is uniform.)" The more accepted
1293practice is that `endtime' is the time of the last sample of the current
1294TRACEBUF packet; that is, one sample interval less than the expected
1295start time of the next TRACEBUF messsage. Using this last definition, if a
1296TRACEBUF packet has exactly one sample, then its starttime and endtime are
1297the identical. Clearly this distinction needs to be documented. The file
1298waveform_format (in the /home/earthworm/DOC directory) gives no specifics
1299about start or end times.  PNL 1/24/01
1300
1301
1302
Note: See TracBrowser for help on using the repository browser.