|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html >
|
|
|
<head>
|
|
|
<meta charset="utf-8" />
|
|
|
<title>SeisComP modules — SeisComP Release documentation</title>
|
|
|
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="../../_static/seiscomp.css" type="text/css" />
|
|
|
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
|
|
|
<script type="text/javascript" src="../../_static/seiscomp.js"></script>
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
|
|
<script src="../../_static/jquery.js"></script>
|
|
|
<script src="../../_static/underscore.js"></script>
|
|
|
<script src="../../_static/doctools.js"></script>
|
|
|
<script src="../../_static/language_data.js"></script>
|
|
|
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
|
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|
|
<link rel="next" title="SeisComP plugins" href="plugins.html" />
|
|
|
<link rel="prev" title="Messaging system" href="messaging.html" />
|
|
|
</head>
|
|
|
<body>
|
|
|
<div class="header">
|
|
|
<div class="container">
|
|
|
<div class="brand">
|
|
|
<img class="logo" src="../../_static/brands/seiscomp/text/white.svg"/>
|
|
|
<!-- span class="title">SeisComP Release</span -->
|
|
|
<span class="version">5.3.0</span>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="nav">
|
|
|
<div class="container">
|
|
|
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<ul>
|
|
|
<li class="right">
|
|
|
<a href="../../genindex.html" title="General Index"
|
|
|
accesskey="I">
|
|
|
index
|
|
|
</a>
|
|
|
</li>
|
|
|
<li class="right">
|
|
|
<a href="plugins.html" title="SeisComP plugins"
|
|
|
accesskey="N">
|
|
|
next
|
|
|
</a>
|
|
|
</li>
|
|
|
<li class="right">
|
|
|
<a href="messaging.html" title="Messaging system"
|
|
|
accesskey="P">
|
|
|
previous
|
|
|
</a>
|
|
|
</li>
|
|
|
<li class="nav-item nav-item-0">
|
|
|
<a href="../../index.html">Home</a>
|
|
|
</li>
|
|
|
<li class="nav-item nav-item-1">
|
|
|
<a href="../concepts.html" accesskey="U">Concepts</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="container">
|
|
|
<div class="fitted content" id="anchors-container">
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
<div class="section" id="seiscomp-modules">
|
|
|
<span id="concepts-modules"></span><h1>SeisComP modules<a class="headerlink" href="#seiscomp-modules" title="Permalink to this headline">¶</a></h1>
|
|
|
<div class="section" id="scope">
|
|
|
<h2>Scope<a class="headerlink" href="#scope" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>This document describes the difference between command-line and daemon modules.</p>
|
|
|
</div>
|
|
|
<div class="section" id="overview">
|
|
|
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>SeisComP is not a single executable but it provides a set of modules which
|
|
|
can be</p>
|
|
|
<ul class="simple">
|
|
|
<li><p><a class="reference internal" href="#concepts-modules-commandline"><span class="std std-ref">Command-line modules</span></a></p></li>
|
|
|
<li><p><a class="reference internal" href="#concepts-modules-daemon"><span class="std std-ref">Daemon modules</span></a>.</p></li>
|
|
|
</ul>
|
|
|
<p>A <a class="reference internal" href="../glossary.html#term-module"><span class="xref std std-term">module</span></a> is <a class="reference internal" href="#concepts-modules-config"><span class="std std-ref">configured by its configuration files</span></a> 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 <a class="reference internal" href="../glossary.html#term-standalone-module"><span class="xref std std-term">standalone modules</span></a>.
|
|
|
All other modules are called <a class="reference internal" href="../glossary.html#term-trunk"><span class="xref std std-term">trunk</span></a> modules.</p>
|
|
|
<p>Examples for standalone modules are <a class="reference internal" href="../../apps/seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a>, <a class="reference internal" href="../../apps/slarchive.html#slarchive"><span class="std std-ref">slarchive</span></a> and <a class="reference internal" href="../../apps/slmon.html#slmon"><span class="std std-ref">slmon</span></a>.</p>
|
|
|
</div>
|
|
|
<div class="section" id="command-line-tools">
|
|
|
<span id="concepts-modules-commandline"></span><h2>Command-line tools<a class="headerlink" href="#command-line-tools" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>Command-line modules can be executed on demand from the SHELL command-line. These
|
|
|
modules can be utilities or <a class="reference internal" href="../glossary.html#term-gui"><span class="xref std std-term">GUIs</span></a>, e.g.</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp <span class="nb">exec</span> scolv <span class="o">[</span>options<span class="o">]</span>
|
|
|
scolv <span class="o">[</span>options<span class="o">]</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>Command-line modules are found in $SEISCOMP_ROOT/bin but they are <strong>NOT</strong> listed
|
|
|
when executing</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp list modules
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>Using options like <em>-h</em> the list of available command-line options can be learned.
|
|
|
Debugging information can be obtained during runtime using the –debug option:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scbulletin -h
|
|
|
scbulletin --debug <span class="o">[</span>more options<span class="o">]</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<div class="admonition note">
|
|
|
<p class="admonition-title">Note</p>
|
|
|
<p>In order to execute modules without <em>seiscomp exec</em>, 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 <em>seiscomp</em> script:, e.g.</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>/home/sysop/seiscomp/bin/seiscomp print env
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="section" id="daemon-tools">
|
|
|
<span id="concepts-modules-daemon"></span><h2>Daemon tools<a class="headerlink" href="#daemon-tools" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>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</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp list modules
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>Daemon modules can be started to run in the background:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp start scautopick
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>When starting a daemon module all verbosity output is stored in @LOGDIR@ or $SEISCOMP_ROOT/var/log.
|
|
|
Daemon modules can also be executed as <a class="reference internal" href="#concepts-modules-commandline"><span class="std std-ref">command-line tools</span></a>.</p>
|
|
|
</div>
|
|
|
<div class="section" id="configuration">
|
|
|
<span id="concepts-modules-config"></span><h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>Each <a class="reference internal" href="../glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> tries to read from three configuration files whereas <a class="reference internal" href="../glossary.html#term-trunk"><span class="xref std std-term">trunk</span></a> modules
|
|
|
try to read the six files. Note that configuration parameters defined earlier are overwritten
|
|
|
if defined in files read in later:</p>
|
|
|
<table class="docutils align-default">
|
|
|
<colgroup>
|
|
|
<col style="width: 54%" />
|
|
|
<col style="width: 20%" />
|
|
|
<col style="width: 26%" />
|
|
|
</colgroup>
|
|
|
<thead>
|
|
|
<tr class="row-odd"><th class="head"><p>File</p></th>
|
|
|
<th class="head"><p>Standalone</p></th>
|
|
|
<th class="head"><p>Trunk</p></th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr class="row-even"><td><p>etc/defaults/global.cfg</p></td>
|
|
|
<td></td>
|
|
|
<td><p>X</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-odd"><td><p>etc/defaults/module.cfg</p></td>
|
|
|
<td><p>X</p></td>
|
|
|
<td><p>X</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td><p>etc/global.cfg</p></td>
|
|
|
<td></td>
|
|
|
<td><p>X</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-odd"><td><p>etc/module.cfg</p></td>
|
|
|
<td><p>X</p></td>
|
|
|
<td><p>X</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td><p>~/.seiscomp/global.cfg</p></td>
|
|
|
<td></td>
|
|
|
<td><p>X</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-odd"><td><p>~/.seiscomp/module.cfg</p></td>
|
|
|
<td><p>X</p></td>
|
|
|
<td><p>X</p></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p>The <a class="reference internal" href="../../apps/global.html#global-configuration"><span class="std std-ref">configuration section</span></a> 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.</p>
|
|
|
<p>The concept section <a class="reference internal" href="configuration.html#concepts-configuration"><span class="std std-ref">Configuration</span></a> provides more details
|
|
|
about configurations.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
<div id="anchors-bottom"></div>
|
|
|
</div>
|
|
|
|
|
|
<div class="sidebar" role="navigation" aria-label="main navigation">
|
|
|
<div id="anchors-top"></div>
|
|
|
<div id="anchors" class="content">
|
|
|
<div id="searchbox" style="display: none" role="search">
|
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
|
<div class="searchformwrapper">
|
|
|
<form class="search" action="../../search.html" method="get">
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
|
<input type="submit" value="Go" />
|
|
|
</form>
|
|
|
</div>
|
|
|
</div>
|
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
<h3><a href="../../index.html">Table of Contents</a></h3>
|
|
|
<ul>
|
|
|
<li><a class="reference internal" href="#">SeisComP modules</a><ul>
|
|
|
<li><a class="reference internal" href="#scope">Scope</a></li>
|
|
|
<li><a class="reference internal" href="#overview">Overview</a></li>
|
|
|
<li><a class="reference internal" href="#command-line-tools">Command-line tools</a></li>
|
|
|
<li><a class="reference internal" href="#daemon-tools">Daemon tools</a></li>
|
|
|
<li><a class="reference internal" href="#configuration">Configuration</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
|
|
|
<h4>Previous topic</h4>
|
|
|
<p class="topless"><a href="messaging.html"
|
|
|
title="previous chapter">Messaging system</a></p>
|
|
|
<h4>Next topic</h4>
|
|
|
<p class="topless"><a href="plugins.html"
|
|
|
title="next chapter">SeisComP plugins</a></p>
|
|
|
<div role="note" aria-label="source link">
|
|
|
<h3>This Page</h3>
|
|
|
<ul class="this-page-menu">
|
|
|
<li><a href="../../_sources/base/concepts/modules.rst.txt"
|
|
|
rel="nofollow">Show Source</a></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="footer">
|
|
|
<div class="container">
|
|
|
<div class="horizontal layout content">
|
|
|
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
|
|
<img class="brand" src="../../_static/brands/gempa.svg"/>
|
|
|
</a>
|
|
|
<div class="stretched align-center fitted content">
|
|
|
<div>
|
|
|
Version <b>5.3.0</b> Release
|
|
|
</div>
|
|
|
<div class="copyright">
|
|
|
Copyright © gempa GmbH, GFZ Potsdam.
|
|
|
</div>
|
|
|
</div>
|
|
|
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
|
|
<img class="brand" src="../../_static/brands/gfz.svg"/>
|
|
|
</a>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</body>
|
|
|
</html> |