SeisComP3 event exchange between two systems.
scimex manages the SC3 object exchange between two or more different SeisComP3 systems in real time. scimex may import or export the data to one or several systems. In contrary to scimport the exchange of the SC3 objects is event based. This means no messages will be exchanged until the exporting system has produced an event.
By default all objects (picks, amplitudes, origins, arrivals, station magnitudes, magnitudes, magnitude references) are transferred to the other system. The user can define filters at both the sender and the receiver, to limit the events for which objects are transferred. Possible filter parameters are the event location, magnitude, arrival count and agency. scimex supports two modi: import and export. In export mode scimex collects all objects relevant for an event (e.g. picks, amplitudes, origins, magnitudes) from scmaster's message groups at the source and checks if the filter criteria match. Once the criteria are fulfilled, the whole package of objects is send to the scmaster IMPORT group of the receiving system.
At the receiving SC3 system an instance of scimex runs in import mode. It fetches the whole event information from its own IMPORT group, checks the local filter criteria of the system and sends the collected objects to the different message groups, e.g. Pick, Amplitude, Magnitude, Location. In export mode several recipients can be defined and for each recipient individual filters can be set. To run several instances of scimex on one system, aliases have to be defined, e.g. for import:
seiscomp alias create scimex_import scimex
and for export:
seiscomp alias create scimex_export scimex
Then the configuration can be split into scimex_import.cfg and scimex_export.cfg.
For a push-type configuration, in which the exporting server must be able to connect to the Spread server on the receiving host. On the receiving host:
scimex_import.cfg
connection.username = scimexIm
connection.server = localhost
mode = IMPORT
cleanupinterval = 86400
importHosts = import1
criteria.world.longitude = -180:180
criteria.world.latitude = -90:90
criteria.world.magnitude = 1:9
criteria.world.agencyID = ""
criteria.world.arrivalcount = 15
hosts.import1.address = localhost
# The criterion "world" has been defined above
hosts.import1.criteria = world
# optional and true per default
hosts.import1.filter = false
# optional and true per default
hosts.import1.useDefinedRoutingTable = true
hosts.import1.routingtable = Pick:IMPORT,StationAmplitude:IMPORT,
Origin:LOCATION,Arrival:LOCATION,
StationMagnitude:MAGNITUDE,
Magnitude:MAGNITUDE,
StationMagnitudeContribution:MAGNITUDE,
OriginReference:EVENT,Event:EVENT
In this example, Pick and StationAmplitude objects are sent to the receiving system's IMPORT group to avoid interfering with the receiving system's picking.
On the sending system, only those events with a high enough magnitude and enough arrivals, and with the AgencyID "GFZ" are exported: scimex_export.cfg
connection.username="scimexEx"
connection.server = localhost
mode = EXPORT
cleanupinterval = 7200
exportHosts = exp1, exp2
# Match everything with magnitude above or equal 5
# and with more than 25 phases which comes from
# agency GFZ.
criteria.globalM5.latitude = -90:90
criteria.globalM5.longitude = -180:180
criteria.globalM5.magnitude = 5:10
criteria.globalM5.arrivalcount = 25
criteria.globalM5.agencyID = GFZ
# Export to a system which still runs a very old version. The
# messages need to be converted.
hosts.exp1.address = 192.168.0.3
hosts.exp1.criteria = globalM5
hosts.exp1.conversion = imexscdm0.51
hosts.exp2.address = 192.168.0.4
hosts.exp2.criteria = globalM5
scimex inherits global options.
Type: string
Mode of operation. Options are IMPORT or EXPORT.
Type: double
Cache lifetime for objects.
Type: list:string
Only used in export mode. A list of message groups to subscribe.
Type: string
Used only in import mode. It defines the source format of the messages that need to be converted. Currently the import of SeisComP3 datamodel version 0.51 (imexscdm0.51) is supported which was used in release Barcelona (2008).
Type: string
A list of names of recipients. These are used in hosts.$name directives (see below) to define addresses, filter criteria, etc. applicable to each recipient.
Type: string
List of names of suppliers from which to export. These are used with hosts.$name directives similarly to exportHosts.
Note
criteria.$name.* A definition of an event filter. $name is a placeholder for the name to be used.
Type: tuple:double
Pair of doubles that defines the latitude range, e.g. -90:90.
Type: tuple:double
Pair of doubles that defines the longitude range, e.g. -180:180.
Type: tuple:double
Pair of doubles that defines the magnitude range, e.g. 3:10.
Type: int
Number of minimum arrivals.
Type: list:string
White list of AgencyIDs (the agency identifier which appears in the objects sent over the export-import link).
Note
hosts.$name.* A sink definition used for either import or export. $name is a placeholder for the name to be used.
Type: string
Address of a sink, as a host name with an optional port number e.g. 'address = 192.168.1.1' or 'address = somewhere.com:4803'
Type: string
Defining filter criteria name for sink, e.g. criteria = world-xxl. The criteria must be defined in the criteria.* configuration lines.
Type: boolean
Enables/disables filtering based on defined criteria. If set to false, all events will pass, even if one or more criteria are defined. Default is true.
Type: string
Optional target format for export.
Type: boolean
Enables/disables defined routing tables. Default is false.
Type: list:string
Defining routing tables in the meaning of mapping objects to message groups. E.g. Pick:NULL, StationAmplitude:NULL, Origin:LOCATION, StationMagnitude: MAGNITUDE, NetworkMagnitude:MAGNITUDE, MagnitudeReference:MAGNITUDE, OriginReference:EVENT, Event:EVENT. Specifying NULL for the message group causes messages to be thrown away/dropped/discarded.
show help message.
show version information
Use alternative configuration file. When this option is used the loading of all stages is disabled. Only the given configuration file is parsed and used. To use another name for the configuration create a symbolic link of the application or copy it, eg scautopick -> scautopick2.
Load given plugins.
Run as daemon. This means the application will fork itself and doesn't need to be started with &.
Enable/disable self-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message (enabled with --start-stop-msg for the master module).
Sets the name of the master-module used for auto-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application.
Sets the name of the master-username of the messaging used for auto-shutdown. If "shutdown-master-module" is given as well this parameter is ignored.
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
Increase verbosity level (may be repeated, eg. -vv)
Quiet mode: no logging output
Limits the logging to a certain component. This option can be given more than once.
Use syslog logging back end. The output usually goes to /var/lib/messages.
Path to lock file.
Send log output to stdout.
Debug mode: --verbosity=4 --console=1
Use alternative log file.
Overrides configuration parameter connection.username.
Overrides configuration parameter connection.server.
Overrides configuration parameter connection.timeout.
Overrides configuration parameter connection.primaryGroup.
A group to subscribe to. This option can be given more than once.
Overrides configuration parameter connection.encoding.
Sets sending of a start- and a stop message.