Commit 003a4a67 authored by Matteo Quintiliani's avatar Matteo Quintiliani
Browse files

Tags for release nmxptool-2.0.0

git-svn-id: file:///home/quintiliani/svncopy/nmxptool/tags/nmxptool_2_0_0@1388 3cd66e75-5955-46cb-a940-c26e5fc5497d
parent 543e527e
Matteo Quintiliani - Istituto Nazionale di Geofisica e Vulcanologia - Italy
Mail bug reports and suggestions to <>
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
nmxptool Release History
* Release 2.0.0 (2010/10/22)
- Improved saving of mini-SEED files, now data samples are saved using
the whole available space within the mini-SEED records.
- Added capability, using libmseed, to choose mini-SEED record length (option -r).
- Added capability, using libmseed, to choose between steim1 and steim2
compression (option -x), and data quality indicator (option -q). (R. Racine)
- Added feature: enabled ShortTermCompletion also in Earthworm configuration.
(Short-Term-Completion has been implemented in NaqsServer version 2.1)
- Added feature: within state file it is now allowed to insert white spaces,
tabs, and comment string by '#'. (involved option -F)
- Changed the output list of channels from NaqsServer, in order to create
automatically a state file. (involved option -L)
- Added signal handling to force to close a connection and open again
without quitting the program. Only for connection in near real-time
to NaqsServer. (Signal -USR1).
- Fixed some memory leaks and potential other memory bugs. (R. Racine)
* Release 1.2.4 (2009/12/22)
- Fixed major bugs: made code thread safe substituting functions
and removing static variables from own functions. (S. Pintore)
- Improved saving of mini-SEED files into SDS and BUD structure,
now it is possible to store mini-SEED in near-real-time from NaqsServer.
- Added feature: packets converted in mini-SEED records can be directly sent
to the Seedlink server by the function send_mseed(), in place of using
the function send_raw_depoch(). (option -K or -k).
- Changed SeisComP templates adding source port to the file name of channel list.
- Added SeisComP templates for retrieving Data On Demand with minimun delay.
- Added minor feature: declare timing_quality from the command-line. (option -Q).
* Release 1.2.3 (2009/01/15)
- Added feature: mini-SEED files can be saved directly within a
SeisComP Data Structure (SDS) or Buffer of Uniform Data (BUD)
(changed option -m, new option -o).
- Improvement: changed HIGHEST_TIMEOUT to 30 seconds in order to
handle the signals whenever data is not coming through.
- Fixed bug: Windows binary distribution now contains
"pthreadVC2.dll" that it has been compiled by MSVC++6.0
* Release 1.2.2 (2008/07/23)
- Added feature: channel list can be printed declaring a pattern
to match the desired channels. (involved options -C, -l, -L)
- Added feature: accept 'telnet' connection for monitoring data
and diagnostic purposes. Not available on Windows yet. (option -E)
- Improved connection management. Exit from program only on request,
that is, receving termination signal or ew-flag-terminate.
- Improved signal handling using safe threads.
- Improved request of channels using a separate thread.
- Improved printing of info about Raw Stream data buffer. (Signal -ALRM).
- Improved function nmxp_openSocket().
- Added 'pluginid' to prefix log messages when launched as Seedlink plug-in.
- Fixed bug: on Solaris system set a time-out using select() and recv()
in order to quit properly the program when any data is received.
* Release 1.2.1 (2008/03/31)
- Improved request of channels in order to retrieve more efficiently
data buffered by the NaqsServer (option -F and -b).
It allows data continuity, to the latency's cost,
when short disconnections to the NaqsServer occur.
Added option --mschan=mSECs/nC, short option -f.
- Added on Windows system, computation of the packet latencies
when timezone is different from GMT/UTC.
- Changed 'configure' options from --with-PACKAGE to --enable-FEATURE.
- Improved signal handling.
- Improved help and documentation.
- Option "delay" can be declared in minutes, hours or days (option -d).
- Fixed bug: before exiting, error message "double free" rarely occurred.
- Fixed bug: on Windows, argument of function Sleep() is in milliseconds.
- Fixed minor bugs.
* Release 1.2.0 (2008/03/07)
- Reorganized structure of directories.
Compilation in a single shot of configure and make.
- Added UserDAP and PassDAP in Earthworm configuration files.
* Release 1.1.8 (2008/03/03)
- Added management of channel sample sequences.
Allow data continuity between program restarts, (option -F)
within time defined by MaxDataToRetrieve (option -A)
and data buffered by the DataServer and NaqsServer.
- Added support for retrieving Data-On-Demand
with minimum delay from NaqsServer (option -T).
- Added option "buffered time" for a single channel (options -b, -B).
- Added ten thousandth of second in date format (option -s, -e).
- Added check for duplication in channel pattern declaration (options -F, -C).
- Added logging of sample values (option -G).
- Option "interval" can be declared in minutes, hours or days (option -t).
- Fixed major bug in DAP authentication (options -u and -p).
- Fixed bug in packet decompression on Big-Endian architecture.
Offset +1 count was added when x0 was greater than zero.
- Countless minor bug fixes and improvements.
* Release 1.1.7 (2007/12/11)
- Added support for WindowsXP and Windows2000 (compilation under MinGW).
- Added support for recompiling earthworm sources when object files are missing.
- Added possibility to define channel list pattern to match all stations.
- Added documentation in README, earthworm/nmxptool_cmd.html, earthworm/nmxptool_ovr.html
- Fixed minor bugs.
* Release 1.1.6 (2007/12/03)
- Added argument to option "-v" in order to configure level of verbosity.
- Changed directory structure. Library directory is under nmxptool directory.
- Made source independent on MSG_WAITALL using a loop.
- Added output of available channels on both NaqsServer and DataServer.
- Fixed a major bug in connection management.
- Fixed bug and improved log message management.
- Fixed minor bugs.
* Release 1.1.5 (2007/10/07)
- First public release.
Installation Instructions
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
2006 Free Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
Briefly, the shell commands `./configure; make; make install' should
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `' (or `') is used to create
`configure' by a program called `autoconf'. You need `' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system.
Running `configure' might take a while. While running, it prints
some messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
Installation Names
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
where SYSTEM can have one of these forms:
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/' if it exists, then
`PREFIX/etc/' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug. Until the bug is fixed you can use this workaround:
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
`configure' Invocation
`configure' recognizes the following options to control how it operates.
Print a summary of the options to `configure', and exit.
Print the version of Autoconf used to generate the `configure'
script, and exit.
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
Alias for `--cache-file=config.cache'.
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
# mtheo
SUBDIRS = lib src
dist_doc_DATA = BUGS HISTORY README earthworm seiscomp_templates makefile.sol makefile.ux doc/html doc/man
ln -f -s ${EWMAKEFILESOL} makefile.sol
ln -f -s ${EWMAKEFILEUX} makefile.ux
rm -rf `find $(distdir)/earthworm -name CVS`
rm -rf `find $(distdir)/seiscomp_templates -name CVS`
rm -rf `find $(distdir)/earthworm -name .svn`
rm -rf `find $(distdir)/seiscomp_templates -name .svn`
rm -rf `find $(distdir)/doc -name CVS`
rm -rf `find $(distdir)/doc -name .svn`
binary_distdir_FILES= \
bin/nmxptool${EXEEXT} \
earthworm/nmxptool.d \
earthworm/nmxptool.desc \
earthworm/nmxptool.list.txt \
earthworm/nmxptool_cmd.html \
earthworm/nmxptool_ovr.html \
binary_distdir_FILES+= bin/${DLL_PTHREAD}
echo ${binary_distdir}
rm -fr bin && mkdir bin && cp src/nmxptool${EXEEXT} bin/
test -f "${DIR_PTHREAD}/${DLL_PTHREAD}" && cp ${DIR_PTHREAD}/${DLL_PTHREAD} bin/
rm -fr ${binary_distdir}
mkdir ${binary_distdir}
${AMTAR} -cf ${TMPTARFILE} ${binary_distdir_FILES}
cd ${binary_distdir} && ${AMTAR} xpf ../${TMPTARFILE}
rm -fr `find ${binary_distdir} -name CVS`
rm -fr `find ${binary_distdir} -name .svn`
${AMTAR} chvf - ${binary_distdir} | GZIP=$(GZIP_ENV) gzip -c > ${binary_distdir}.tar.gz
rm -fr ${binary_distdir}
@echo "example of clean-local"
install-ew-bin: ${NMXPTOOLBINSRC}
test -d "${DIRBINEW}"
test -d "${EW_PARAMS}"
${INSTALL_DATA} 'earthworm/nmxptool.d' '${EW_PARAMS}/nmxptool.d'
${INSTALL_DATA} 'earthworm/nmxptool.desc' '${EW_PARAMS}/nmxptool.desc'
${INSTALL_DATA} 'earthworm/nmxptool.list.txt' '${EW_PARAMS}/nmxptool.list.txt'
test -d "${EW_HOME}/${EW_VERSION}/ewdoc/WEB_DOC/cmd"
${INSTALL_DATA} 'earthworm/nmxptool_cmd.html' '${EW_HOME}/${EW_VERSION}/ewdoc/WEB_DOC/cmd/nmxptool_cmd.html'
test -d "${EW_HOME}/${EW_VERSION}/ewdoc/WEB_DOC/ovr"
${INSTALL_DATA} 'earthworm/nmxptool_ovr.html' '${EW_HOME}/${EW_VERSION}/ewdoc/WEB_DOC/ovr/nmxptool_ovr.html'
install-seiscomp-bin: ${NMXPTOOLBINSRC}
test -d "${SEISCOMPDIRTEMPLATES}/135_nmxptool" || ./install-sh -c -d '${SEISCOMPDIRTEMPLATES}/135_nmxptool'
${INSTALL_DATA} 'seiscomp_templates/135_nmxptool/chain_digiserv_station.tpl' '${SEISCOMPDIRTEMPLATES}/135_nmxptool/chain_digiserv_station.tpl'
${INSTALL_DATA} 'seiscomp_templates/135_nmxptool/chain_digiserv_station_trig.tpl' '${SEISCOMPDIRTEMPLATES}/135_nmxptool/chain_digiserv_station_trig.tpl'
${INSTALL_DATA} 'seiscomp_templates/135_nmxptool/key' '${SEISCOMPDIRTEMPLATES}/135_nmxptool/key'
${INSTALL_DATA} 'seiscomp_templates/135_nmxptool/plugins.ini.tpl' '${SEISCOMPDIRTEMPLATES}/135_nmxptool/plugins.ini.tpl'
${INSTALL_DATA} 'seiscomp_templates/135_nmxptool/seedlink_plugin.tpl' '${SEISCOMPDIRTEMPLATES}/135_nmxptool/seedlink_plugin.tpl'
${INSTALL_DATA} 'seiscomp_templates/135_nmxptool/seedlink_station.tpl' '${SEISCOMPDIRTEMPLATES}/135_nmxptool/seedlink_station.tpl'
test -d "${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod" || ./install-sh -c -d '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod'
${INSTALL_DATA} 'seiscomp_templates/136_nmxptool_dod/chain_digiserv_station.tpl' '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod/chain_digiserv_station.tpl'
${INSTALL_DATA} 'seiscomp_templates/136_nmxptool_dod/chain_digiserv_station_trig.tpl' '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod/chain_digiserv_station_trig.tpl'
${INSTALL_DATA} 'seiscomp_templates/136_nmxptool_dod/key' '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod/key'
${INSTALL_DATA} 'seiscomp_templates/136_nmxptool_dod/plugins.ini.tpl' '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod/plugins.ini.tpl'
${INSTALL_DATA} 'seiscomp_templates/136_nmxptool_dod/seedlink_plugin.tpl' '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod/seedlink_plugin.tpl'
${INSTALL_DATA} 'seiscomp_templates/136_nmxptool_dod/seedlink_station.tpl' '${SEISCOMPDIRTEMPLATES}/136_nmxptool_dod/seedlink_station.tpl'
Matteo Quintiliani - Istituto Nazionale di Geofisica e Vulcanologia - Italy
Mail bug reports and suggestions to <>
nmxptool and libnmxp have been developed for interacting
with NaqsServer and DataServer of Nanometrics Inc.
The Nanometrics servers NaqsServer and DataServer can provide on-line access
to seismic data and state-of-health information accepting TCP/IP connections
and forwarding the requested data to each client program. NaqsServer collates
and stores in near-real-time incoming data in ringbuffers whereas DataServer
provides data of the past stored in NaqsServer ringbuffers. In order to
implement the Nanometrics subscription protocols, the author developed a
software consisting of a library called libnmxp and a tool called nmxptool. The
library exposes a set of documented APIs which allow to communicate with the
Nanometrics servers. The tool, based on libnmxp, allows to retrieve or monitor
real-time data and data of the past.
nmxptool can be used in three different ways:
* stand-alone to monitor data or save retrieved data in mini-seed records
* launched as an Earthworm module to redirect data into the EW-rings
* like a Seed-Link plug-in to feed the SL-server
The main contribute, as regards other similar software, is the capability to
manage Raw Stream connections by buffering and sorting all received packets,
included the retransmitted ones, guaranteeing a good compromise between data
continuity and low latency. Besides, nmxptool allows to retrieve Data-On-Demand
with minimum delay after request. Software is open-source and released under
GNU Library General Public License. It has been written in C language using the
GNU Build Tools (automake, autoconf and configure script) and taking in account
the cross-platform compilation aspects, in fact, it can run on almost all the
Unix-like operating systems, Mac OS X, Windows and either 32-bit or 64-bit
Optional libraries:
* libmseed-2.3 or later:
The Mini-SEED library. A C library framework for manipulating and
managing SEED data records. Author: Chad Trabant, IRIS DMC
* Earthworm 6.2 or later:
* Seedlink, SeisComP -
Seedlink is a system for near real time seismic data distribution.
* POSIX Threads library (pthread)
On Windows, nmxptool has been compiled with "Pthreads-w32 release 2.8.0"
Read section INSTALLATION below.
tar xvfz nmxptool-X.X.X.tar.gz
cd nmxptool-X.X.X
src/nmxptool --version
make install
make install-ew-bin
make install-ew-conf (ONLY THE FIRST TIME)
make install-seiscomp-bin
make install-seiscomp-templates (ONLY THE FIRST TIME)
cp src/nmxptool <where_you_want>
nmxptool --help
For binary installation see section INSTALLATION BINARIES below.
nmxptool and libnmxp have been developed using GNU Build Tools
(automake, autoconf and configure script) taking in account the
POSIX Cross-Platform aspects. So you should be able to compile
and install them everywhere you can launch the following commands:
./configure --enable-FEATURE1 ... VAR1=... VAR2=...
make install
Options for nmxptool 'configure' script:
Disabling optional Features
--disable-libmseed disable saving data in mini-SEED records
--disable-ew do not compile nmxptool as Earthworm module
--disable-seedlink do not compile nmxptool as Seedlink plug-in
Some influential environment variables:
EW_HOME Earthworm home directory
EW_VERSION Earthworm version directory
EW_PARAMS Earthworm configuration files directory
GLOBALFLAGS C compiler flags for Earthworm
'configure' adds -I${EW_HOME}/${EW_VERSION}/include to CFLAGS
* 'configure' tries to compile all features
./configure CFLAGS="-O2 -Wall -pipe -I/<anywhere>/libmseed" \
* Enable only Earthworm feature and set related variables
./configure --disable-libmseed --disable-seedlink \
CFLAGS="-O2 -Wall -pipe" \
EW_HOME="/home/ew" \
EW_VERSION="v7.2" \