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
tar xvfz nmxptool-X.X.X.tar.gzcd nmxptool-X.X.X./configuremakesrc/nmxptool --versionmake install ORmake install-ew-binmake install-ew-conf (ONLY THE FIRST TIME) ORmake install-seiscomp-binmake install-seiscomp-templates (ONLY THE FIRST TIME) ORcp 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:
If available within include and library path,
this library allows to save retrieved data in Mini-SEED records.
You might add to CFLAGS this "-I/<anywhere>/libmseed"
and to LDFLAGS this "-L/<anywhere>/libmseed",
do not forget to run 'ranlib libmseed.a' or similars.
nmxptool is included into the official Earthworm distribution since the version 7.2.
Anyway, you can compile nmxptool outside the EW distribution, for example, to upgrade.
Before launching 'configure', run the appropriate script from directory 'environment', the compilation depends on the following environment variables:
'configure' looks for necessary Earthworm object files inside $EW_HOME/$EW_VERSION/lib
and link them to nmxptool in order to enable Earthworm module feature.
If some of object files are missing then it will attempt to discover sources
dependents on your operating system and it will compile them before linking.
Install binary and configuration files for Earthworm:
make install-ew-binmake install-ew-conf (ONLY THE FIRST TIME)
The first command copies nmxptool binary in $EW_HOME/$EW_VERSION/bin
The second command copies earthworm/nmxptool.d, earthworm/nmxptool.desc in $EW_PARAMS
If you are upgrading nmxptool then you might do that:
Last command copies nmxptool_ovr.html and nmxptool_cmd.html into the directories
$EW_HOME/$EW_VERSION/ewdoc/WEB_DOC/ovr and $EW_HOME/$EW_VERSION/ewdoc/WEB_DOC/cmd
Seedlink is a system for near real time seismic data distribution.
Inside the directory 'src' has been copied files
'seedlink_plugin.c' and 'seedlink_plugin.h' from 'plugin.c' and 'plugin.h'
belonging to the SeisComP 2.5 distribution.
If your SeisComP root directory is not equal to /home/sysop/seiscomp,
you have to launch the script 'configure' in the following way:
Inside the same directory 'earthworm' are also available the documentation html files nmxptool_cmd.html and nmxptool_ovr.html
Download http://mednet.rm.ingv.it/downloads/soft/nmxptool-2.1.0-bin-i686-pc-mingw32.zipUnzip the file.Copy the files nmxptool.exe and pthreadVC2.dll where you want.
SUPPORTED PLATFORMS AND 64-Bit ISSUES
nmxptool 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 architectures.
nmxptool has been successfully compiled and tested on the following operating systems and architectures:
------------------------------------------------- | | Intel Intel PowerPC SPARC | | | 32-bit 64-bit 32-bit 64-bit | |-------------------------------------------------| | Linux | X X | | Solaris | X X X | | Mac OS X | X X | | FreeBSD | X | | Windows | X | -------------------------------------------------
N.B. No test has been done on Earthworm when nmxptool is compiled with 64-bit option (-m64)
Data continuity when short disconnections to NaqsServer occur
Inside the section Datastream of the file Naqs.ini set DataBufferLength to a high value.
[ Datastream ] Port = 28000 // TCP port for control/data connections to Naqs Password = none // access password (not used in version 1.3) MaxConnections = 10 // maximum number of simultaneous connections SocketType = Direct // connection type (Direct or Callback) DataBufferLength = 100 // Buffer length for data channels (# packets)
Inside the section NetworkInterface of the file Naqs.ini enable RetxRequest.
If RetxRequest is not enabled then MaxTolerableLatency is ineffective.
[ NetworkInterface ] Port = 32000 // UDP port for incoming NMX data (usually 32000) SendDelay = 250 // milliseconds to delay after each send RetxRequest = EnabledMulticastGroup = 188.8.131.52
Signals INT QUIT TERM : Sending these signals to nmxptool causes it to immediately attempt to gracefully terminate. It may take several seconds to complete exiting.Signal ALRM : Print current info about Raw Stream buffer.Signal USR1 : Force to close a connection and open again without quitting the program. Only for connection in near real-time to NaqsServer.Signals HUP PIPE : Ignored. (SIG_IGN)
Read file HISTORY for release notes.
In no particular order:
Stefano Pintore - INGV (Istituto Nazionale di Geofisica e Vulcanologia)
Salvatore Mazza - INGV
Marco Olivieri - INGV
Luigi Falco - INGV
Paul Friberg - ISTI (Instrumental Software Technologies, Inc.)
Efthimios Sokos - (University of Patras - Greece)
Roman Racine - (ETH Zurich - Swiss Seismological Service)
Jean-Marie Saurel - (Institut de Physique du Globe de Paris)
Chad Trabant - IRIS (Incorporated Research Institutions for Seismology)
Sandy Stromme - IRIS
Software is open-source and released under GNU Library General Public License.