source: trunk/release_notes.v7.5 @ 5054

Revision 4575, 17.3 KB checked in by paulf, 7 years ago (diff)

v7.5 release notes set in stone, we are done

Line 
1Release Notes:  Earthworm Version "working"
2Cleaned out after release of v7.4 on 4/27/2010
3
4These notes are for release v7.5
5
6NEW MODULES:
7***********
8
9Hypo71PC
10This is not a module, but an independant binary used by hyp71_mgr.
11It is a slightly modified version by Alexandre Nercessian of the widely used USGS location program.
12Modifications allow higher number of stations, altitudes to be taken into account,
13earthquakes above sea level as well as stations below sea level.
14Jean-Marie SAUREL 07/15/2011
15
16ewhtmlemail
17Written by Ruben Luis of CVARG. Produces a fancy email with HTML using
18embedded images and a google map. Is triggered by a TYPE_HYP2000ARC
19message. This is in the reporting section of the source
20Ruben Luis 07/07/2011
21
22
23nq2ring
24nq2wws
25nq2wws_ack
26nq2pgm
27nq2gif
28Written by Jim Luetgert for taking netquakes mseed data and injecting it
29into a ring, winston wave server, gif files and peak ground motion calcuations.
30Moved from Contrib/Menlo to data_sources in EW7.5
31Moved by Paul Friberg 07/07/2011
32
33nll_mgr
34This is a module to do for NonLinLoc what hyp2000_mgr does for hypoinverse. It
35basically runs NonLinLoc and converts the input and output so that it matches
36what hyp2000 does so that downstream programs can get a new earthquake solution.
37This uses Anthony Lomax's NonLinLoc locator program found here:
38        http://alomax.free.fr/nlloc/
39The nll_mgr was contributed by INGV but written by Anthony. Formerly this was in
40the Contrib bundle, but it is in use in a few places as a production module.
41NOTE that we are also including NonLinLoc with each EW release as a convenience,
42but if you need the latest, go to Anthony's web site link above.
43Loaded into SVN by Paul Friberg 05/15/2011
44
45EWQuakeAlert
46A Java 1.6 GUI that receives HYP2000ARC messages from import and creates alert
47emails and SMS (sms using clickatel interface) with information about the
48event. In addition to the origin info, it sends emails with a google map of
49the location and a .png display of the waveforms that had picks.
50Written by Ruben Luis
51Loaded into SVN by Paul Friberg 04/18/2011
52
53cont_trig
54This module sends regularly trig2k messages in order for a listening trig2disk
55to produce continuous data archiving. It can replace the contrecord Perl and modules
56of GlowWorm package (used until v6.3).
57Based on carlsubtrig module.
58Tested under Linux CentOS.
59Jean-Marie Saurel 03/12/2010
60
61trig2arc
62This module converts trig2k messages into hyp2000_arc messages.
63Only the stations that has been trigged are send in the output.
64P arrival time is the trigger time for each station, and the weight is 4.
65Tested under Linux CentOS.
66Jean-Marie Saurel 03/12/2010
67
68seisan_report
69This module is contributed from Richard Luckette and Doug Scott of the BGS
70and it takes an HYPO2000ARC message and converts it to SEISAN event format.
71Paul Friberg 12/07/2010
72
73hyp71_mgr
74This module allows to use Hypo71 at the end of the megamodule instead of hyp2000.
75The input/output is the same as hyp2000_mgr module.
76It allors also to compute and integrate local magnitude using standalone mode
77of localmag.
78Tested under several Linux flavours.
79Jean-Marie Saurel 10/12/2010
80
81ewspectra
82This module takes data from one or more waveservers, computes and processes
83their spectra; results can be written either to a file or a ring.  Processing
84includes tapering, smoothing, filtering, and peak identification.  Data
85acqusition can be initiated from the config file or from a message read from a
86specified ring (see 'compute_spectra').
87Scott Hunter 04/26/2011
88
89compute_spectra
90This module posts a message that, when read by ewspectra, begins processing data
91starting at the specified date/time.  (Deprecated w/ the creation of
92activate_module)
93Scott Hunter 04/26/2011
94
95sniffspectra
96This module is a sniffwave for spectra messages, as written by ewspectra.  Results
97can be directed to stdout or to a different file for each message "sniffed", in
98a specified directory.
99Scott Hunter 04/26/2011
100
101ewthresh
102This module monitors a ring for TRACEBUF2X messages and generates an alarm message
103when a SCNL-specific threshold is exceeded.
104Scott Hunter 04/26/2011
105
106activate_module
107This module puts an ACTIVATE_MODULE message in the specified ring, the body of
108which starts with the module ID of the specified target module, followed by the
109remaining command-line arguments.
110Scott Hunter 05/05/2011
111
112activated_scripts
113This module, upon reading an ACTIVATE_MODULE message in the specified ring,
114executes a sequence of scripts (making substitutions w/ supplied arguments),
115and reports the final return code in a message to the specified ring.
116Scott Hunter 05/18/2011
117
118ewnotify
119This module monitors a ring for ACTIVATE_MODULE or alarm messages; generates email
120and posts a message to a ring for an instance of activated_scripts.
121Scott Hunter 05/20/2011
122
123ewaccel
124This module monitors a ring for TRACEBUF2 messages, assumed to be from
125sensors on different floors of a building.  The sum of the forces for the floors
126is computed for each sample time and, if it exceeds a specified threshold, an
127alarm message is written to an output ring.
128Scott Hunter 06/08/2011
129
130sendfilemt
131This module is a multi-threaded version of sendfileII that runs as an Earthworm module,
132meaning it sends heartbeats to statmgr, and restarts like other well-behaved EW modules.
133Running sendfilemt is equivalent to running multiple copies of sendfileII, but
134only one only one configuration file is needed, and sendfilemt needs to be mentioned only
135once in the startstop.d and statmgr.d files.  The module was tested on Solaris and Windows,
136Since sendfilemt uses the standard multithread Earthworm functions, it will probably run
137ok on other operating systems too, if the appropriate makefiles are written.
138Will Kohler 7/24/2011
139
140adsendxs
141Adsendxs is a rewrite the old adsend module that works with newer model DAQ hardware and
142GPS receivers. Here are some features of adsendxs:
143- Runs on National Instruments X-series DAQ modules, which come in PCI Express and USB
144  versions.
145- Uses the NI-DAQmx API, rather than the legacy NI-DAQ API.
146- Not tested on Linux.  The NI drivers may or may not be Linux compatible.
147- Obtains accurate time from an inexpensive Trimble ThunderBolt E GPS Disciplined Clock.
148- Seismic amplitudes are scaled the same as the older adsend program, to ensure
149  compatibility with existing downstream software.
150- Runs at a user-configurable sample rate.  Tested at sample rates up to 2000 sps.
151- Periodically updates the O/S clock, using time from Trimble GPS.
152Will Kohler 7/24/2011
153
154
155MODIFICATIONS/BUG FIXES TO EXISTING MODULES:
156********************************************
157carlsubtrig
158Added in CoincidentStaTriggers option to squash triggers of telemetry spikes. This was
159done for the Azores network but could be applicable elsewhere.
160Note that I also added a version number to the program which is stored in the log file
161AND also echoed to the command line if no args are provided. All EW modules should do this.
162Paul Friberg July 19, 2011 (with testing help from Ruben Luis).
163On August 18, 2011, I added IgnoreCoincident to ignore the coincident check if more than a
164specified number of subnets triggered coincidentally. The idea being that a telemetry glitch
165would not cross more than this number of subnets.
166
167hypoinverse 1.3 upgrade
168Note that the docs have changed and one command (ZTR has 2 args
169instead of one). This new version is really 1.35 and allows hypoellipse
170features which have now been integrated in.
171Fred Klein did all the code, Paul Friberg integrated with EW and checked it in.
172July 18, 2011
173
174binder_ew
175Added a new option no_S_on_Z which is a simple flag to
176not allow S phases to be associated with picks on vertical
177component channels. This option is off by default.
178Thanks to Barry Hirshorn for the idea from binder_agl.
179Paul Friberg 07/04/2011
180
181restart
182Now accepts multiple pids for restart instead of just one!
183I made the configfile option a flag (-c) too.
184Usage: restart [-c config_file] <pid> [<pid> ...]
185Paul Friberg 06/28/2011
186
187tankcut
188Fixed the -e option, which apparently never worked!
189Paul Friberg 06/10/2011
190
191localmag
192Stefan and I fixed the windows compilation which produced bogus numbers and never got
193a magnitude (despite running fine). The issue was a output array was filled with
194garbage numbers (not zeroed). While this was easy to solve (zero the array
195before calling convertWave()), it was not easy to find!
196Also, later we added the new configuration option ChannelNumberMap
197to map numbered channels to letter code orientations.
198New version is 2.1.4 (DOES NOT EFFECT ANY UNIX build of this)
199Paul Friberg & Stefan Lisowski 06/08/2011
200Later on added in capability to  for Z channel mags, via optional allowVerticals
201New version after allowVerticals is 2.1.5
202Paul Friberg 06/30/2011
203
204sniffring
205added in a -n option to allow  NO FLUSHING of messages if you want to see all
206the messages in a ring at a given instant you can use this new feature.
207Paul Friberg 06/01/2011
208
209tankplayer
210Fixed a bug where no heartbeats were issued if the Directory Scanning mode was
211used to playback data.
212Paul Friberg 04/29/2011
213
214eqassemble
215modified main tport_getmsg loop such that messages received with return codes
216GET_OK, GET_MISS, and GET_NOTRACK are all processed.  Previously, only msgs
217returned with GET_OK were processed. Msgs with GET_MISS and GET_NOTRACK returns
218were essentially ignored; only the return code was logged.
219Lynn Dietz 04/01/2011
220
221nmxptool
222updated nmxptool to version 2.0.0
223Matteo Quintiliani 01/24/2011
224
225sniffwave
226added in tracebuf2.1 detection capability display (to show a conversion factor instead
227of data quality flags). This is fully backward compatible with all prior
228versions.
229Kevin Frechette 01/12/2011
230
231localmag
232Fixed a case where if multiple wave_serverV's were listed, only the first one
233was ever polled for data (the rest were marked as duplicates).
234Paul Friberg 01/12/2011
235
236export_generic
237any linux module using PTHREAD_STACK set to 8192 can possibly segfault on
23864-bit linux (unreliably). The thread stack size was increased to 81920
239for Linux #ifdefined statement and all problems went away. This was not
240tested on Solaris or Windows or Mac OS X.
241Paul Friberg 12/02/2010
242
243tankplayer tools, wave_probe, dumpwave, cleandir, glass, startstopservice
244On Windows, added kom.obj to link so that the new kom dependency to logit
245is taken into account.
246Stefan Lisowski 11/11/2010
247
248tankplayer tools, ew2mseed, dumpwave, getmenu
249On Solaris and Unix makefiles, added kom.o to link so that the new kom
250dependency to logit is taken into account.
251Matteo Quintiliani 11/4/2010
252
253menlo_report
254Added parameter EnableLongFileName in the configuration file of menlo_report.
255It enables writing arc/sum files with format DATETIME_ID_VER.SUFFIX
256(i.e. 201011040932_0000097658_2.arc)
257Matteo Quintiliani 11/4/2010
258
259eqcoda
260Increased buffer size to 512 bytes for reading a line from the station file.
261Same behaviour of pick_ew.
262Matteo Quintiliani 8/25/2010
263
264sniffwave
265Fixed a misleading print statement when WaveMsg2MakeLocal() failed on a SCNL, it
266showed possible spaces in the SCNL that were not really there.
267Paul Friberg 8/19/2010
268
269fir
270Added QueueSize optional parameter to increase the default from 100
271Added SleepMilliSeconds optional parameter to decrease the default from 500ms
272Paul Friberg 8/18/2010
273
274statmgr
275*Bugfix You can now comment out the line that includes an email addres
276        so nobody gets emailed by statmgr, and you don't need to put a
277        fake email address in to get statmgr to start. This is the
278        behavior that is desccribed in the config file. Fix by Paul Friberg
279        201006
280
281sniffwave
282- Removed hundredths of second from values of latency.
283- Changed the SCNL line output format in order to increase the readability.
284  Now each field falls nearly at same column.
285- Quality fields are now displayed in hexadecimal.
286  Before non-ASCII characters were improperly printed to the terminal.
287- Distinguished output for gaps and overlaps.
288Matteo Quintiliani 6/22/2010
289
290ew2mseed
291Removed -D_SPARC from CFLAGS line of makefile.sol. This flag prevented
292proper byte-swapping on Solaris for little-endian (Intel) platform.
293Ilya Dricker 5/05/2010
294
295ew2mseed
296*Bugfix to prevent overflow in printing of location code
297*Fixed a condition of a bogus 'FULLY in THE GAP' return from waverserver.
298 Now if waverserver insists that the request is fully in the gap, but the
299 requested startTime is more than 12 hours AFTER the current time, we redefine
300 the waveServer FLAG is 'REQUEST-AFTER-THE-TANK'
301Ilya Dricker 5/19/2010
302
303trig2disk
304Postproc external script is now launched with tow arguments :
305date (YYYYMMDD) and time (HHMM) of the processed event.
306Change by Frederic Randriamora.
307Jean-Marie Saurel 27/12/2010
308
309gmew
310Added ability to recognize ACTIVATE_MODULE messages to initiate processing; also
311added ability to override the set of spectral periods to be processed.
312Scott Hunter 05/18/2011
313
314startstop
315Fixed writing of empty error messages
316Scott Hunter 5/17/2011
317
318startstop
319Restored ability of unix versions to control modules by id; made Windows version
320of this more robust
321Scott Hunter 6/22/2011
322
323statmgr
324Now allows for up to 10 mailservers; when mail is sent, each is tried in order
325until one works.
326Scott Hunter 6/29/2011
327
328startstop
329Uses new transport call to clear ring flag requesting termination of a process
330Scott Hunter 6/29/2011
331
332startstop
333Changed to reflect changes to transport library
334Scott Hunter 7/8/2011
335
336pick_ew_analysis
337I have made very significant changes to the first version. Here is a short list of the main:
3381.       Windowed or full-screen - This allows larger traces
3392.       Multiple and prioritized waveform sources - One may have multiple waveform sources. The app will automatically select one according to the required station and time interval
3403.       List of available stations and time intervals for each source - This allows checking if a waveform source carries the data that we need. Similar to get menu but extended to other waveform sources.
3414.       Reads data from wave/Winston servers, tank files (SCNL only), and mini-seed files - I included the latter to be able to check data from continuous archives.
3425.       On-screen indication of available data for each station within requested time interval - There is a small check after each station to let the user know that there is data available for the requested time interval.
3436.       Facilitated automatic setting of the request time interval based on availability of the sources - I included a button to automatically set the start and end times according to the time interval available from the sources. In case of waveservers it sets the end time to NOW-1 minute (I think) and NOW-21 minutes.
3447.       Indication of incorrect date/time settings - Characters turn red if you make an obvious mistake or swap start and end times
3458.       Zoom-in and pan buttons as well as drag-to-zoom - Swarm like waveform browsing is really cool to find details.
3469.       Missing parameters from pickew are included: NoCoda, RestartLength and MaxGap - I had some requests for this, particularly the nocoda
34710.   Tooltips with the pick and coda texts
34811.   Tooltips with the causes for failed picks - Same as before.
3492011-07-06 Ruben S. Luis (commited to svn by Stefan)
350
351CHANGES TO CONFIGURATION FILES and DESCRIPTOR FILES:
352****************************************************
353
354Environment Variable expansion in .d files
355Added file environment/earthworm_commonvars.d for declaring "Earthworm Common Variables"
356It is now possible to declare variables like ${...} within .d configuration files
357Matteo Quintiliani 11/4/2010
358
359
360KNOWN BUGS:
361***********
362
363
364KNOWN DEFICIENCIES:
365*******************
366
367
368LIBRARY CHANGES:
369****************
370
371Added a tport_flush call to the transport library; acts as if tport_getmsg were
372called repeatedly until no more messages were found, but doesn't incur the
373overhead of returning the messages (which would get ignored anyway).
374Scott Hunter 5/18/2011
375
376Changed default mail program used by SendMail for MacOSX
377Scott Hunter 5/20/2011
378
379Added a tport_detachFromFlag call to support change in flag: instead of
380a single value, it now records all individual process IDs put to it
381(until TERMINATE is put to it, which effectively replaces the list) --
382this prevents the flag from being changed before the target process
383reads it (which is now possible, due to making the stop & restart
384commands multi-threaded).  tport_getflag now yields TERMINATE if that
385has been put; if it hasn't but the process's own ID is in the list, that
386is returned; otherwise, 0 is returned.  tport_detachFromFlag is now used
387to remove a value from the list (what used to be done by putting a 0).
388Scott Hunter 6/29/2011
389
390In order to support legacy modules not using the new transport library,
391SHM_HEAD was restored to its original form, and the new list-of-IDs flag
392is kept in a distinct ring which is only used for this purpose.  Processes
393that do not use the new library will be communicated with via the old flag
394field (which has the original overwriting issue, but now contention is only
395between legacy modules).
396Scott Hunter 7/8/2011
397
398Modified transport library so if a module using the new library is run with
399a startstop built against the transport library using the original flag
400representation, module will use the old style flag.  Also modified to allow
401key for flag ring to be specified in earthworm.d (named FLAG_RING).
402Scott Hunter 7/19/2011
403
404Modified getutils to provide a version of GetKey (GetKeyWithDefault) which
405takes a default value to return if the specified key does not exist; modified
406transport to use this new function to avoid error messages when FLAG_RING is
407not defined (and a default value is used).
408Scott Hunter 7/25/2011
Note: See TracBrowser for help on using the repository browser.