SeisComP modules¶
Scope¶
This document describes the difference between command-line and daemon modules.
Overview¶
SeisComP is not a single executable but it provides a set of modules which can be
A module is configured by its configuration files either to be used directly or to generate its native configuration. Modules that need to convert the configuration or do not use the default configuration options (see below) are called standalone modules. All other modules are called trunk modules.
Examples for standalone modules are seedlink, slarchive and slmon.
Command-Line Tools¶
Command-line modules can be executed on demand from the SHELL command-line. These modules can be utilities or GUIs, e.g.
seiscomp exec scolv [options]
scolv [options]
Command-line modules are found in $SEISCOMP_ROOT/bin but they are NOT listed when executing
seiscomp list modules
Using options like -h the list of available command-line options can be learned. Debugging information can be obtained during runtime using the –debug option:
scbulletin -h
scbulletin --debug [more options]
Note
In order to execute modules without seiscomp exec, the SeisComP environment variable must be known to the system. The environment variables and their values can be printed giving the full path to the seiscomp script:, e.g.
/home/sysop/seiscomp/bin/seiscomp print env
Daemon Tools¶
Daemon tools can run in the background, e.g. for automatic data acquisition or processing. The names of all daemon modules are listed when executing
seiscomp list modules
Daemon modules can be started to run in the background:
seiscomp start scautopick
When starting a daemon module all verbosity output is stored in @LOGDIR@ or $SEISCOMP_ROOT/var/log. Daemon modules can also be executed as command-line tools.
Configuration¶
Each standalone module tries to read from three configuration files whereas trunk modules try to read the six files. Note that configuration parameters defined earlier are overwritten if defined in files read in later:
File |
Standalone |
Trunk |
|---|---|---|
$SEISCOMP_ROOT/etc/defaults/global.cfg |
X |
|
$SEISCOMP_ROOT/etc/defaults/module.cfg |
X |
X |
$SEISCOMP_ROOT/etc/global.cfg |
X |
|
$SEISCOMP_ROOT/etc/module.cfg |
X |
X |
~/.seiscomp/global.cfg |
X |
|
~/.seiscomp/module.cfg |
X |
X |
The configuration section describes all available configuration parameters for a trunk module. Not all modules make use of all available parameters because they may be disabled, e.g., the messaging component. So the configuration of the messaging server is disabled too.
The concept section Configuration provides more details about configurations.
Alias Modules¶
Many trunk and standalone modules allow generating aliases as symbolic links to another module. These aliases are useful for running multiple instances of the same module with different configuration.
Alias modules can be created using the seiscomp script by providing the
options alias create along with the name of the alias and the
corresponding module. Example:
seiscomp alias create l1autopick scautopick
where l1autopick is the alias name and scautopick is the name of the corresponding linked module.
Warning
The length of alias names for modules considering bindings is strictly limited to 20 characters.
Alias modules provide the same module and bindings configuration parameters as the linked module and they must be configured separately.
Alias modules can be removed along with generated links. Example:
seiscomp alias remove l1autopick
Without further options, module and bindings configurations will be preserved.
These configurations can be interactively removed using --interactive.
Example:
seiscomp --interactive alias remove l1autopick
