[seiscomp, scanloc] Install, add .gitignore

This commit is contained in:
2025-10-09 15:07:02 +02:00
commit 20f5301bb1
2848 changed files with 1315858 additions and 0 deletions

View File

@@ -0,0 +1,193 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>access &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="msrtsimul" href="msrtsimul.html" />
<link rel="prev" title="Acquisition" href="../toc/acquisition.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">6.9.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="msrtsimul.html" title="msrtsimul"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/acquisition.html" title="Acquisition"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="access">
<span id="id1"></span><h1>access<a class="headerlink" href="#access" title="Permalink to this heading"></a></h1>
<p><strong>Access module for FDSNWS.</strong></p>
<section id="bindings-parameters">
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>access.*</strong>
<em>Defines access to restricted data. When defined it will add the listed users to the list of authorized users to access certain restricted data give the parameters on this binding.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-access.users">
<span class="sig-name descname"><span class="pre">access.users</span></span><a class="headerlink" href="#confval-access.users" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of users (e-mail addresses) allowed to access the restricted data.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-access.disableStationCode">
<span class="sig-name descname"><span class="pre">access.disableStationCode</span></span><a class="headerlink" href="#confval-access.disableStationCode" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>When disableStationCode option is set to true the access entries will be generated only for the network level (and optionally stream level), no station code will be filled (this can potentially reduce the number of entries on the access table, and save memory on the request handler when used).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-access.streams">
<span class="sig-name descname"><span class="pre">access.streams</span></span><a class="headerlink" href="#confval-access.streams" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of locations.streams this access rule applies to. The location code is optional (optional, allow wildcards).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-access.start">
<span class="sig-name descname"><span class="pre">access.start</span></span><a class="headerlink" href="#confval-access.start" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>datetime</em></p>
<p>Start of validity (optional).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-access.end">
<span class="sig-name descname"><span class="pre">access.end</span></span><a class="headerlink" href="#confval-access.end" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>datetime</em></p>
<p>End of validity (optional).</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">access</a><ul>
<li><a class="reference internal" href="#bindings-parameters">Bindings Parameters</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/acquisition.html"
title="previous chapter">Acquisition</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="msrtsimul.html"
title="next chapter">msrtsimul</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/access.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,443 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>bindings2cfg &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="fdsnws" href="fdsnws.html" />
<link rel="prev" title="Utilities" href="../toc/utilities.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">6.9.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="fdsnws.html" title="fdsnws"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/utilities.html" title="Utilities"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="bindings2cfg">
<span id="id1"></span><h1>bindings2cfg<a class="headerlink" href="#bindings2cfg" title="Permalink to this heading"></a></h1>
<p><strong>Synchronize key files with configuration database or convert them to
configuration XML.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>bindings2cfg dumps the bindings configuration from a specific key directory
to the given database or a configuration XML. In this way, the bindings parameters
can be configured in a directory different from $SEISCOMP_ROOT/etc/. From this
non-standard directory the configuration XML can be created without
prior writing the bindings to a database and reading from there using e.g.
<a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a>.</p>
<p>This utility is useful for repeating parameter tuning.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Write the bindings configuration from some key directory to a configuration
XML file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>bindings2cfg<span class="w"> </span>--key-dir<span class="w"> </span>./etc/key<span class="w"> </span>-o<span class="w"> </span>config.xml
</pre></div>
</div>
</li>
<li><p>Write the bindings configuration from some key directory to the seiscomp
database on localhost</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>bindings2cfg<span class="w"> </span>--key-dir<span class="w"> </span>./etc/key<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="bindings2cfg-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/bindings2cfg.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/bindings2cfg.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/bindings2cfg.cfg</span></code></div>
</div>
<p>bindings2cfg inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">bindings2cfg [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-h">
<span id="cmdoption-bindings2cfg-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-V">
<span id="cmdoption-bindings2cfg-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-D">
<span id="cmdoption-bindings2cfg-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-v">
<span id="cmdoption-bindings2cfg-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-q">
<span id="cmdoption-bindings2cfg-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-s">
<span id="cmdoption-bindings2cfg-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-l">
<span id="cmdoption-bindings2cfg-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-d">
<span id="cmdoption-bindings2cfg-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-config-db">
<span class="sig-name descname"><span class="pre">--config-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-config-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the configuration from the given database or file,
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-u">
<span id="cmdoption-bindings2cfg-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-H">
<span id="cmdoption-bindings2cfg-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-t">
<span id="cmdoption-bindings2cfg-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-g">
<span id="cmdoption-bindings2cfg-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-S">
<span id="cmdoption-bindings2cfg-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-key-dir">
<span class="sig-name descname"><span class="pre">--key-dir</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-key-dir" title="Permalink to this definition"></a></dt>
<dd><p>Override the location of the default key directory,
which is $SEISCOMP_ROOT/etc/key .</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-o">
<span id="cmdoption-bindings2cfg-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-bindings2cfg-o" title="Permalink to this definition"></a></dt>
<dd><p>If given, an output XML file is generated. Use - for
stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-bindings2cfg-create-notifier">
<span class="sig-name descname"><span class="pre">--create-notifier</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-bindings2cfg-create-notifier" title="Permalink to this definition"></a></dt>
<dd><p>If given then a notifier message containing all notifiers
will be written to the output XML. This option only applies
if an output file is given. Notifier creation either requires
and input database and an input config XML as reference.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">bindings2cfg</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/utilities.html"
title="previous chapter">Utilities</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="fdsnws.html"
title="next chapter">fdsnws</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/bindings2cfg.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,194 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>diskmon &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="kernel" href="kernel.html" />
<link rel="prev" title="System" href="../toc/system.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">6.9.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="kernel.html" title="kernel"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/system.html" title="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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/system.html" accesskey="U">System</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="diskmon">
<span id="id1"></span><h1>diskmon<a class="headerlink" href="#diskmon" title="Permalink to this heading"></a></h1>
<p><strong>Monitors a disk and sends notifications.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Diskmon is a SeisComP init script that checks on each call to <strong class="program">seiscomp check</strong>
the filesystem by running the following command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>df<span class="w"> </span><span class="p">|</span><span class="w"> </span>awk<span class="w"> </span>-v<span class="w"> </span><span class="nv">max</span><span class="o">=</span><span class="s2">&quot;%d&quot;</span><span class="w"> </span><span class="se">\&#39;</span><span class="o">{</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="w"> </span><span class="nv">$5</span><span class="w"> </span>&gt;<span class="w"> </span>max<span class="w"> </span><span class="o">)</span><span class="w"> </span>print<span class="w"> </span><span class="nv">$0</span><span class="w"> </span><span class="o">}</span><span class="se">\&#39;</span>
</pre></div>
</div>
<p>where “%d” is replaced by the configured threshold. If there are lines in the
output (which means some filesystem exceed the usage threshold) it sends
the output along with a description line to all configured receipients using
the <strong class="program">mail</strong> command.</p>
<p>To make diskmon work it is important that <strong class="program">mail</strong> is working on the shell.</p>
</section>
<section id="module-configuration">
<span id="diskmon-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>diskmon is a <a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> and does not inherit <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</div>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/diskmon.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/diskmon.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/diskmon.cfg</span></code></div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-threshold">
<span class="sig-name descname"><span class="pre">threshold</span></span><a class="headerlink" href="#confval-threshold" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">95</span></code></p>
<p>Type: <em>int</em></p>
<p>Disk usage threshold in percent. Each time when the disk usage exceeds this level,
an alert e-mail is send to the user. Note that disk usage is only checked when a
cron job of seiscomp check is installed or seiscomp check is called
regularly by other means.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-emails">
<span class="sig-name descname"><span class="pre">emails</span></span><a class="headerlink" href="#confval-emails" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Comma-separated list of e-mail addresses to notify when disk usage
threshold is exceeded.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">diskmon</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/system.html"
title="previous chapter">System</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="kernel.html"
title="next chapter">kernel</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/diskmon.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,391 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>dlsv2inv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="fdsnxml2inv" href="fdsnxml2inv.html" />
<link rel="prev" title="Inventory" href="../toc/inventory.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">6.9.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="fdsnxml2inv.html" title="fdsnxml2inv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/inventory.html" title="Inventory"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="dlsv2inv">
<span id="id1"></span><h1>dlsv2inv<a class="headerlink" href="#dlsv2inv" title="Permalink to this heading"></a></h1>
<p><strong>Convert dataless SEED to SeisComP inventory XML.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>dlsv2inv converts dataless <a class="reference external" href="http://www.iris.edu/data/dataless.htm">SEED</a> to
SeisComP XML (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>). Due to the limitations of dataless SEED dlsv2inv allows to set
attributes which are not available in dataless such as network type, network
description and so on.</p>
<p>It takes basically two important parameters:</p>
<ol class="arabic simple">
<li><p>input file</p></li>
<li><p>output file</p></li>
</ol>
<p>whereas the output file defaults to stdout if not given.</p>
<p>The SeisComP inventory network and station objects have the attribute archive
which should contain the local datacenter where the information comes from.</p>
<p>While importing the attribute <a class="reference internal" href="global.html#confval-datacenterID"><code class="xref std std-confval docutils literal notranslate"><span class="pre">datacenterID</span></code></a> is read and written into
the archive attribute of all networks and stations available in the dataless.
The datacenterID can be overridden with the <code class="docutils literal notranslate"><span class="pre">--dcid</span></code> command-line option.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Conversion of inventory in <cite>SeisComP</cite> XML to dataless SEED is provided by <a class="reference internal" href="inv2dlsv.html#inv2dlsv"><span class="std std-ref">inv2dlsv</span></a>.</p>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Convert a given dataless SEED file to SeisComP XML.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>dlsv2inv<span class="w"> </span>GE.dataless<span class="w"> </span>GE.xml
</pre></div>
</div>
</li>
<li><p>Override the datacenterID and leave it blank in the output.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>dlsv2inv<span class="w"> </span>--dcid<span class="w"> </span><span class="s2">&quot;&quot;</span><span class="w"> </span>GE.dataless<span class="w"> </span>GE.xml
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="dlsv2inv-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/dlsv2inv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/dlsv2inv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/dlsv2inv.cfg</span></code></div>
</div>
<p>dlsv2inv inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">dlsv2inv [OPTIONS] input [output=stdout]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-h">
<span id="cmdoption-dlsv2inv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-V">
<span id="cmdoption-dlsv2inv-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-D">
<span id="cmdoption-dlsv2inv-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-v">
<span id="cmdoption-dlsv2inv-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-q">
<span id="cmdoption-dlsv2inv-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-s">
<span id="cmdoption-dlsv2inv-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-l">
<span id="cmdoption-dlsv2inv-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="arclink">
<h3>ArcLink<a class="headerlink" href="#arclink" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-dcid">
<span class="sig-name descname"><span class="pre">--dcid</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-dcid" title="Permalink to this definition"></a></dt>
<dd><p>Override the datacenter ID which is read from the
datacenterID configuration parameter and written to the
network and station archive attribute.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-net-description">
<span class="sig-name descname"><span class="pre">--net-description</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-net-description" title="Permalink to this definition"></a></dt>
<dd><p>Set the network description. It supports the following
placeholders: ${code}, ${start}, ${end}, ${class} and
${archive}.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-net-start">
<span class="sig-name descname"><span class="pre">--net-start</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-net-start" title="Permalink to this definition"></a></dt>
<dd><p>Set network start time. Format is %Y-%m-%d.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-net-end">
<span class="sig-name descname"><span class="pre">--net-end</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-net-end" title="Permalink to this definition"></a></dt>
<dd><p>Set network end time. Format is %Y-%m-%d.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-net-type">
<span class="sig-name descname"><span class="pre">--net-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dlsv2inv-net-type" title="Permalink to this definition"></a></dt>
<dd><p>Set the network type (VBB, SM, etc.).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-temporary">
<span class="sig-name descname"><span class="pre">--temporary</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-temporary" title="Permalink to this definition"></a></dt>
<dd><p>Set the network temporary flag to true.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-restricted">
<span class="sig-name descname"><span class="pre">--restricted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-restricted" title="Permalink to this definition"></a></dt>
<dd><p>Set the network restricted flag to true.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-private">
<span class="sig-name descname"><span class="pre">--private</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-private" title="Permalink to this definition"></a></dt>
<dd><p>Set the network private flag to true.</p>
</dd></dl>
</section>
<section id="convert">
<h3>Convert<a class="headerlink" href="#convert" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dlsv2inv-f">
<span id="cmdoption-dlsv2inv-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dlsv2inv-f" title="Permalink to this definition"></a></dt>
<dd><p>Enable formatted XML output.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">dlsv2inv</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#arclink">ArcLink</a></li>
<li><a class="reference internal" href="#convert">Convert</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/inventory.html"
title="previous chapter">Inventory</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="fdsnxml2inv.html"
title="next chapter">fdsnxml2inv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/dlsv2inv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,524 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ew2sc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scamp" href="scamp.html" />
<link rel="prev" title="Processing" href="../toc/processing.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">6.9.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="scamp.html" title="scamp"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/processing.html" title="Processing"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/processing.html" accesskey="U">Processing</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ew2sc">
<span id="id1"></span><h1>ew2sc<a class="headerlink" href="#ew2sc" title="Permalink to this heading"></a></h1>
<p><strong>Earthworm hypo2000_arc messages importer</strong></p>
<section id="module-configuration">
<span id="ew2sc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/ew2sc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/ew2sc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/ew2sc.cfg</span></code></div>
</div>
<p>ew2sc inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.configPath">
<span class="sig-name descname"><span class="pre">ew2sc3.configPath</span></span><a class="headerlink" href="#confval-ew2sc3.configPath" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Folder to store logs and achives of hypo2000_arc files from Earthworm export_genericer</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.senderPort">
<span class="sig-name descname"><span class="pre">ew2sc3.senderPort</span></span><a class="headerlink" href="#confval-ew2sc3.senderPort" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Earthworm export_generics socket to listen to</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.modID">
<span class="sig-name descname"><span class="pre">ew2sc3.modID</span></span><a class="headerlink" href="#confval-ew2sc3.modID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Expected Earthworm Module ID (ew2sc3 will read the message only if its ModID is correct).
Set to 0 (MOD_WILDCARD) to accept any Earthworm Module ID.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.instID">
<span class="sig-name descname"><span class="pre">ew2sc3.instID</span></span><a class="headerlink" href="#confval-ew2sc3.instID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Expected Earthworm Institute ID (ew2sc3 will read the message only if its InstID is correct)
Set to 0 (INST_WILDCARD) to accept any Earthworm Institute ID.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.customAgencyID">
<span class="sig-name descname"><span class="pre">ew2sc3.customAgencyID</span></span><a class="headerlink" href="#confval-ew2sc3.customAgencyID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Institute name to use when storing origin into database.
If blank, the origin will have the system AgencyID. If specified, the origin will have the given AgencyID.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.author">
<span class="sig-name descname"><span class="pre">ew2sc3.author</span></span><a class="headerlink" href="#confval-ew2sc3.author" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Author name to use when storing origin into database.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.hostname">
<span class="sig-name descname"><span class="pre">ew2sc3.hostname</span></span><a class="headerlink" href="#confval-ew2sc3.hostname" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Earthworm export_generic IP address to connect to</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.defaultLatitude">
<span class="sig-name descname"><span class="pre">ew2sc3.defaultLatitude</span></span><a class="headerlink" href="#confval-ew2sc3.defaultLatitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Default event latitude to use if hypo2000_arc location is null (space filled)</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.defaultLongitude">
<span class="sig-name descname"><span class="pre">ew2sc3.defaultLongitude</span></span><a class="headerlink" href="#confval-ew2sc3.defaultLongitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Default event longitude to use if hypo2000_arc location is null (space filled)</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.locatorProfile">
<span class="sig-name descname"><span class="pre">ew2sc3.locatorProfile</span></span><a class="headerlink" href="#confval-ew2sc3.locatorProfile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Name of the earth model used by Earthworm location process</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.enableArchiving">
<span class="sig-name descname"><span class="pre">ew2sc3.enableArchiving</span></span><a class="headerlink" href="#confval-ew2sc3.enableArchiving" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>boolean</em></p>
<p>Enable/Disable hypo2000_arc message file archiving (usefull for troobleshooting)</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.myAliveInt">
<span class="sig-name descname"><span class="pre">ew2sc3.myAliveInt</span></span><a class="headerlink" href="#confval-ew2sc3.myAliveInt" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Time interval (in sec) between two heartbeats messages sent by SeisComP.
This parameter should be lower than Earthworm export_generic RcvAliveInt parameter</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.senderTimeout">
<span class="sig-name descname"><span class="pre">ew2sc3.senderTimeout</span></span><a class="headerlink" href="#confval-ew2sc3.senderTimeout" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Maximum time (in millisecond) before the connection to Earthworm export_generic times out.
This parameter has to be set accordingly to Earthworm export_generic parameters</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.maxMsgSize">
<span class="sig-name descname"><span class="pre">ew2sc3.maxMsgSize</span></span><a class="headerlink" href="#confval-ew2sc3.maxMsgSize" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Maximum message size (in char) between the Earthworm export_generic and ew2sc3.
This parameter has to be set accordingly to Earthworm export_generic MaxMsgSize parameter</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.myAliveString">
<span class="sig-name descname"><span class="pre">ew2sc3.myAliveString</span></span><a class="headerlink" href="#confval-ew2sc3.myAliveString" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Alive string to send to Earthworm export_generic in order to keep the connection alive.
This string should be identical as Earthworm export_generic RcvAliveText string</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.senderAliveString">
<span class="sig-name descname"><span class="pre">ew2sc3.senderAliveString</span></span><a class="headerlink" href="#confval-ew2sc3.senderAliveString" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Alive string expected from Earthworm export_generic in order to keep the connection alive.
This string should be identical as Earthworm export_generic SendAliveText string</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.enableUncertainties">
<span class="sig-name descname"><span class="pre">ew2sc3.enableUncertainties</span></span><a class="headerlink" href="#confval-ew2sc3.enableUncertainties" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>boolean</em></p>
<p>Enable/Disable uncertainties conversions.
Earthworm doesnt have uncertainties but weight from 0 to 4.
If enabled, ew2sc3 will convert pick weight to uncertainties followind a simple mapping between weight and pickerUncertainties list.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.pickerUncertainties">
<span class="sig-name descname"><span class="pre">ew2sc3.pickerUncertainties</span></span><a class="headerlink" href="#confval-ew2sc3.pickerUncertainties" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:double</em></p>
<p>Uncertainty values (in sec) to use when enableUncertainties is enabled.
Refer to scolv document for syntax.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ew2sc3.maxUncertainty">
<span class="sig-name descname"><span class="pre">ew2sc3.maxUncertainty</span></span><a class="headerlink" href="#confval-ew2sc3.maxUncertainty" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>Maximum weight value from Earthworm corresponding to maximum uncertainty</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-h">
<span id="cmdoption-ew2sc-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-V">
<span id="cmdoption-ew2sc-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-D">
<span id="cmdoption-ew2sc-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-v">
<span id="cmdoption-ew2sc-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-q">
<span id="cmdoption-ew2sc-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-s">
<span id="cmdoption-ew2sc-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-l">
<span id="cmdoption-ew2sc-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-u">
<span id="cmdoption-ew2sc-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-H">
<span id="cmdoption-ew2sc-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-t">
<span id="cmdoption-ew2sc-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-g">
<span id="cmdoption-ew2sc-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-S">
<span id="cmdoption-ew2sc-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-d">
<span id="cmdoption-ew2sc-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ew2sc-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ew2sc-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ew2sc-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ew2sc</a><ul>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/processing.html"
title="previous chapter">Processing</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scamp.html"
title="next chapter">scamp</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/ew2sc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,344 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>fdsnxml2inv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="import_inv" href="import_inv.html" />
<link rel="prev" title="dlsv2inv" href="dlsv2inv.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">6.9.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="import_inv.html" title="import_inv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="dlsv2inv.html" title="dlsv2inv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="fdsnxml2inv">
<span id="id1"></span><h1>fdsnxml2inv<a class="headerlink" href="#fdsnxml2inv" title="Permalink to this heading"></a></h1>
<p><strong>Convert station inventory between FDSN StationXML format and
SeisComP XML.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>fdsnws2inv is an inventory converter. It converts station meta data from
FDSN StationXML format to SeisComP XML (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>) and back writing the
output to a file, if given, or the command line (stdout).</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Convert an inventory file in FDSN StationXML format to SCML with formatted XML.
Redirect the output to a new file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>fdsnxml2inv<span class="w"> </span>-f<span class="w"> </span>inventory_fdsn.xml<span class="w"> </span>inventory_sc.xml
</pre></div>
</div>
</li>
<li><p>Convert an inventory file in SCML format to FDSN StationXML with formatted XML.
Redirect the output to a new file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>fdsnxml2inv<span class="w"> </span>--to-staxml<span class="w"> </span>-f<span class="w"> </span>inventory_sc.xml<span class="w"> </span>inventory_fdns.xml
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="fdsnxml2inv-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/fdsnxml2inv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/fdsnxml2inv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/fdsnxml2inv.cfg</span></code></div>
</div>
<p>fdsnxml2inv inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">fdsnxml2inv [OPTIONS] input [output]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-h">
<span id="cmdoption-fdsnxml2inv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-V">
<span id="cmdoption-fdsnxml2inv-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-D">
<span id="cmdoption-fdsnxml2inv-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-v">
<span id="cmdoption-fdsnxml2inv-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-q">
<span id="cmdoption-fdsnxml2inv-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-s">
<span id="cmdoption-fdsnxml2inv-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-l">
<span id="cmdoption-fdsnxml2inv-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="convert">
<h3>Convert<a class="headerlink" href="#convert" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-f">
<span id="cmdoption-fdsnxml2inv-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-f" title="Permalink to this definition"></a></dt>
<dd><p>Generate formatted SCML. Otherwise, output XML to a single line.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-to-staxml">
<span class="sig-name descname"><span class="pre">--to-staxml</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-to-staxml" title="Permalink to this definition"></a></dt>
<dd><p>Convert from SCML to StationXML and expects SCML as input.
If not given, input is SCML and output is StationXML.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-relaxed-ns-check">
<span class="sig-name descname"><span class="pre">--relaxed-ns-check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-relaxed-ns-check" title="Permalink to this definition"></a></dt>
<dd><p>Enable relaxed XML namespace checks. This will also accept
tags within a different namespace than defined in the
supported schema.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fdsnxml2inv-log-stages">
<span class="sig-name descname"><span class="pre">--log-stages</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fdsnxml2inv-log-stages" title="Permalink to this definition"></a></dt>
<dd><p>Add more output to stderr for all channel response stages
when converting from StationXML.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">fdsnxml2inv</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#convert">Convert</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="dlsv2inv.html"
title="previous chapter">dlsv2inv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="import_inv.html"
title="next chapter">import_inv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/fdsnxml2inv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,380 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>FixedHypocenter &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scevent" href="../toc/extensions/scevent.html" />
<link rel="prev" title="LOCSAT" href="global_locsat.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">6.9.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="../toc/extensions/scevent.html" title="scevent"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_locsat.html" title="LOCSAT"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="fixedhypocenter">
<span id="global-fixedhypocenter"></span><h1>FixedHypocenter<a class="headerlink" href="#fixedhypocenter" title="Permalink to this heading"></a></h1>
<p>Locator for re-computing source time with fixed hypocenter</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Mining-related events are useful as ground truth events (<span id="id1">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id12" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">34</a>]</span>)
because the epicentre and depth can be constrained by physical inspection.
Unless a local seismograph network with accurate timing also locates the event,
and that information is available, the origin time must be estimated in order
for the event to be useful as ground truth. Existing location algorithms in
<cite>SeisComP</cite>, including <a class="reference internal" href="global_locsat.html#global-locsat"><span class="std std-ref">Hypo71</span></a> and <a class="reference internal" href="global_locsat.html#global-locsat"><span class="std std-ref">LOCSAT</span></a>
do not allow the determination of origin time given a set of arrivals and a
fixed hypocentre. There is a need, then, for a method of fixed hypocentre
origin time determination.</p>
<p>Objectives of this locator are:</p>
<ul class="simple">
<li><p>Inversion of arrival times of phase picks for source time fixing hypocenter location.</p></li>
<li><p>Compatibility of the method of fixed-hypocentre origin time determination with
the practise of the Comprehensive Test Ban Treaty Organization (CTBTO).</p></li>
<li><p>Adaptation of a procedure which is compatible with the other locators supported by <cite>SeisComP</cite>.</p></li>
<li><p>Adaptation of a procedure which can reproduce results of legacy locators currently
in use, such as GENLOC <span id="id2">Pavlis <em>et al.</em> [<a class="reference internal" href="../base/references.html#id60" title="G.L. Pavlis, F. Vernon, D. Harvey, and D. Quinlan. Lsqr: an algorithm for sparse linear equations and sparse least squares. ACM Transactions on Mathematical Software, 1:43 - 71, 1982. doi:10.1145/355984.355989.">55</a>]</span> and GRL, a
grid-based locator developed at the Canadian Hazards Information Service (CHIS).</p></li>
</ul>
<p>The implementation of this locator by <a class="reference internal" href="../base/glossary.html#term-gempa-GmbH"><span class="xref std std-term">gempa GmbH</span></a> was initiated and has received
initial funding from <span id="id3"><em>Natural Resources Canada (NRCAN), Earthquakes Canada</em> [<a class="reference internal" href="../base/references.html#id173" title="Natural Resources Canada (NRCAN), Earthquakes Canada. URL: https://earthquakescanada.nrcan.gc.ca/index-en.php.">17</a>]</span>.</p>
</section>
<section id="methodology">
<h2>Methodology<a class="headerlink" href="#methodology" title="Permalink to this heading"></a></h2>
<p>Given the measured arrival times <img class="math" src="../_images/math/ef0cc8a9abcd91d4c81e277fda15f02f61283b8a.png" alt="t_i^k"/> of phase <img class="math" src="../_images/math/9630132210b904754c9ab272b61cb527d12263ca.png" alt="k"/> at
station <img class="math" src="../_images/math/5aa339d4daf45a810dda332e3c80a0698e526e04.png" alt="i"/>, most methods of earthquake hypocentre location involve
minimization of the weighted squared sum of the residuals. That is,
minimization of:</p>
<div class="math">
<p><img src="../_images/math/66bfccc625b603ecc69ebbaf5e79849a6f90985a.png" alt="|r_w|^2 = \sum_{i=1}^N {w_i^2 [ t_i^k - \tau - T_{model}^k(r_i,x) ]^2}"/></p>
</div><p>The residuals are computed by subtracting the expected arrival times
<img class="math" src="../_images/math/4cd887dff87ad1c4fe54e94c441379b895433dc5.png" alt="\tau - T_{model}^k(r_i,x)"/> based on a velocity model applied at the
coordinates of each station
<img class="math" src="../_images/math/dbc4c429b48dd94e41ee866e1edbf0abededae3a.png" alt="r_i"/>.</p>
<p>Typically the weights can be a combination of the inverse of the
estimated pick uncertainty <img class="math" src="../_images/math/68d8fad26c73ee49f100be287592043b3d020379.png" alt="1/{\sigma}_i"/>, a distance term
<img class="math" src="../_images/math/1bdf84b56ea19c568b70e6dc45392b954d63a0ea.png" alt="d^k(\Delta)"/> and/or a residual weight term <img class="math" src="../_images/math/cf90d710bc5e654f04f2197992b5658a393a8c93.png" alt="p(r_i)"/>.
Alternative weighting schemes can be applied but in this
implementation we weight by pick uncertainty alone: <img class="math" src="../_images/math/eb6982d524ed71f7530ce3eb31b4814c1aef31b1.png" alt="w_i=\frac{1}{{\sigma}_i}"/>.</p>
<p>In the general case, the model is a nonlinear function of its inputs, and there
is no analytic solution for the origin time and hypocenter that minimize the
norm. Typically, the solution is found iteratively, based on an initial guess
for the origin time and hypocenter. This is the normal procedure for an earthquake
without an a priori estimate of the hypocentral location.
When the hypocenter is in fact accurately constrained, the modeled travel time
is a constant, so we can project each phase arrival back to an equivalent origin
time</p>
<div class="math">
<p><img src="../_images/math/e07cf5ca46edb86938c9b742583b78cf5dfd5a2c.png" alt="\tau_i^k = t_i^k - T_{model}^k (r_i,x)"/></p>
</div><p>so that we only have to find which minimizes:</p>
<div class="math">
<p><img src="../_images/math/ce91df5771b45d3d22d0246721cb9eda678dc1ea.png" alt="|r_w|^2 = \sum_{i=1}^{N}w_i^2 [\tau_i^k - \tau]^2"/></p>
</div><p>The residuals are minimized by:</p>
<div class="math">
<p><img src="../_images/math/a3c64e2d4f039151334ad193c4df506d7c5a4d27.png" alt="\tau = \frac{\sum_{i=1}^{N}w_i^2 (\tau_i^k)^2}{\sum_{i=1}^{N}w_i^2}."/></p>
</div><p>Thus, the origin time is simply the weighted mean of the equivalent origin
times, according to the velocity model, associated with the arrivals.</p>
<p>The standard error of this estimate is:</p>
<div class="math">
<p><img src="../_images/math/450e7d546e262c19d94b8fdfc9f5d971d36f7a1b.png" alt="\sigma = \sqrt{\frac{\sum_{i=1}^{N}w_i^2 [\tau_i^k - \tau]^2}{\sum_{i=1}^{N}w_i^2}}."/></p>
</div><p>The methodology for estimating error intervals and ellipses recommended for
standard processing at the CTBTO (<span id="id4">Lee and Lahr [<a class="reference internal" href="../base/references.html#id51" title="W.H. Lee and J.C. Lahr. Hypo71 (revised): a computer program for determining local earthquake hypocentral parameters, magnitude, and first motion pattern of local earthquakes. US Geol. Survey Open-file Report 75-311, 1975. URL: https://pubs.er.usgs.gov/publication/ofr75311, doi:10.3133/ofr75311.">51</a>]</span>) is that of
<span id="id5">Jordan and Sverdrup [<a class="reference internal" href="../base/references.html#id41" title="T.H. Jordan and K.A. Sverdrup. Teleseismic location techniques and their application to earthquake clusters in the south-central pacific. Bull. Seismol. Soc. Am., 4:1105 1130, 1981. doi:10.1785/BSSA0710041105.">47</a>]</span> and is implemented
in LOCSAT (<span id="id6">Bratt and Bache [<a class="reference internal" href="../base/references.html#id20" title="S.R. Bratt and T.C. Bache. Locating events with a sparse network of regional arrays. Bull. Seismol. Soc. Am., 78(2):780 - 798, 1988. URL: https://pubs.geoscienceworld.org/ssa/bssa/article-pdf/78/2/780/5334120/bssa0780020780.pdf, doi:10.1785/BSSA0780020780.">41</a>]</span>).
Uncertainty is represented by a set of points <img class="math" src="../_images/math/c24babb8b2b84f2c211a040b48c4e2e04bb74871.png" alt="x_e"/> around the final estimate
<img class="math" src="../_images/math/4d932942be8cf79d3cda089d58de1a45ca6f8597.png" alt="x_f"/> satisfying:</p>
<div class="math">
<p><img src="../_images/math/b5359fb7461e8422b3d0ea043241d3902ed8c878.png" alt="\kappa_p^2 &amp;= (x_e - x_f)^TC_m(x_e-x_f), \\
\kappa_p^2 &amp;= Ms^2F_p(M,K+N-M), \\
s^2 &amp;= \frac{Ks_K^2+|r_w|^2}{K+N-M}"/></p>
</div><p>where:</p>
<ul>
<li><p><img class="math" src="../_images/math/4577806854ed7741af5ad0aa1abe2909567a3083.png" alt="C_m"/>: Covariance matrix, corresponding to the final hypocentre estimate <img class="math" src="../_images/math/4d932942be8cf79d3cda089d58de1a45ca6f8597.png" alt="x_f"/>.</p></li>
<li><p><img class="math" src="../_images/math/8ab4b82ece5a67cb801cf339bca8ff343a570c2e.png" alt="s^2"/>: Ratio of actual to assumed.</p></li>
<li><p><img class="math" src="../_images/math/2255befd84ee2fcea10694752b43e60d80a4f992.png" alt="\kappa_p^2"/>: The “confidence coefficient” at probability <img class="math" src="../_images/math/27dc86f9f1b1c3435b2403a869b5870c582facea.png" alt="\rho"/>.</p></li>
<li><p><img class="math" src="../_images/math/86991529ca92ae0a8532508be15f15400052d4a4.png" alt="F_p(m,n)"/>: Fisher-Snedecor quantile function (inverse cumulative F-distribution)
for and degrees of freedom of numerator and denominator sum of squares,
respectively, and probability.</p></li>
<li><p><img class="math" src="../_images/math/141bbefb74014fc5e43499901bf78607ae335583.png" alt="p"/>: Confidence level: the desired probability that the true epicentre should
fall within the uncertainty bounds.</p></li>
<li><p><img class="math" src="../_images/math/3bfb3a64189a14b2704f4610827762d5e3145114.png" alt="N"/>: Sum of all arrival time, azimuth or slowness estimates. Here, only
arrival times are considered for inversion.</p></li>
<li><p><img class="math" src="../_images/math/4abba779877abb276b98ccb2b4ba9bf2e41947ab.png" alt="M"/>: Number of fitted parameters:</p>
<ul class="simple">
<li><p>3: error ellipsoid</p></li>
<li><p>2: error ellipse</p></li>
<li><p>1: depth or time error bounds.</p></li>
</ul>
<p>Here, <img class="math" src="../_images/math/dabb61ecc4da8df35c00e765a39fd383714b573a.png" alt="M = 1"/> as we only invert for the time.</p>
</li>
<li><p><img class="math" src="../_images/math/8caebcef0e5d5769000618e5116d6051c25bd98e.png" alt="s_K^2"/>: A prior estimate of the ratio of actual to assumed data variances; typically set to 1.</p></li>
<li><p><img class="math" src="../_images/math/52ddc0cde6d632f631533173562fe3ca375b1f32.png" alt="K"/>: Number of degrees of freedom in prior estimate <img class="math" src="../_images/math/8caebcef0e5d5769000618e5116d6051c25bd98e.png" alt="s_K^2"/>.
<img class="math" src="../_images/math/52ddc0cde6d632f631533173562fe3ca375b1f32.png" alt="K"/> can be configured by <a class="reference internal" href="#confval-FixedHypocenter.degreesOfFreedom"><code class="xref std std-confval docutils literal notranslate"><span class="pre">FixedHypocenter.degreesOfFreedom</span></code></a>.</p></li>
<li><p><img class="math" src="../_images/math/4fa53fbce202dca5a7572c6eb0dd0b33bd9e601b.png" alt="r_w"/>: Vector of weighted residuals.</p></li>
</ul>
<p>Although this formulation is complex it is useful it because allows the analyst to
balance a priori and a posteriori estimates of the ratio of actual to assumed
data variances.</p>
<p>The covariance matrix in the general case is computed from the weighted sensitivity
matrix <img class="math" src="../_images/math/93b581f18e6ddf1ae1ab7475c44b41837e648994.png" alt="A_w"/>, the row-weighted matrix of partial derivatives of arrival
time with respect to the solution coordinates.</p>
<div class="math">
<p><img src="../_images/math/746b9634c2f299dd2005c85460e58fae6d08a49e.png" alt="C_m = A^T_wA_w"/></p>
</div><p>However, when origin time is the only coordinate, the partial derivatives with
respect to origin time are unity, the weighted sensitivity matrix is simply a
row vector of weights, and the time-time covariance
<img class="math" src="../_images/math/95c69b0bc6dae384ad6ff06f0ec8ecaaf23987e4.png" alt="c_{tt}"/> is simply the sum of the squares of these weights.</p>
<div class="math">
<p><img src="../_images/math/3a34284a39272ffe88e206a0c9e216e716d08a39.png" alt="c_{tt} = \sum_{i=1}^{N}w_i^2"/></p>
</div><p>It is recommended that fixed-hypocentre origin time confidence intervals be
estimated using the method of <span id="id7">Jordan and Sverdrup [<a class="reference internal" href="../base/references.html#id41" title="T.H. Jordan and K.A. Sverdrup. Teleseismic location techniques and their application to earthquake clusters in the south-central pacific. Bull. Seismol. Soc. Am., 4:1105 1130, 1981. doi:10.1785/BSSA0710041105.">47</a>]</span> for error ellipsoids,
that is, that the time error bounds be represented using</p>
<div class="math">
<p><img src="../_images/math/6d03a1b7af5b2b4b70c5442100e5e890ecc841ae.png" alt="\Delta t_p &amp;= \sqrt{ \frac{\kappa_p^2}{c_{tt}} } \\
&amp;= \sqrt{ \frac{F_p(1,K+N-1)}{K+N-1} \frac{Ks_K^2 + \sum_{i=1}^{N}w_i^2 [\tau_i^k-\tau]^2}{\sum_{i=1}^{N}w_i^2}}."/></p>
</div><p>In addition to recording arrival weights and residuals, distances and azimuths,
and other details of origin quality, the details of a ground-truth-level (GT1)
fixed-hypocentre origin time estimate are recorded as:</p>
<ul class="simple">
<li><p>origin.time = <img class="math" src="../_images/math/914b2d4b6659b86d3153d5510839dfb254dfc8a3.png" alt="\tau"/></p></li>
<li><p>origin.time_errors.uncertainty = <img class="math" src="../_images/math/c65793dc2e246814b66c7cdd4e3a1c6dc504bbfc.png" alt="\Delta t_p"/></p></li>
<li><p>origin.time_errors.confidence_level = <img class="math" src="../_images/math/13f30937182d0536a97f9f716e6024b4c3951b86.png" alt="100p"/></p></li>
<li><p>origin.quality.standard_error = <img class="math" src="../_images/math/b52df27bfb0b1e3af0c2c68a7b9da459178c2a7d.png" alt="\sigma"/></p></li>
<li><p>origin.quality.ground_truth_level = GT1</p></li>
</ul>
<p>For the sake of reproducibility, a comment is added to every new <a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a>
reporting <img class="math" src="../_images/math/52ddc0cde6d632f631533173562fe3ca375b1f32.png" alt="K"/>, <img class="math" src="../_images/math/93ad30f90f5091591a2dc0895c6171abda508e06.png" alt="s_K"/> and <img class="math" src="../_images/math/e2e0165baaf165355d3e4661b14d1558d9bde02b.png" alt="\kappa_p"/>.</p>
</section>
<section id="application">
<h2>Application<a class="headerlink" href="#application" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Configure the parameters in the section <em>FixedHypocenter</em> of the global configuration.</p></li>
<li><p>When using in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> the FixedHypocenter locator can be chosen right away
from the available locators.</p>
<figure class="align-center" id="id8">
<a class="reference internal image-reference" href="../_images/scolv-fixedhypocenter.png"><img alt="../_images/scolv-fixedhypocenter.png" src="../_images/scolv-fixedhypocenter.png" style="width: 18cm;" /></a>
<figcaption>
<p><span class="caption-text">scolv Location tab with FixHypocenter selected for relocating.</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</li>
<li><p>Configure the module, e.g. <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>, which is to use FixedHypocenter:</p>
<ul class="simple">
<li><p>set the locator type / interface: “FixedHypocenter”</p></li>
<li><p>if requested, set the profile as [interface]/[model], e.g.: LOCSAT/iasp91 or libtau/ak135</p></li>
</ul>
</li>
<li><p>Run the module with FixedHypocenter</p>
<p>Origins created by the FixedHypocenter locator can be identified by the methodID
and the <em>confidence/description</em> comment of the origin paramters, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>&lt;origin publicID=&quot;Origin/20200102030459.123456.8222&quot;&gt;
...
&lt;timeFixed&gt;false&lt;/timeFixed&gt;
&lt;epicenterFixed&gt;true&lt;/epicenterFixed&gt;
&lt;methodID&gt;FixedHypocenter&lt;/methodID&gt;
&lt;earthModelID&gt;iasp91&lt;/earthModelID&gt;
...
&lt;comment&gt;
&lt;text&gt;Confidence coefficient: K-weighted ($K$=8, $s_K$=1 s), $\kappa_p$ = 1.6, $n_{eff}$ = 5.0&lt;/text&gt;
&lt;id&gt;confidence/description&lt;/id&gt;
&lt;/comment&gt;
...
&lt;/origin&gt;
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="global-fixedhypocenter-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>FixedHypocenter.*</strong>
<em>Locator parameters: FixedHypocenter</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-FixedHypocenter.profiles">
<span class="sig-name descname"><span class="pre">FixedHypocenter.profiles</span></span><a class="headerlink" href="#confval-FixedHypocenter.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">LOCSAT/iasp91,LOCSAT/tab</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Defines a list of available travel time tables. Each item
is a tuple separated by a slash with format &quot;[interface]/[model]&quot;.
Built-in interfaces are &quot;LOCSAT&quot; and &quot;libtau&quot;.
Other interfaces might be added via plugins. Please check their
documentation for the required interface name.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-FixedHypocenter.usePickUncertainties">
<span class="sig-name descname"><span class="pre">FixedHypocenter.usePickUncertainties</span></span><a class="headerlink" href="#confval-FixedHypocenter.usePickUncertainties" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to use pick time uncertainties rather than a fixed
time error. If true, then the uncertainties are retrieved from
each individual pick object. If they are not defined, then the
default pick time uncertainty as defined by defaultTimeError
will be used instead.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-FixedHypocenter.defaultTimeError">
<span class="sig-name descname"><span class="pre">FixedHypocenter.defaultTimeError</span></span><a class="headerlink" href="#confval-FixedHypocenter.defaultTimeError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1.0</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>The default pick time uncertainty if pick uncertainties are
not going to be used or if they are absent.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-FixedHypocenter.degreesOfFreedom">
<span class="sig-name descname"><span class="pre">FixedHypocenter.degreesOfFreedom</span></span><a class="headerlink" href="#confval-FixedHypocenter.degreesOfFreedom" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">8</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of degrees of freedom used for error estimate.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-FixedHypocenter.confLevel">
<span class="sig-name descname"><span class="pre">FixedHypocenter.confLevel</span></span><a class="headerlink" href="#confval-FixedHypocenter.confLevel" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.9</span></code></p>
<p>Type: <em>double</em></p>
<p>Confidence level between 0.5 and 1.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">FixedHypocenter</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#methodology">Methodology</a></li>
<li><a class="reference internal" href="#application">Application</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_locsat.html"
title="previous chapter">LOCSAT</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../toc/extensions/scevent.html"
title="next chapter">scevent</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_fixedhypocenter.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,185 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>FX-DFX &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="homogeneous" href="global_homogeneous.html" />
<link rel="prev" title="mb_IDC" href="global_mb_idc.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">6.9.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="global_homogeneous.html" title="homogeneous"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mb_idc.html" title="mb_IDC"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="fx-dfx">
<span id="global-fx-dfx"></span><h1>FX-DFX<a class="headerlink" href="#fx-dfx" title="Permalink to this heading"></a></h1>
<p>Implementation of the CTBTO/IDC polarization analysis for
three-component stations.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The feature extraction as implemented at CTBTO IDC for single three-component
stations determines back azimuth (station to origin) and slowness, including the
uncertainties for both of these. In the IDC source code and database, the back
azimuth is referred to as only azimuth.</p>
</section>
<section id="algorithm">
<h2>Algorithm<a class="headerlink" href="#algorithm" title="Permalink to this heading"></a></h2>
<p>The algorithm computes polarization attributes for a three-component station using
a modification to the <span id="id1">Jurkevics [<a class="reference internal" href="../base/references.html#id42" title="A. Jurkevics. Polarization analysis of three-component array data. Bull. Seismol. Soc. Am., 78(5):1725-1743, 1988. doi:10.1785/BSSA0710041105.">48</a>]</span> algorithm. Some of these attributes are
then used to determine detection azimuth (seazp = P-type azimuth in degrees),
detection slowness and azimuth/slowness uncertainties (inang1 = emergence (incidence)
angle and rect = rectilinearity).</p>
<p>A fixed noise window of 9.5 seconds ([-30s;-20.5s] with respect to trigger time)
and a signal window of 5.5 seconds ([-4s;1.5s] with respect to trigger time)
is used. The signal window is subdivided into intervals of 1.5s length which
overlap by 50%.</p>
<ol class="arabic simple">
<li><p>De-mean data according to mean of noise window.</p></li>
<li><p>Apply cosine ramp to noise data and filter the entire data window.</p></li>
<li><p>Rotate three components into ZNE space.</p></li>
<li><p>Compute 3x3 covariance matrix for each interval.</p></li>
<li><p>Extract eigenvalues and compute parameters including rectilinearity.</p></li>
<li><p>Choose the result set with the largest rectilinearity.</p></li>
</ol>
</section>
<section id="picks">
<h2>Picks<a class="headerlink" href="#picks" title="Permalink to this heading"></a></h2>
<p>In addition to the extracted back azimuth and slowness values the rectilinearity
is added as a comment to the resulting pick. The comment ID is
<code class="docutils literal notranslate"><span class="pre">DFX:rectilinearity</span></code> and the comment is the value in string representation.</p>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">FX-DFX</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#algorithm">Algorithm</a></li>
<li><a class="reference internal" href="#picks">Picks</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mb_idc.html"
title="previous chapter">mb_IDC</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_homogeneous.html"
title="next chapter">homogeneous</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_fx-dfx.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,203 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>homogeneous &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="LOCSAT" href="global_locsat.html" />
<link rel="prev" title="FX-DFX" href="global_fx-dfx.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">6.9.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="global_locsat.html" title="LOCSAT"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_fx-dfx.html" title="FX-DFX"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="homogeneous">
<span id="global-homogeneous"></span><h1>homogeneous<a class="headerlink" href="#homogeneous" title="Permalink to this heading"></a></h1>
<p>Travel-times for a homogeneous velocity model</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The travel-time interface <em>homogeneous</em> allows predicting travel times for
P and S wave and homogeneous velocity models.</p>
</section>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h2>
<p>The travel-time interface <em>homogeneous</em> is controlled by global parameters,
e.g., in <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/global.cfg</span></code>:</p>
<ol class="arabic simple">
<li><p>Add a new table profile for homogeneous travel-time tables with some custom
profile name. In <a class="reference internal" href="scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a> navigate to the section <em>ttt.homogeneous</em>
and click on the green button to add a table profile.</p></li>
<li><p>Set all parameters in the new profile.</p></li>
<li><p>Register the new profile by adding its name to the list of tables in
<code class="xref std std-confval docutils literal notranslate"><span class="pre">ttt.homogeneous.tables</span></code></p></li>
</ol>
<p>Example configuration:</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span># The list of supported model names per interface.
ttt.homogeneous.tables = &quot;5&quot;
# Geographic origin of the region. Expects 2 values: latitude, longitude.
ttt.homogeneous.5.origin = 51, 12
# Radius validity of the region.
ttt.homogeneous.5.radius = 1
# Min Depth validity of the region.
ttt.homogeneous.5.minDepth = 0
# Max Depth validity of the region.
ttt.homogeneous.5.maxDepth = 2
# P wave velocity.
ttt.homogeneous.5.P-velocity = 5
# S wave velocity.
ttt.homogeneous.5.S-velocity = 3
</pre></div>
</div>
</section>
<section id="application">
<h2>Application<a class="headerlink" href="#application" title="Permalink to this heading"></a></h2>
<p>Once the travel-time interface profile is defined and registered, in can be
selected</p>
<ul class="simple">
<li><p>interactively in the <a class="reference internal" href="scolv.html#scolv-sec-waveform-review"><span class="std std-ref">scolv phase picker</span></a>
or the <a class="reference internal" href="scolv.html#scolv-sec-amplitude-review"><span class="std std-ref">scolv amplitude picker</span></a>,</p></li>
<li><p>or used in other modules which allow the configuration of travel-time
interfaces.</p></li>
</ul>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">homogeneous</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
<li><a class="reference internal" href="#application">Application</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_fx-dfx.html"
title="previous chapter">FX-DFX</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_locsat.html"
title="next chapter">LOCSAT</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_homogeneous.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,622 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Hypo71 &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Md" href="global_md.html" />
<link rel="prev" title="global" href="../toc/extensions/global.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">6.9.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="global_md.html" title="Md"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/extensions/global.html" title="global"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="hypo71">
<span id="global-hypo71"></span><h1>Hypo71<a class="headerlink" href="#hypo71" title="Permalink to this heading"></a></h1>
<p>The traditional Hypo71PC locator with SeisComP.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The Hypo71 locator algorithm by Fred Klein locator (<span id="id1">Lee and Lahr [<a class="reference internal" href="../base/references.html#id51" title="W.H. Lee and J.C. Lahr. Hypo71 (revised): a computer program for determining local earthquake hypocentral parameters, magnitude, and first motion pattern of local earthquakes. US Geol. Survey Open-file Report 75-311, 1975. URL: https://pubs.er.usgs.gov/publication/ofr75311, doi:10.3133/ofr75311.">51</a>]</span>) has
been implemented into <cite>SeisComP</cite> through the plugin mechanism. The plugin <em>hypo71</em>
contains the LocatorInterface implementation for Hypo71.
This plugin uses a slightly modified Hypo71 version from Alexandre Nercessian (IPGP)
which allows negative earthquake depth (above sea level) and negative stations
altitude (below sea level - OBS).</p>
<p>The development of this plugin was co-financed by the European Union and
<a class="reference external" href="http://www.developpement-durable.gouv.fr">le Ministère de lEcologie, du Développement Durable, des Transports et du Logement</a>
and developed by <span id="id2"><em>OVSM, Interreg Caraibes</em> [<a class="reference internal" href="../base/references.html#id179" title="OVSM, Interreg Caraibes. URL: https://www.interreg-caraibes.com.">18</a>]</span> / <span id="id3"><em>IPGP</em> [<a class="reference internal" href="../base/references.html#id142" title="IPGP. URL: http://www.ipgp.fr.">11</a>]</span>.</p>
</section>
<section id="how-it-works">
<h2>How it works<a class="headerlink" href="#how-it-works" title="Permalink to this heading"></a></h2>
<p>When receiving a list of arrivals to locate, the plugin builds a Hypo71 input
file with informations from the station inventory and configured profile.
It then runs Hypo71, reads the output file and sends the results (location,
uncertainties, RMS, pick residuals …) to <cite>SeisComP</cite>.</p>
<p>If several trial depths are configured, the plugin will run as many Hypo71
rushes as configured depths.
Then all the results are read, and a decision is made on the best one, based on
location RMS and uncertainty.
A final run is then made with the best result depth as trial depth.</p>
</section>
<section id="profiles">
<h2>Profiles<a class="headerlink" href="#profiles" title="Permalink to this heading"></a></h2>
<p>The plugin allows the user to set up as many profiles as needed.
A profile contains all the information relative to the velocity model and
Hypo71 iteration parameters.</p>
<p>This allows the user to tune the behaviour of Hypo71 to what he needs.
If no profiles are set-up, the plugin will use default Hypo71 profile, according
to example shown in Hypo71 first publication.
Some of this default Hypo71 parameters have been altered to allow more and finer
iteration, since computer power is now far above what was available in the 1970s.</p>
</section>
<section id="error-measures">
<h2>Error measures<a class="headerlink" href="#error-measures" title="Permalink to this heading"></a></h2>
<p>After running Hypo71, the output is converted into a <cite>SeisComP</cite> origin (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>)
object including some error measures. The following table shows how
the Hypo71 error measures are mapped to the <cite>SeisComP</cite> data model:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p><cite>SeisComP</cite></p></th>
<th class="head"><p>Hypo71</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Origin.latitude.uncertainty</p></td>
<td><p>ERH/sqrt(2)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.longitude.uncertainty</p></td>
<td><p>ERH/sqrt(2)</p></td>
</tr>
<tr class="row-even"><td><p>Origin.depth.uncertainty</p></td>
<td><p>ERZ</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.standardError</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.secondaryAzimuthalGap</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.usedStationCount</p></td>
<td><p>usedStationCount</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.associatedStationCount</p></td>
<td><p>associatedStationCount</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.associatedPhaseCount</p></td>
<td><p>associatedPhaseCount</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.usedPhaseCount</p></td>
<td><p>associatedPhaseCount</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.depthPhaseCount</p></td>
<td><p>depthPhaseCount</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.minimumDistance</p></td>
<td><p>km2deg(Tdist.front)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.maximumDistance</p></td>
<td><p>km2deg(Tdist.back)</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.medianDistance</p></td>
<td><p>km2deg(~Tdist)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.groundTruthLevel</p></td>
<td><p>QUALITY</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originUncertainty.horizontalUncertainty</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originUncertainty.minHorizontalUncertainty</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originUncertainty.maxHorizontalUncertainty</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originUncertainty.azimuthMaxHorizontalUncertainty</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-even"><td><p>ConfidenceEllipsoid.semiMajorAxisLength</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-odd"><td><p>ConfidenceEllipsoid.semiMinorAxisLength</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-even"><td><p>ConfidenceEllipsoid.semiIntermediateAxisLength</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-odd"><td><p>ConfidenceEllipsoid.majorAxisPlunge</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-even"><td><p>ConfidenceEllipsoid.majorAxisAzimuth</p></td>
<td><p>_</p></td>
</tr>
<tr class="row-odd"><td><p>ConfidenceEllipsoid.majorAxisRotation</p></td>
<td><p>_</p></td>
</tr>
</tbody>
</table>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>The <em>hypo71</em> plugin is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/hypo71.so</span></code>.
It provides a new implementation of the LocatorInterface with the name Hypo71.</p>
<p>To add the plugin to a module add it to the modules configuration, either
<code class="file docutils literal notranslate"><span class="pre">modulename.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>hypo71
</pre></div>
</div>
<p>Basically it can be used by two <cite>SeisComP</cite> modules: <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> and <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>.</p>
</section>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h2>
<p>All output is stored in the configured <code class="xref std std-confval docutils literal notranslate"><span class="pre">HYPO71ROOT</span></code>.</p>
<p>The following file are stored:</p>
<ul class="simple">
<li><p>Input file (input)</p></li>
<li><p>Input configuration (.INP)</p></li>
<li><p>Hypo71 location header (.OUT)</p></li>
<li><p>Hypo71 location results (.PRT)</p></li>
<li><p>Hypo71 ZTR evalutation log (.LOG)</p></li>
</ul>
<p>In addition to the native Hypo71 outp ut a <cite>SeisComP</cite> origin object is created and
returned to the calling instance. Usually this object is then sent via messaging.</p>
<p>In addition, the stdout output of the locator is redirected to <cite>SeisComP</cite> output at
INFO level. Each line is identified by leading “Hypo71PC:”, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">12</span><span class="p">:</span><span class="mi">02</span><span class="p">:</span><span class="mi">25</span> <span class="p">[</span><span class="n">info</span><span class="p">]</span> <span class="n">Hypo71PC</span><span class="p">:</span> <span class="n">Date</span> <span class="n">Heure</span> <span class="n">Minute</span> <span class="n">Seconde</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">02</span><span class="p">:</span><span class="mi">25</span> <span class="p">[</span><span class="n">info</span><span class="p">]</span> <span class="n">Hypo71PC</span><span class="p">:</span> <span class="mi">90113</span> <span class="mi">22</span> <span class="mi">48</span> <span class="mf">3.78</span> <span class="n">Nb</span> <span class="n">Iterations</span> <span class="p">:</span> <span class="mi">3</span>
</pre></div>
</div>
<p>To view this output on the command line add <em>debug</em> to your application when executing on
the command line. Increasing logging level of the module which executes the plugin
allows to read the output in the log file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">loggging</span><span class="o">.</span><span class="n">level</span> <span class="o">=</span> <span class="mi">3</span>
</pre></div>
</div>
</section>
<section id="configuration-example">
<h2>Configuration example<a class="headerlink" href="#configuration-example" title="Permalink to this heading"></a></h2>
<p>To add the plugin to an application such as scolv or screloc, add the plugin
name to the list of plugins that are loaded (e.g. <code class="file docutils literal notranslate"><span class="pre">scolv.cfg</span></code>):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>hypo71
</pre></div>
</div>
<p>Futhermore add the plugin configuration (e.g. <code class="file docutils literal notranslate"><span class="pre">scolv.cfg</span></code>):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1">########################################################</span>
<span class="c1">############# Hypo71 plugin configuration ##############</span>
<span class="c1">########################################################</span>
<span class="c1"># Hypo71 input file to process (generated by plugin)</span>
hypo71.inputFile<span class="w"> </span><span class="o">=</span><span class="w"> </span>@DATADIR@/hypo71/HYPO71.INP
<span class="c1"># Hypo71 log file to store ZTR calculation and final results</span>
hypo71.logFile<span class="w"> </span><span class="o">=</span><span class="w"> </span>@LOGDIR@/HYPO71.LOG
<span class="c1"># Hypo71 output file to read results from (generated by binary)</span>
hypo71.outputFile<span class="w"> </span><span class="o">=</span><span class="w"> </span>@DATADIR@/hypo71/HYPO71.PRT
<span class="c1"># Hypo71 script called by plugin</span>
hypo71.hypo71ScriptFile<span class="w"> </span><span class="o">=</span><span class="w"> </span>@DATADIR@/hypo71/run.sh
<span class="c1"># Hypo71 default profile</span>
hypo71.defaultControlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span>@DATADIR@/hypo71/profiles/default.hypo71.conf
<span class="c1"># Hypo71 origin patternID</span>
hypo71.publicID<span class="w"> </span><span class="o">=</span><span class="w"> </span>Hypo71.@time/%Y%m%d%H%M%S.%f@.@id@
<span class="c1"># Should we use the custom patternID ?</span>
hypo71.useHypo71PatternID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span>
<span class="c1"># Hypo71 custom profiles examples</span>
hypo71.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>ModelA
hypo71.profile.ModelA.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;My Velocity Model A&quot;</span>
hypo71.profile.ModelA.methodID<span class="w"> </span><span class="o">=</span><span class="w"> </span>Hypo71PC
hypo71.profile.ModelA.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span>@DATADIR@/hypo71/profiles/profile.a.conf
</pre></div>
</div>
<p>Verify that everything is properly set up in the script <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/hypo71/run.sh</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
<span class="nv">HYPO71PC_BINARY</span><span class="o">=</span>Hypo71PC
<span class="nv">HYPO71PC_HOME</span><span class="o">=</span><span class="sb">`</span>dirname<span class="w"> </span><span class="nv">$0</span><span class="sb">`</span>
<span class="c1"># Jumping into the right directory</span>
<span class="nb">cd</span><span class="w"> </span><span class="si">${</span><span class="nv">HYPO71PC_HOME</span><span class="si">}</span>/
<span class="c1"># Executing binary with input file as argument</span>
<span class="si">${</span><span class="nv">SEISCOMP_ROOT</span><span class="si">}</span>/bin/<span class="nv">$HYPO71PC_BINARY</span><span class="w"> </span>&lt;<span class="w"> </span>input
</pre></div>
</div>
<p>Verify that everything is properly set up in the file <code class="file docutils literal notranslate"><span class="pre">$</span><em><span class="pre">SEISCOMP_ROOT</span></em><span class="pre">/share/hypo71/input</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>HYPO71.INP
HYPO71.PRT
HYPO71.OUT
</pre></div>
</div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>There must be 3 blank lines at the end of the <code class="file docutils literal notranslate"><span class="pre">input</span></code> file, those are not to be removed.</p>
</div>
<p>Finally set-up your Hypo71 profile (e.g. <code class="file docutils literal notranslate"><span class="pre">$</span><em><span class="pre">SEISCOMP_ROOT</span></em><span class="pre">/share/hypo71/profiles/profile.a.conf</span></code>)</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1">############################################################</span>
<span class="c1">## HYPO71 SeisComP Plugin ##</span>
<span class="c1">## @OVSM-IPGP ##</span>
<span class="c1">## ##</span>
<span class="c1">############################################################</span>
<span class="c1">## This profile is based on Dorel velocity model for French Antilles</span>
<span class="c1">## It allows several iterations at different starting depth for deep and crustal earthquakes</span>
<span class="c1">##############</span>
<span class="c1"># Reset List #</span>
<span class="c1">##############</span>
TEST<span class="o">(</span><span class="m">01</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>.1<span class="w"> </span><span class="c1"># sec # cutoff RMS value under which Jeffrey&#39;s weghting of residuals is not used</span>
TEST<span class="o">(</span><span class="m">02</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">50</span>.<span class="w"> </span><span class="c1"># km #</span>
TEST<span class="o">(</span><span class="m">03</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>.2<span class="w"> </span><span class="c1"># critical F-value for the stepwise multiple regression</span>
TEST<span class="o">(</span><span class="m">04</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>.01<span class="w"> </span><span class="c1"># km # adjustment value under which Geiger&#39;s iteration is terminated</span>
TEST<span class="o">(</span><span class="m">05</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">5</span>.<span class="w"> </span><span class="c1"># km # focal-depth value above which DZ is rest to DZ / (K+1)</span>
TEST<span class="o">(</span><span class="m">06</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span>.<span class="w"> </span><span class="c1"># regression TEST(03)/TEST(06) coefficient value if no significant variable is found in the stepwise multiple regression</span>
TEST<span class="o">(</span><span class="m">10</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>.<span class="w"> </span><span class="c1"># km # coefficient value J = D/TEST(10) used for resetting DX and DY</span>
TEST<span class="o">(</span><span class="m">11</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">999</span>.<span class="w"> </span><span class="c1"># maximum number of iterations in the hypocentral adjustment</span>
TEST<span class="o">(</span><span class="m">12</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>.5<span class="w"> </span><span class="c1"># coefficient value DZ = -Z*TEST(12) used for resetting DZ when hypocenter is placed in the air</span>
TEST<span class="o">(</span><span class="m">13</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.<span class="w"> </span><span class="c1"># km # standard error value of hypocentral optionally calculated RMS</span>
<span class="c1">## The following values are only available with the Hypo71PC version modified by Alexandre Nercessian (IPGP) which is included with this plugin</span>
TEST<span class="o">(</span><span class="m">15</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>-2.<span class="w"> </span><span class="c1"># km # maximum altitude of earthquake in km (down is positive)</span>
TEST<span class="o">(</span><span class="m">20</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.<span class="w"> </span><span class="c1"># used altitude = read altitude * TEST(20) - for example, -2500 = -250 * 10</span>
<span class="c1">######################</span>
<span class="c1"># Crustal Model List #</span>
<span class="c1">######################</span>
<span class="nv">CRUSTAL_VELOCITY_MODEL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">3</span>.50,<span class="w"> </span><span class="m">6</span>.00,<span class="w"> </span><span class="m">7</span>.00,<span class="w"> </span><span class="m">8</span>.00
<span class="nv">CRUSTAL_DEPTH_MODEL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>.00,<span class="w"> </span><span class="m">3</span>.00,<span class="w"> </span><span class="m">15</span>.00,<span class="w"> </span><span class="m">30</span>.00
<span class="c1">################</span>
<span class="c1"># Control Card #</span>
<span class="c1">################</span>
<span class="c1"># MANDATORY</span>
<span class="nv">ZTR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">5</span>,<span class="w"> </span><span class="m">20</span>,<span class="w"> </span><span class="m">40</span>,<span class="w"> </span><span class="m">60</span>,<span class="w"> </span><span class="m">80</span>,<span class="w"> </span><span class="m">100</span>,<span class="w"> </span><span class="m">150</span>,<span class="w"> </span><span class="m">200</span><span class="w"> </span><span class="c1"># km # trial focus depth, at least two</span>
<span class="c1"># MANDATORY</span>
<span class="nv">XNEAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">200</span>.<span class="w"> </span><span class="c1"># km # distance from epicenter up to which the distance weighting is 1</span>
<span class="c1"># MANDATORY</span>
<span class="nv">XFAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">450</span>.<span class="w"> </span><span class="c1"># km # distance from epicenter beyond which the distance weighting is 0</span>
<span class="c1"># MANDATORY</span>
<span class="nv">POS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>.76<span class="w"> </span><span class="c1"># ratio of P-velocity to S-velocity</span>
<span class="nv">KAZ</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="c1"># 1 or blank # apply azimuthal weighting of stations ?</span>
<span class="nv">KSORT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="c1"># 1 or blank # sort stations by distance in the output ?</span>
<span class="c1"># Use the position obtained from the best ZTR value ?</span>
<span class="nv">USE_TRIAL_POSITION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span>
<span class="c1">####################</span>
<span class="c1"># Instruction Card #</span>
<span class="c1">####################</span>
<span class="nv">KNST</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="c1"># use S data ?</span>
<span class="nv">INST</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="c1"># fix depth ?</span>
<span class="c1">#####################################</span>
<span class="c1"># Optionnal Weighting Look-Up Table #</span>
<span class="c1">#####################################</span>
<span class="c1"># Uncomment if you want to disable dynamic weighting and use those uncertainties as</span>
<span class="c1"># boundaries for weighting (e.g. a pick with +-0.02 will have a weight of 0)</span>
<span class="c1">#WEIGHT_UNCERTAINTY_BOUNDARIES = 0.1, 0.2, 0.5, 1.0</span>
</pre></div>
</div>
</section>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
<section id="locator">
<h3>Locator<a class="headerlink" href="#locator" title="Permalink to this heading"></a></h3>
<p>The usage of the new Hypo71 plugin is straight forward. Once loaded successfully
the new locator shows up in the lower left corners combo box.</p>
<figure class="align-center">
<img alt="../_images/locator_selection_small.png" src="../_images/locator_selection_small.png" />
</figure>
<p>Select the new Hypo71 locator and a profile from the pre-configured list.</p>
<figure class="align-center">
<img alt="../_images/locator_profile_selection_small.png" src="../_images/locator_profile_selection_small.png" />
</figure>
<p>The Hypo71 implementation doesnt provide a virtual profile automatically but the
plugins ships with some example profiles.</p>
<p>If an origin has been relocated the method should be set to “Hypo71” and
the earth model contains the name of the profile used to perform this localization.</p>
<figure class="align-center">
<img alt="../_images/origin_information.png" src="../_images/origin_information.png" />
</figure>
</section>
<section id="settings">
<h3>Settings<a class="headerlink" href="#settings" title="Permalink to this heading"></a></h3>
<p>The Hypo71 locator implementation supports to override configured settings or
control parameters for a session. Those changes are not persistent and lost if
the locator is changed to another one or the profile has been changed.</p>
<p>To open the settings dialog press the button right to the locator selection
combo box.</p>
<figure class="align-center">
<img alt="../_images/locator_settings.png" src="../_images/locator_settings.png" />
</figure>
<p>Then the Hypo71 selected profile parameters show up.</p>
<figure class="align-center">
<img alt="../_images/hypo71_settings.png" src="../_images/hypo71_settings.png" />
</figure>
</section>
</section>
<section id="more">
<h2>More<a class="headerlink" href="#more" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Take a look at Fred Klein HYPOINVERSE Earthquake Location software (<span id="id4">Klein [<a class="reference internal" href="../base/references.html#id47" title="F.W. Klein. Users guide to HYPOINVERSE-2000, a Fortran program to solve for earthquake locations and magnitudes. US Geological Survey, 2002-171:, 2002. URL: https://www.usgs.gov/node/279394, doi:10.3133/ofr02171.">50</a>]</span>),</p></li>
<li><p>Hypo71PC original manual and binary are available on USGS website (<span id="id5">Lee and Lahr [<a class="reference internal" href="../base/references.html#id51" title="W.H. Lee and J.C. Lahr. Hypo71 (revised): a computer program for determining local earthquake hypocentral parameters, magnitude, and first motion pattern of local earthquakes. US Geol. Survey Open-file Report 75-311, 1975. URL: https://pubs.er.usgs.gov/publication/ofr75311, doi:10.3133/ofr75311.">51</a>]</span>).</p></li>
</ul>
</section>
<section id="module-configuration">
<span id="global-hypo71-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>hypo71.*</strong>
<em>Locator parameters: Hypo71</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.logFile">
<span class="sig-name descname"><span class="pre">hypo71.logFile</span></span><a class="headerlink" href="#confval-hypo71.logFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;/HYPO71.LOG</span></code></p>
<p>Type: <em>string</em></p>
<p>Temporary file used by Hypo71 to store calculation logs.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.inputFile">
<span class="sig-name descname"><span class="pre">hypo71.inputFile</span></span><a class="headerlink" href="#confval-hypo71.inputFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/hypo71/HYPO71.INP</span></code></p>
<p>Type: <em>string</em></p>
<p>Temporary file to write Hypo71 input data to.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.outputFile">
<span class="sig-name descname"><span class="pre">hypo71.outputFile</span></span><a class="headerlink" href="#confval-hypo71.outputFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/hypo71/HYPO71.PRT</span></code></p>
<p>Type: <em>string</em></p>
<p>Temporary output file to read Hypo71 location data from.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.defaultControlFile">
<span class="sig-name descname"><span class="pre">hypo71.defaultControlFile</span></span><a class="headerlink" href="#confval-hypo71.defaultControlFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/hypo71/profiles/default.hypo71.conf</span></code></p>
<p>Type: <em>string</em></p>
<p>Hypo71 default profile.
If no custom profile is specified, this profile will be used by the plugin when proceeding to a localization.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.hypo71ScriptFile">
<span class="sig-name descname"><span class="pre">hypo71.hypo71ScriptFile</span></span><a class="headerlink" href="#confval-hypo71.hypo71ScriptFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/hypo71/run.sh</span></code></p>
<p>Type: <em>string</em></p>
<p>Bash script executed when calling the Hypo71 locator plugin for locating the earthquake.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.profiles">
<span class="sig-name descname"><span class="pre">hypo71.profiles</span></span><a class="headerlink" href="#confval-hypo71.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Hypo71 profile name.
Multiples names may be set. They must be separated by comma.
Each profile can have different velocity or parameters.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.publicID">
<span class="sig-name descname"><span class="pre">hypo71.publicID</span></span><a class="headerlink" href="#confval-hypo71.publicID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Custom patternID to use when generating origin publicID</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.useHypo71PatternID">
<span class="sig-name descname"><span class="pre">hypo71.useHypo71PatternID</span></span><a class="headerlink" href="#confval-hypo71.useHypo71PatternID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>boolean</em></p>
<p>Specifies if the given publicD should be used for generating origin publicID</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>hypo71.profile.*</strong>
<em>Profiles containing the profile-specific velocity model and the Hypo71 parameters.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>hypo71.profile.$name.*</strong>
$name is a placeholder for the name to be used and needs to be added to <a class="reference internal" href="#confval-hypo71.profiles"><code class="xref std std-confval docutils literal notranslate"><span class="pre">hypo71.profiles</span></code></a> to become active.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>hypo71.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>a,b
hypo71.profile.a.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
hypo71.profile.b.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
<span class="c1"># c is not active because it has not been added</span>
<span class="c1"># to the list of hypo71.profiles</span>
hypo71.profile.c.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.profile.-name.earthModelID">
<span class="sig-name descname"><span class="pre">hypo71.profile.$name.earthModelID</span></span><a class="headerlink" href="#confval-hypo71.profile.-name.earthModelID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Profiles velocity model name.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.profile.-name.methodID">
<span class="sig-name descname"><span class="pre">hypo71.profile.$name.methodID</span></span><a class="headerlink" href="#confval-hypo71.profile.-name.methodID" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">Hypo71</span></code></p>
<p>Type: <em>string</em></p>
<p>Profiles method.
It is generally the locators name (Hypo71).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.profile.-name.controlFile">
<span class="sig-name descname"><span class="pre">hypo71.profile.$name.controlFile</span></span><a class="headerlink" href="#confval-hypo71.profile.-name.controlFile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>File containing the profile parameters.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hypo71.profile.-name.fixStartDepthOnly">
<span class="sig-name descname"><span class="pre">hypo71.profile.$name.fixStartDepthOnly</span></span><a class="headerlink" href="#confval-hypo71.profile.-name.fixStartDepthOnly" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If the depth is requested to be fixed (e.g. by ticking the option
in scolv) the plugin performs only one location starting at
specified depth but with free depth evaluation. This option
defines whether it should really fix the depth (false) or
use this fixed depth only as starting point (true).</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Hypo71</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#how-it-works">How it works</a></li>
<li><a class="reference internal" href="#profiles">Profiles</a></li>
<li><a class="reference internal" href="#error-measures">Error measures</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
<li><a class="reference internal" href="#configuration-example">Configuration example</a></li>
<li><a class="reference internal" href="#usage">Usage</a><ul>
<li><a class="reference internal" href="#locator">Locator</a></li>
<li><a class="reference internal" href="#settings">Settings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#more">More</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/extensions/global.html"
title="previous chapter">global</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_md.html"
title="next chapter">Md</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_hypo71.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,892 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>iLoc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="MN" href="global_mn.html" />
<link rel="prev" title="MLh" href="global_mlh.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">6.9.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="global_mn.html" title="MN"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mlh.html" title="MLh"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="iloc">
<span id="global-iloc"></span><h1>iLoc<a class="headerlink" href="#iloc" title="Permalink to this heading"></a></h1>
<p>Locator in SeisComP implemented by the plugin lociloc.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>iLoc is a locator developed by István Bondár which has been integrated into
<cite>SeisComP</cite> by <span id="id1"><em>gempa GmbH</em> [<a class="reference internal" href="../base/references.html#id122" title="gempa GmbH. The SeisComP development and maintenance company. URL: https://www.gempa.de/.">28</a>]</span>. It is invoked by the wrapper plugin <em>lociloc</em> - the
interface between <cite>SeisComP</cite> and iLoc.
Read the sections <a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a> and <a class="reference internal" href="#iloc-application"><span class="std std-ref">Application in SeisComP</span></a> for
configuring and using iLoc in <cite>SeisComP</cite>.</p>
<section id="background">
<h3>Background<a class="headerlink" href="#background" title="Permalink to this heading"></a></h3>
<p>iLoc is a locator tool for locating seismic, hydroacoustic and
infrasound sources
based on <a class="reference internal" href="../base/glossary.html#term-pick"><span class="xref std std-term">phase picks</span></a>. iLoc is based on the location
algorithm developed by <span id="id2">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id12" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">34</a>]</span> and implemented at the
International Seismological Center, (<span id="id3"><em>ISC</em> [<a class="reference internal" href="../base/references.html#id140" title="ISC. International Seismological Centre. URL: http://www.isc.ac.uk/.">14</a>]</span>, <span id="id4">Bondár <em>et al.</em> [<a class="reference internal" href="../base/references.html#id16" title="I. Bondár, P. Mónus, C. Czanik, M. Kiszely, Z. Gráczer, Z. Wéber, and the AlpArrayWorking Group. Relocation of Seismicity in the Pannonian Basin Using a Global 3D Velocity Model. Seismol. Res. Lett., 6:2284 2293, 2018. doi:10.1785/0220180143.">36</a>]</span>)
with numerous new features added (<span id="id5">Bondár <em>et al.</em> [<a class="reference internal" href="../base/references.html#id16" title="I. Bondár, P. Mónus, C. Czanik, M. Kiszely, Z. Gráczer, Z. Wéber, and the AlpArrayWorking Group. Relocation of Seismicity in the Pannonian Basin Using a Global 3D Velocity Model. Seismol. Res. Lett., 6:2284 2293, 2018. doi:10.1785/0220180143.">36</a>]</span>).
The stand-alone iLoc code can be downloaded from the <span id="id6"></span>
software repository.</p>
<p>Among the major advantages of using iLoc is that it can</p>
<ul class="simple">
<li><p>Use any phases with valid travel-time predictions;</p></li>
<li><p>Use seismic, hydroacoustic and infrasound arrival time, slowness and azimuth
observations in location;</p></li>
<li><p>Use travel-time predictions from a global 3D upper mantle velocity model;</p></li>
<li><p>Use a local 1D velocity model;</p></li>
<li><p>Account for the correlated travel-time prediction error structure due to
unmodeled 3D velocity heterogeneities;</p></li>
<li><p>Check if the data has sufficient resolution to determine the
hypocenter depth;</p></li>
<li><p>Identify ground truth (GT5) candidate events.</p></li>
</ul>
</section>
<section id="history">
<h3>History<a class="headerlink" href="#history" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Originally developed for U.S. Air Force Research Laboratory, today the standard
at the International Seismological Centre (ISC) replacing previous routines</p></li>
<li><p>Open source, download website: <span id="id7"></span></p></li>
<li><p>Integrated first in SeisComP3 in 2019</p></li>
<li><p>Basis of the EMSC crowd-source locator, CsLoc since 2019</p></li>
<li><p>EMSC standard as of 2022</p></li>
</ul>
</section>
<section id="iloc-in-a-nutshell">
<h3>iLoc in a nutshell<a class="headerlink" href="#iloc-in-a-nutshell" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Accounts for correlated travel-time prediction errors</p></li>
<li><p>Initial hypocenter guess from Neighborhood Algorithm search</p></li>
<li><p>Linearised inversion using a priori estimate of the full data covariance matrix
Attempts for free-depth solution only if there is depth resolution</p></li>
<li><p>Default depth is derived from historical seismicity</p></li>
<li><p>Seismic, hydroacoustic and infrasound observations</p></li>
<li><p>Arrival time, slowness and azimuth measurements</p></li>
<li><p>Uses most ak135 or iasp91 Earth model phases in locating</p></li>
<li><p>Integrated RSTT travel-time predictions</p></li>
<li><p>RSTT is default for Pn/Sn and Pg/Lg</p></li>
<li><p>Local velocity model and local phase TT predictions for Pg/Sg/Lg, Pb/Sb, Pn/Sn.</p></li>
</ul>
</section>
<section id="algorithms">
<h3>Algorithms<a class="headerlink" href="#algorithms" title="Permalink to this heading"></a></h3>
<p>This section describes some of the principles. The full description of the applied
algorithms can be found in the iLoc documentation provided along with the package
on the <span id="id8"></span> website.</p>
<section id="neighbourhood-algorithm">
<h4>Neighbourhood algorithm<a class="headerlink" href="#neighbourhood-algorithm" title="Permalink to this heading"></a></h4>
<p>Linearized inversion algorithms are quite sensitive to the initial guess. In order
to find an initial hypocenter guess for the linearized inversion the Neigbourhood
Algorithm (<span id="id9">Sambridge [<a class="reference internal" href="../base/references.html#id73" title="M. Sambridge. Geophysical inversion with a neighbourhood algorithm. I. Searching the parameter space. Geophys. J. Int., 2:479 494, 1999. doi:10.1046/j.1365-246X.1999.00876.x.">60</a>]</span>; <span id="id10">Sambridge and Kennett [<a class="reference internal" href="../base/references.html#id74" title="M. Sambridge and B.L.N. Kennett. Seismic event location: non-linear inversion using a neighbourhood algorithm. Pure and Applied Geophysics, 151(1):241 257, 2001. doi:10.1007/PL00001158.">61</a>]</span>) is performed
around the starting hypocentre if <a class="reference internal" href="#confval-iLoc.profile.-name.DoGridSearch"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.DoGridSearch</span></code></a> is active.</p>
<p>During the NA search, we identify the phases with respect to each trial hypocenter
and calculate the misfit of the trial hypocenter. The misfit is defined as the sum
of the <a class="reference internal" href="#confval-iLoc.profile.-name.NAlpNorm"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAlpNorm</span></code></a> residual and a penalty factor that
penalizes against freakish local minima provided by just a few phases. In the first
iteration <a class="reference internal" href="#confval-iLoc.profile.-name.NAinitialSample"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAinitialSample</span></code></a> hypocenter hypotheses are tested,
while the subsequent iterations consider the best <a class="reference internal" href="#confval-iLoc.profile.-name.NAcells"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAcells</span></code></a>
solutions and resample the search space around them with
<a class="reference internal" href="#confval-iLoc.profile.-name.NAnextSample"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAnextSample</span></code></a> hypocenter hypotheses. The solution with
the lowest misfit after <a class="reference internal" href="#confval-iLoc.profile.-name.NAiterMax"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAiterMax</span></code></a> iteration is taken
as the initial hypocenter for the linearized least squares inversion.</p>
<p>A grid search can be performed to obtain a better initial hypocenter
guess. The search is performed around the starting hypocenter.
For a very exhaustive search one can increase <a class="reference internal" href="#confval-iLoc.profile.-name.NAinitialSample"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAinitialSample</span></code></a>,
<a class="reference internal" href="#confval-iLoc.profile.-name.NAnextSample"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAnextSample</span></code></a> and <a class="reference internal" href="#confval-iLoc.profile.-name.NAcells"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAcells</span></code></a>
values. Note that the maximum value for <a class="reference internal" href="#confval-iLoc.profile.-name.NAinitialSample"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.NAinitialSample</span></code></a>
is around 3500 before hitting memory limits.</p>
<p>An exhaustive search will
considerably slow iLoc down, especially when RSTT predictions are
enabled (<a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTT"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTT</span></code></a>, <a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPnSn"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPnSn</span></code></a>,
<a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPgLg"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPgLg</span></code></a>).</p>
</section>
<section id="depth-resolution">
<h4>Depth resolution<a class="headerlink" href="#depth-resolution" title="Permalink to this heading"></a></h4>
<p>Depth resolution can be provided by a local network, depth phases, core reflections
and to a lesser extent near-regional secondary phases. iLoc attempts for a free-depth
solution if the set of :term:arrivals meets at least one of the following conditions:</p>
<ul class="simple">
<li><p>Number of pairs of defining P and depth phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinDepthPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinDepthPhases</span></code></a></p></li>
<li><p>Number of pairs of defining P and core phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinCorePhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinCorePhases</span></code></a></p></li>
<li><p>Number of pairs of defining P and S phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinSPpairs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinSPpairs</span></code></a>
within a regional distance of <a class="reference internal" href="#confval-iLoc.profile.-name.MaxLocalDistDeg"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MaxLocalDistDeg</span></code></a>
degree</p></li>
<li><p>Number of defining P phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinLocalStations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinLocalStations</span></code></a>
within a local distance of <a class="reference internal" href="#confval-iLoc.profile.-name.MinLocalStations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinLocalStations</span></code></a>
degree.</p></li>
</ul>
<p>If there is insufficient depth resolution provided by the data, or the depth uncertainty
for a free-depth solution exceeds a threshold, the hypocentre depth is set to the depth
from the default depth grid if a grid point for the epicentre location exists; otherwise
it is set to a depth <span id="id11">Bolton <em>et al.</em> [<a class="reference internal" href="../base/references.html#id9" title="M.K. Bolton, D.A. Storchak, and J. Harris. Updating default depth in the isc bulletin. Phys. Earth Planet. Int., 1:27 - 45, 2006. doi:10.1016/j.pepi.2006.03.004.">33</a>]</span> assigned to
the corresponding Flinn-Engdahl geographic
region (<span id="id12">Young <em>et al.</em> [<a class="reference internal" href="../base/references.html#id86" title="J.B. Young, B.W. Presgrave, H. Aichele, D.A. Wiens, and E.A. Flinn. The Flinn-Engdahl Regionalisation Scheme: The 1995 revision. Phys. Earth Planet. Int., 96:223 - 297, 1996. doi:10.1016/0031-9201(96)03141-X.">66</a>]</span>). The default depth grid (<span id="id13">Bondár and Storchak [<a class="reference internal" href="../base/references.html#id14" title="I. Bondár and D. Storchak. Improved location procedures at the International Seismological Centre. Geophys. J. Int., 3:1220 1244, 2011. doi:10.1111/j.1365-246X.2011.05107.x.">37</a>]</span>)
is defined on a 0.5º x 0.5º grid as the median of all depths in the cell, provided
that there were at least five events in the cell, and the 7525 percent quartile
range was less than 100 km. The latter constraint is imposed to avoid regions with
both shallow and deep seismicity. Anthropogenic events are fixed to the surface.
Finally, the user can fix the depth to the initial depth.</p>
<p>iLoc reports back how the depth was determined in the FixedDepthType parameter:</p>
<ul class="simple">
<li><p>0 - free depth solution</p></li>
<li><p>1 - airquake/deepquake, depth fixed to surface/MaxHypocenterDepth</p></li>
<li><p>2 - depth fixed to depth reported by an agency (not used in <cite>SeisComP</cite>)</p></li>
<li><p>3 - depth fixed to depth-phase depth</p></li>
<li><p>4 - anthropogenic event, depth fixed to surface</p></li>
<li><p>5 - depth fixed to default depth grid depth</p></li>
<li><p>6 - no default depth grid point exists, fixed to median reported depth</p></li>
<li><p>7 - no default depth grid point exists, fixed to GRN-dependent depth</p></li>
<li><p>8 - depth fixed by user provided value</p></li>
</ul>
</section>
<section id="linearized-inversion">
<h4>Linearized inversion<a class="headerlink" href="#linearized-inversion" title="Permalink to this heading"></a></h4>
<p>Once the Neighbourhood search get close to the global optimum, iloc switches
to an iterative linearized least-squares inversion of travel-time, azimuth and
slowness observations (<span id="id14">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id13" title="I. Bondár and K.L. McLaughlin. Seismic location bias and uncertainty in the presence of correlated and non-gaussian travel-time errors. Bull. Seismol. Soc. Am., 1:172 193, 2009. doi:10.1785/0120080922.">35</a>]</span>; <span id="id15">Bondár and Storchak [<a class="reference internal" href="../base/references.html#id14" title="I. Bondár and D. Storchak. Improved location procedures at the International Seismological Centre. Geophys. J. Int., 3:1220 1244, 2011. doi:10.1111/j.1365-246X.2011.05107.x.">37</a>]</span>) to obtain the final solution
for the hypocenter.</p>
<p>The convergence test after (<span id="id16">Paige and Saunders [<a class="reference internal" href="../base/references.html#id59" title="C. Paige and M. Saunders. Lsqr: an algorithm for sparse linear equations and sparse least squares. ACM Transactions on Mathematical Software, 1:43 - 71, 1982. doi:10.1145/355984.355989.">54</a>]</span>) is
applied after every iteration. Once a convergent solution is obtained, the location
uncertainty is defined by the a posteriori model covariance matrix. The model
covariance matrix yields the four-dimensional error ellipsoid whose projections
provide the two-dimensional error ellipse and one-dimensional errors for depth
and origin time. These uncertainties are scaled to the 90% confidence level
(<span id="id17">Jordan and Sverdrup [<a class="reference internal" href="../base/references.html#id41" title="T.H. Jordan and K.A. Sverdrup. Teleseismic location techniques and their application to earthquake clusters in the south-central pacific. Bull. Seismol. Soc. Am., 4:1105 1130, 1981. doi:10.1785/BSSA0710041105.">47</a>]</span>).</p>
<p>The final hypocentre is tested against the
ground truth selection criteria (<span id="id18">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id12" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">34</a>]</span>),
and it is reported as
a GT5candidate if the solution meets the GT5 criteria.</p>
<p>Some important parameters are:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.SigmaThreshold"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.SigmaThreshold</span></code></a>: Residuals that exceed
<img class="math" src="../_images/math/07995ff78d6ae4e3ecb50d9c0740eb0addf47d94.png" alt="abs(Sigmathreshold * PriorMeasError)"/> are made non-defining.</p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.MinNdefPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinNdefPhases</span></code></a>: Minimum number of observations
required to attempt for a solution.</p></li>
</ul>
<p>If the number of defining arrival times exceed
<a class="reference internal" href="#confval-iLoc.profile.-name.MinNdefPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinNdefPhases</span></code></a>, then slowness observations will not
be used in the location.</p>
</section>
</section>
<section id="integration-into-scname">
<h3>Integration into <cite>SeisComP</cite><a class="headerlink" href="#integration-into-scname" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Integration of iLoc into <cite>SeisComP</cite> is provided by an external library of
routines (<span id="id19"></span>).</p></li>
<li><p><cite>SeisComP</cite> modules call iLoc routines by passing the objects via the plugin
<em>lociloc</em> installed in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/plugins/lociloc.so</span></code>.</p></li>
<li><p>iLoc returns objects to <cite>SeisComP</cite> for integration.</p></li>
<li><p>The iLoc implementation in <cite>SeisComP</cite> retains all original iLoc functionalities.</p></li>
</ul>
<p>Read the section <a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a> for the installation of the iLoc library and
the configuration in <cite>SeisComP</cite>.</p>
</section>
<section id="velocity-models">
<h3>Velocity models<a class="headerlink" href="#velocity-models" title="Permalink to this heading"></a></h3>
<p>iLoc ships with the global models <em>iasp91</em> and <em>ak135</em> as well as with regional
seismic travel-time tables, RSTT, which, if activated by configuration, replaces
the global models in areas where they are defined.</p>
<section id="global-models">
<span id="iloc-velocity-global"></span><h4>Global models<a class="headerlink" href="#global-models" title="Permalink to this heading"></a></h4>
<p>The global models <em>iasp91</em> and <em>ak135</em> and RSTT are available by default without
further configuration.</p>
</section>
<section id="rstt">
<span id="iloc-velocity-rstt"></span><h4>RSTT<a class="headerlink" href="#rstt" title="Permalink to this heading"></a></h4>
<p>RSTT are available in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/RSTTmodels/pdu202009Du.geotess</span></code>.
Custom RSTT can be integrated into iLoc and provided to <cite>SeisComP</cite>.
For adding custom RSTT to iLoc read the original iLoc documentation from the
<span id="id20"></span> software repository.</p>
<p>The usage of RSTT is controlled per iLoc profile by global configuration
parameters</p>
<ul class="simple">
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTT"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTT</span></code></a></p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPnSn"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPnSn</span></code></a></p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPgLg"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPgLg</span></code></a></p></li>
</ul>
</section>
<section id="local-velocity-models">
<span id="iloc-velocity-local"></span><h4>Local velocity models<a class="headerlink" href="#local-velocity-models" title="Permalink to this heading"></a></h4>
<p>Custom local velocity models can be provided by a file in
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/localmodels</span></code>. Example file
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/localmodels/test.localmodel.dat</span></code>:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="c1">#</span>
<span class="c1"># test</span>
<span class="c1">#</span>
<span class="c1"># number of layers</span>
<span class="na">4</span>
<span class="w"> </span><span class="na">0.000</span><span class="w"> </span><span class="s">5.8000 3.4600 x</span>
<span class="w"> </span><span class="na">20.000</span><span class="w"> </span><span class="s">6.5000 3.8500 CONRAD</span>
<span class="w"> </span><span class="na">45.000</span><span class="w"> </span><span class="s">8.0400 4.4800 MOHO</span>
<span class="w"> </span><span class="na">77.500</span><span class="w"> </span><span class="s">8.0400 4.4800 x</span>
</pre></div>
</div>
<p>Once added, the velocity can be configured in <cite>SeisComP</cite> as set out in section
<a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a>.</p>
</section>
</section>
<section id="station-elevation">
<h3>Station elevation<a class="headerlink" href="#station-elevation" title="Permalink to this heading"></a></h3>
<p>iLoc considers station elevation. It calculates the elevation correction,
<em>elevationCorrection</em>, for a station as</p>
<div class="math">
<p><img src="../_images/math/5f9c3c10facedc7a9d6e72dcdc5f421acb20e77c.png" alt="elevationCorrection = \frac{\sqrt{1 - (surfVel * p)^2} * elev}{surfVel}"/></p>
</div><p>where</p>
<ul class="simple">
<li><p><em>elev</em>: elevation of the station</p></li>
<li><p><em>p</em>: the ray parameter (horizontal slowness)</p></li>
<li><p><em>surfVel</em>: layer P or S velocity of at the surface depending on the last lag
of the phase name.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>iLoc does not allow airquakes or source locations above datum (0 km). If the
depth of an origin becomes negative, iLoc
fixes the depth to 0 km and the depth type of the origin will be “operator
assigned”.</p>
</div>
</section>
<section id="resources">
<span id="sec-iloc-references"></span><h3>Resources<a class="headerlink" href="#resources" title="Permalink to this heading"></a></h3>
<p>iLoc has taken advantage of many publications or has been cited therein.
Read the section <a class="reference internal" href="../base/references.html#sec-references"><span class="std std-ref">References</span></a> for a list.</p>
</section>
</section>
<section id="setup-in-scname">
<span id="iloc-setup"></span><h2>Setup in <cite>SeisComP</cite><a class="headerlink" href="#setup-in-scname" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Add the plugin <em>lociloc</em> to the global configuration, e.g. in
<code class="file docutils literal notranslate"><span class="pre">&#64;SYSTEMCONFIGDIR&#64;/global.cfg</span></code>:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">${plugins}, lociloc</span>
</pre></div>
</div>
</li>
<li><p>Install the dependencies missing for iLoc. For download, the system variable
<em>SEISCOMP_ROOT</em> must be defined which you may wish to test first:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="nv">$SEISCOMP_ROOT</span>
</pre></div>
</div>
<p>In case the variable is undefined, follow the instructions in section
<span class="xref std std-ref">getting-started-variables</span>.</p>
<p>After <em>$SEISCOMP_ROOT</em> is defined you may install the software dependencies
for iLoc using the <a class="reference internal" href="../base/installation.html#software-dependencies"><span class="std std-ref">install scripts</span></a> or simply
the <a class="reference internal" href="seiscomp.html#seiscomp"><span class="std std-ref">seiscomp</span></a> script:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>install-deps<span class="w"> </span>iloc
</pre></div>
</div>
<p>The install scripts will fetch auxiliary files from <span id="id21"></span>
and install them in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/iLocAuxDir</span></code>. For manual download and
installation read the install scripts located in
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/deps/[os]/[version]/install-iloc.sh</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>Check the <span id="id22"></span> website for updates before downloading
the file since the version number, hence the name of the download file
may change.</p></li>
<li><p>Instead of generating the <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/share/iloc/iLocAuxDir</span></code>
directory, you can also manually install the dependencies somewhere else,
create a symbolic link and maintain always the same iLoc version in
<cite>SeisComP</cite> and externally.</p></li>
</ul>
</div>
</li>
<li><p>Add and configure iLoc profiles for the velocity models. The global models
<em>iasp91</em> and <em>ak135</em> are considered by default with default configuration
parameters even without setting up <em>iasp91</em>/<em>ak135</em> profiles. You may,
however, create these profiles for their customization.</p>
<p>Create new profiles or consider existing ones for adjusting their
configuration:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.globalModel"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.globalModel</span></code></a>: The name of the
<a class="reference internal" href="#iloc-velocity-global"><span class="std std-ref">global model</span></a>, e.g. <em>iasp91</em> or <em>ak135</em>.</p></li>
<li><p>Consider the <a class="reference internal" href="#iloc-velocity-rstt"><span class="std std-ref">RSTT parameters</span></a>.</p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.LocalVmodel"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.LocalVmodel</span></code></a>, <a class="reference internal" href="#confval-iLoc.profile.-name.UseLocalTT"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseLocalTT</span></code></a>
and <a class="reference internal" href="#confval-iLoc.profile.-name.MaxLocalTTDelta"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MaxLocalTTDelta</span></code></a>: The definition of a
<a class="reference internal" href="#iloc-velocity-local"><span class="std std-ref">local velocity model</span></a>: model file, default
usability, distance range.</p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.DoNotRenamePhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.DoNotRenamePhases</span></code></a>: Renaming seismic phases
automatically
impacts the usability of the origins with other locators and locator profiles.
Activate the parameter to avoid phase renaming.</p></li>
<li><p>Consider the remaining parameters.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Creating the profiles allows using the same global velocity model along
with different local models or RSTT settings in separate profiles.</p>
</div>
</li>
<li><p>Test the locator using <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or configure with <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> or other
locator modules.</p></li>
</ol>
</section>
<section id="application-in-scname">
<span id="iloc-application"></span><h2>Application in <cite>SeisComP</cite><a class="headerlink" href="#application-in-scname" title="Permalink to this heading"></a></h2>
<p>Once the <em>lociloc</em> plugin is configured, the iLoc locator can be applied</p>
<ul class="simple">
<li><p>Automatically e.g. in <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> or</p></li>
<li><p>Interactively in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>.</p></li>
</ul>
<p>For using iLoc in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> select it in the locator menu of the Location tab</p>
<figure class="align-center" id="id23">
<img alt="../_images/scolv-iloc-locator.png" src="../_images/scolv-iloc-locator.png" />
<figcaption>
<p><span class="caption-text">Select iLoc locator</span><a class="headerlink" href="#id23" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>along with a profile:</p>
<figure class="align-center" id="id24">
<img alt="../_images/scolv-iloc-profile.png" src="../_images/scolv-iloc-profile.png" />
<figcaption>
<p><span class="caption-text">Select iLoc profile</span><a class="headerlink" href="#id24" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>The parameters for iLoc can be adjusted by pressing the wrench button next to the
locator selection combo box</p>
<figure class="align-center" id="id25">
<img alt="../_images/scolv-iloc-change.png" src="../_images/scolv-iloc-change.png" />
<figcaption>
<p><span class="caption-text">Start the settings dialog</span><a class="headerlink" href="#id25" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>which opens the iLoc settings dialog:</p>
<figure class="align-center" id="id26">
<img alt="../_images/scolv-iloc-settings.png" src="../_images/scolv-iloc-settings.png" />
<figcaption>
<p><span class="caption-text">Adjust the settings and click OK to confirm</span><a class="headerlink" href="#id26" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>By default, automatic phase renaming by iLoc is active. The renaming may
change the phase names, e.g. from P to Pn.</p>
<p>Renaming seismic phases automatically will later impact the usability of
the new origins with other locators and locator
profiles. Deactivate <em>DoNotRenamePhases</em> to avoid phase renaming.</p>
<p>However,
when deactivating, iLoc may not provide results if the initial phases do not
exist in the phase table for the given source depth and epicentral distance.
Example: For great source depth and small epicentral distance, the first arrival
phase is p or Pn and not P but <cite>SeisComP</cite> provides P.</p>
</div>
<p>After relocating, the iLoc locator and the selected profile are shown in the
<a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> Location tab as Method and Earth model, respectively:</p>
<figure class="align-center" id="id27">
<img alt="../_images/scolv-iloc-info.png" src="../_images/scolv-iloc-info.png" />
<figcaption>
<p><span class="caption-text">Information in scolv Locator tab</span><a class="headerlink" href="#id27" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="module-configuration">
<span id="global-iloc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>iLoc.*</strong>
<em>Locator parameters: iLoc</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.auxDir">
<span class="sig-name descname"><span class="pre">iLoc.auxDir</span></span><a class="headerlink" href="#confval-iLoc.auxDir" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/iLocAuxDir</span></code></p>
<p>Type: <em>string</em></p>
<p>iLoc directory for auxialiary files and directories. Some
of them must be provided from the iLoc website. Read the
documentation for their installation.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.usePickUncertainties">
<span class="sig-name descname"><span class="pre">iLoc.usePickUncertainties</span></span><a class="headerlink" href="#confval-iLoc.usePickUncertainties" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to use pick time uncertainties (true) or to use the
default timing error (false).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.defaultTimeError">
<span class="sig-name descname"><span class="pre">iLoc.defaultTimeError</span></span><a class="headerlink" href="#confval-iLoc.defaultTimeError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">9999999</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>The default pick time error forwarded to iLoc if no pick time
uncertainties are set or if using the pick time uncertainties
is disabled.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profiles">
<span class="sig-name descname"><span class="pre">iLoc.profiles</span></span><a class="headerlink" href="#confval-iLoc.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">iasp91,ak135</span></code></p>
<p>Type: <em>list:string</em></p>
<p>iLoc profile name.
Multiples names may be set separated by comma.
Each profile can have different velocity or parameters.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>iLoc.profile.*</strong>
<em>Profiles containing the specific locator parameters. For</em>
<em>the global models, iasp91 and ak135, profiles are</em>
<em>automatically considered with defaults.</em>
<em>To adjust the profile parameters the corresponding profile</em>
<em>must be created.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>iLoc.profile.$name.*</strong>
$name is a placeholder for the name to be used and needs to be added to <a class="reference internal" href="#confval-iLoc.profiles"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profiles</span></code></a> to become active.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>iLoc.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>a,b
iLoc.profile.a.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
iLoc.profile.b.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
<span class="c1"># c is not active because it has not been added</span>
<span class="c1"># to the list of iLoc.profiles</span>
iLoc.profile.c.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.Verbose">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.Verbose</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.Verbose" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.globalModel">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.globalModel</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.globalModel" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Name of globally applied velocity model
into which RSTT or the local model is integrated. If
unset, the name of the profile is considered instead.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.UseRSTT">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseRSTT</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseRSTT" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use regional seismic travel-time tables</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.UseRSTTPnSn">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseRSTTPnSn</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseRSTTPnSn" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use regional seismic travel-time tables for Pn and Sn</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.UseRSTTPgLg">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseRSTTPgLg</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseRSTTPgLg" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use regional seismic travel-time tables for Pg and Lg</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.UseLocalTT">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseLocalTT</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseLocalTT" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use local velocity model if defined in LocalVmodel.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.LocalVmodel">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.LocalVmodel</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.LocalVmodel" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Full path to a file containing the local velocity model.
Requires: UseLocalTT = true. Empty string or unset or
UseLocalTT = false disables using a local model in
this profile.</p>
<p>Example:</p>
<p>&#64;DATADIR&#64;/iloc/iLocAuxDir/localmodels/model.localmodel.dat.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxLocalTTDelta">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxLocalTTDelta</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxLocalTTDelta" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum epicentral distance for applying the local
velocity model.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.DoGridSearch">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.DoGridSearch</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.DoGridSearch" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Perform neighbourhood algorithm</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAsearchRadius">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAsearchRadius</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAsearchRadius" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Neighbourhood Algorithm: Search radius around initial
epicentre</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAsearchDepth">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAsearchDepth</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAsearchDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>km</em></p>
<p>Neighbourhood Algorithm: Search radius around initial
depth</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAsearchOT">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAsearchOT</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAsearchOT" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>s</em></p>
<p>Neighbourhood Algorithm: Search radius around initial
origin time</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAlpNorm">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAlpNorm</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAlpNorm" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>float</em></p>
<p>Neighbourhood Algorithm: p-value for norm to compute
misfit [1,2]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAiterMax">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAiterMax</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAiterMax" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Maximum number of iterations</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAcells">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAcells</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAcells" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">25</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Number of cells to be resampled
at each iteration</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAinitialSample">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAinitialSample</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAinitialSample" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Size of initial sample</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAnextSample">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAnextSample</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAnextSample" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Size of subsequent samples</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinDepthPhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinDepthPhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinDepthPhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of depth phases for depdp</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxLocalDistDeg">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxLocalDistDeg</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxLocalDistDeg" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.2</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Depth resolution: Maximum local distance</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinLocalStations">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinLocalStations</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinLocalStations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of local defining stations</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxSPDistDeg">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxSPDistDeg</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxSPDistDeg" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">2.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Depth resolution: Maximum distance for using S-P travel-time differences.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinSPpairs">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinSPpairs</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinSPpairs" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of defining S-P phase pairs</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinCorePhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinCorePhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinCorePhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of defining core reflection phases</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxShallowDepthError">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxShallowDepthError</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxShallowDepthError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>km</em></p>
<p>Depth resolution: Maximum depth error for crustal free-depth</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxDeepDepthError">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxDeepDepthError</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxDeepDepthError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">60.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>km</em></p>
<p>Depth resolution: Maximum depth error for deep free-depth</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.DoCorrelatedErrors">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.DoCorrelatedErrors</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.DoCorrelatedErrors" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Linearized inversion: Account for correlated errors</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.SigmaThreshold">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.SigmaThreshold</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.SigmaThreshold" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">6.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>s</em></p>
<p>Linearized inversion: Used to exclude big residuals from solution</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.AllowDamping">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.AllowDamping</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.AllowDamping" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Linearized inversion: Allow damping of model vector</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinIterations">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinIterations</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinIterations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">4</span></code></p>
<p>Type: <em>integer</em></p>
<p>Linearized inversion: Minimum number of iterations</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxIterations">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxIterations</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxIterations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>integer</em></p>
<p>Linearized inversion: Maximum number of iterations</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinNdefPhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinNdefPhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinNdefPhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">4</span></code></p>
<p>Type: <em>integer</em></p>
<p>Linearized inversion: Minimum number of defining phases</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.DoNotRenamePhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.DoNotRenamePhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.DoNotRenamePhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Linearized inversion: Do not rename phases. Deactivating
allows to rename the phases automatically for this
profile.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">iLoc</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#background">Background</a></li>
<li><a class="reference internal" href="#history">History</a></li>
<li><a class="reference internal" href="#iloc-in-a-nutshell">iLoc in a nutshell</a></li>
<li><a class="reference internal" href="#algorithms">Algorithms</a><ul>
<li><a class="reference internal" href="#neighbourhood-algorithm">Neighbourhood algorithm</a></li>
<li><a class="reference internal" href="#depth-resolution">Depth resolution</a></li>
<li><a class="reference internal" href="#linearized-inversion">Linearized inversion</a></li>
</ul>
</li>
<li><a class="reference internal" href="#integration-into-scname">Integration into <cite>SeisComP</cite></a></li>
<li><a class="reference internal" href="#velocity-models">Velocity models</a><ul>
<li><a class="reference internal" href="#global-models">Global models</a></li>
<li><a class="reference internal" href="#rstt">RSTT</a></li>
<li><a class="reference internal" href="#local-velocity-models">Local velocity models</a></li>
</ul>
</li>
<li><a class="reference internal" href="#station-elevation">Station elevation</a></li>
<li><a class="reference internal" href="#resources">Resources</a></li>
</ul>
</li>
<li><a class="reference internal" href="#setup-in-scname">Setup in <cite>SeisComP</cite></a></li>
<li><a class="reference internal" href="#application-in-scname">Application in <cite>SeisComP</cite></a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mlh.html"
title="previous chapter">MLh</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mn.html"
title="next chapter">MN</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_iloc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,267 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>LocExt &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="LocRouter" href="global_locrouter.html" />
<link rel="prev" title="StdLoc" href="global_stdloc.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">6.9.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="global_locrouter.html" title="LocRouter"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_stdloc.html" title="StdLoc"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="locext">
<span id="global-locext"></span><h1>LocExt<a class="headerlink" href="#locext" title="Permalink to this heading"></a></h1>
<p>Locator which forwards the processing to external scripts</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The ExternalLocator implements a wrapper for scripts which do the actual location
process. The input and output are represented as XML and communicated via the
input/output channels of the called process: stdin and stdout.</p>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>To enable the ExternalLocator the plugin <code class="docutils literal notranslate"><span class="pre">locext</span></code> must be loaded.</p>
</section>
<section id="commandline-parameters">
<h2>Commandline Parameters<a class="headerlink" href="#commandline-parameters" title="Permalink to this heading"></a></h2>
<p>There are several commandline parameters passed to the script depending on
the locator configuration. The following table summarizes them.</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>max-dist=X</p></td>
<td><p>The cut-off distance if set</p></td>
</tr>
<tr class="row-odd"><td><p>ignore-initial-location</p></td>
<td><p>Whether to ignore the initial origin location or not</p></td>
</tr>
<tr class="row-even"><td><p>fixed-depth=X</p></td>
<td><p>The depth in km to be fixed if enabled</p></td>
</tr>
</tbody>
</table>
</section>
<section id="input">
<h2>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h2>
<p>The input document written to stdin of the child process is a valid SeisComP
XML document containing <code class="docutils literal notranslate"><span class="pre">EventParameters</span></code>. The event parameters hold exactly
one origin to be relocated and all picks references from the origins arrivals.</p>
<p>Example:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;seiscomp xmlns=&quot;http://geofon.gfz-potsdam.de/ns/seiscomp3-schema/0.11&quot; version=&quot;0.11&quot;&gt;
&lt;EventParameters&gt;
&lt;pick ...&gt;...&lt;/pick&gt;
&lt;pick ...&gt;...&lt;/pick&gt;
...
&lt;origin ...&gt;
...
&lt;arrival&gt;
...
&lt;/arrival&gt;
&lt;arrival&gt;
...
&lt;/arrival&gt;
...
&lt;/origin&gt;
&lt;/EventParameters&gt;
&lt;/seiscomp&gt;
</pre></div>
</div>
</section>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h2>
<p>The output is read from stdout and is expected to be a SeisComP XML document
just containing an origin.</p>
<p>Example:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
<span class="nt">&lt;seiscomp</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://geofon.gfz-potsdam.de/ns/seiscomp3-schema/0.11&quot;</span><span class="w"> </span><span class="na">version=</span><span class="s">&quot;0.11&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;Origin</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;...&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Origin&gt;</span>
<span class="nt">&lt;/seiscomp&gt;</span>
</pre></div>
</div>
</section>
<section id="example-configuration">
<h2>Example Configuration<a class="headerlink" href="#example-configuration" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Define the external locator by global configuration e.g. in <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>plugins = ${plugins}, locext
ExternalLocator.profiles = locator1:&quot;python /path/to/locator/script1.py&quot;,\
locator2:&quot;/path/to/other/locator/script1.sh&quot;
</pre></div>
</div>
<p>with</p>
<ul class="simple">
<li><p><em>locator1</em>/<em>locator2</em>: The names of the profiles as shown in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>
or use in ther modules like <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> for calling the external locator,</p></li>
<li><p><em>script1.py</em>/<em>script2.sh</em>: The names of Python/Bash scripts with full path
called by the profile to execute the locator given within the scripts.</p></li>
</ul>
</li>
<li><p>Once defined, the external locator can be further configured and called
within <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or by other modules e.g. <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a>.</p></li>
</ol>
</section>
<section id="module-configuration">
<span id="global-locext-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>ExternalLocator.*</strong>
<em>Locator parameters: External. This locator requires the plugin</em>
<em>“locext” to be loaded.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ExternalLocator.profiles">
<span class="sig-name descname"><span class="pre">ExternalLocator.profiles</span></span><a class="headerlink" href="#confval-ExternalLocator.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>A list of profiles defined as tuples of name
and path to a script separated by colon.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">LocExt</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#commandline-parameters">Commandline Parameters</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
<li><a class="reference internal" href="#example-configuration">Example Configuration</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_stdloc.html"
title="previous chapter">StdLoc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_locrouter.html"
title="next chapter">LocRouter</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_locext.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,354 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>LocRouter &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="RecordStream" href="global_recordstream.html" />
<link rel="prev" title="LocExt" href="global_locext.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">6.9.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="global_recordstream.html" title="RecordStream"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_locext.html" title="LocExt"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="locrouter">
<span id="global-locrouter"></span><h1>LocRouter<a class="headerlink" href="#locrouter" title="Permalink to this heading"></a></h1>
<p>Meta locator routing location requests of picks and origins to actual
locator implementations.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Router is a meta locator which selects an actual
<a class="reference internal" href="../base/concepts/locators.html#concepts-locators"><span class="std std-ref">locator</span></a> based on region profiles configured in
GeoJSON or BNA files.</p>
<p>The locator supports both, the initial location based on a pick set and the
relocation based on an existing origin. In case no origin is available an
initial solution is calculated by a configurable locator followed by a
relocation configured through region profiles.</p>
</section>
<section id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading"></a></h2>
<p>The Router locator offers configuration by global module parameters.</p>
<section id="plugin">
<h3>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h3>
<p>Add the plugin <code class="docutils literal notranslate"><span class="pre">locrouter</span></code> to <a class="reference internal" href="global.html#confval-plugins"><code class="xref std std-confval docutils literal notranslate"><span class="pre">plugins</span></code></a> for activating the Router
locator. Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,locrouter
</pre></div>
</div>
</section>
<section id="initial-locator">
<h3>Initial locator<a class="headerlink" href="#initial-locator" title="Permalink to this heading"></a></h3>
<p>For routing, an initial source location is required. When only picks but no
origins are provided, the initial location is unknown but it can be defined by
an initial locator independent of location. Set
<a class="reference internal" href="#confval-RouterLocator.initial.locator"><code class="xref std std-confval docutils literal notranslate"><span class="pre">RouterLocator.initial.locator</span></code></a> and
<a class="reference internal" href="#confval-RouterLocator.initial.profile"><code class="xref std std-confval docutils literal notranslate"><span class="pre">RouterLocator.initial.profile</span></code></a> for defining the initial locator.</p>
</section>
<section id="region-configuration">
<h3>Region Configuration<a class="headerlink" href="#region-configuration" title="Permalink to this heading"></a></h3>
<p>Regions may be considered by configuring their names in
<a class="reference internal" href="#confval-RouterLocator.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">RouterLocator.regions</span></code></a>. The regions themselves are defined as polygons
files in either <a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-geojson"><span class="std std-ref">GeoJSON</span></a> or
<a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-bna"><span class="std std-ref">BNA</span></a> format. Supported polygon
attributes are:</p>
<ul class="simple">
<li><p>name (recommended): Name of polygon. An empty string is assumed if not given.</p></li>
<li><p>locator (mandatory): Name of the locator interface to use.</p></li>
<li><p>profile: Name of the locator-specific profile which must be configured
according to the selected locator.</p></li>
<li><p>minDepth: Minimum depth in km the profile should be applied to.</p></li>
<li><p>maxDepth: Maximum depth in km the profile should be applied to.</p></li>
</ul>
<p>The configured features are sorted by rank and area. Larger ranks and smaller
areas are prioritized.</p>
<p>Example <a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-geojson"><span class="std std-ref">GeoJSON file</span></a>:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;FeatureCollection&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;features&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Feature&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;properties&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Iceland&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;minDepth&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;maxDepth&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;locator&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;LOCSAT&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;profile&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;iceland&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;geometry&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Polygon&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;coordinates&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mf">-24.5469</span><span class="p">,</span><span class="w"> </span><span class="mf">63.3967</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mf">-13.4958</span><span class="p">,</span><span class="w"> </span><span class="mf">63.3967</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mf">-13.4958</span><span class="p">,</span><span class="w"> </span><span class="mf">66.5667</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mf">-24.5469</span><span class="p">,</span><span class="w"> </span><span class="mf">66.5667</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mf">-24.5469</span><span class="p">,</span><span class="w"> </span><span class="mf">63.3967</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Feature&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;properties&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;World&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;locator&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;LOCSAT&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;profile&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;iasp91&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;geometry&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Polygon&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;coordinates&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">-33</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">-180</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">-180</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">-33</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">33</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">180</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">180</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">33</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="mi">-33</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Example <a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-bna"><span class="std std-ref">BNA file</span></a>:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">&quot;Iceland&quot;,</span><span class="w"> </span><span class="s">&quot;rank 1&quot;, &quot;minDepth: 0, maxDepth: 30, locator: LOCSAT, profile: iceland&quot;, 4</span>
<span class="na">-24.5469,</span><span class="w"> </span><span class="s">63.3967</span>
<span class="na">-13.4958,</span><span class="w"> </span><span class="s">63.3967</span>
<span class="na">-13.4958,</span><span class="w"> </span><span class="s">66.5667</span>
<span class="na">-24.5469,</span><span class="w"> </span><span class="s">66.5667</span>
<span class="na">&quot;World&quot;,</span><span class="w"> </span><span class="s">&quot;rank 1&quot;, &quot;locator: LOCSAT, profile: iasp91&quot;, 8</span>
<span class="na">-33,</span><span class="w"> </span><span class="s">90</span>
<span class="na">-180,</span><span class="w"> </span><span class="s">90</span>
<span class="na">-180,</span><span class="w"> </span><span class="s">-90</span>
<span class="na">-33,</span><span class="w"> </span><span class="s">-90</span>
<span class="na">33,</span><span class="w"> </span><span class="s">-90</span>
<span class="na">180,</span><span class="w"> </span><span class="s">-90</span>
<span class="na">180,</span><span class="w"> </span><span class="s">90</span>
<span class="na">33,</span><span class="w"> </span><span class="s">90</span>
</pre></div>
</div>
</section>
</section>
<section id="application">
<h2>Application<a class="headerlink" href="#application" title="Permalink to this heading"></a></h2>
<p>Once configured, the Router locator may be used by other <cite>SeisComP</cite> modules such
as <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a>. Refer to the locator as “Router”.</p>
</section>
<section id="module-configuration">
<span id="global-locrouter-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>RouterLocator.*</strong>
<em>Locator parameters: Router. This locator requires the plugin</em>
<em>“locrouter” to be loaded.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-RouterLocator.regions">
<span class="sig-name descname"><span class="pre">RouterLocator.regions</span></span><a class="headerlink" href="#confval-RouterLocator.regions" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>A GeoJSON or BNA file defining locator profiles by region.
Supported polygon attributes:</p>
<p>name: Name of polygon</p>
<p>locator: Name of the locator interface</p>
<p>profile: Name of the locator specific profile</p>
<p>minDepth: Minimum depth in km</p>
<p>maxDepth: Minimum depth in km</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>RouterLocator.initial.*</strong>
<em>Configuration of initial locator used to create an</em>
<em>initial solution based on a pick set. If a solution is</em>
<em>found, relocate of the actual locator configured in the</em>
<em>region file is invoked.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-RouterLocator.initial.locator">
<span class="sig-name descname"><span class="pre">RouterLocator.initial.locator</span></span><a class="headerlink" href="#confval-RouterLocator.initial.locator" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Name of the initial locator interface, e.g., LOCSAT.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-RouterLocator.initial.profile">
<span class="sig-name descname"><span class="pre">RouterLocator.initial.profile</span></span><a class="headerlink" href="#confval-RouterLocator.initial.profile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Profile name of the initial locator, e.g., iasp91.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">LocRouter</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#setup">Setup</a><ul>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#initial-locator">Initial locator</a></li>
<li><a class="reference internal" href="#region-configuration">Region Configuration</a></li>
</ul>
</li>
<li><a class="reference internal" href="#application">Application</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_locext.html"
title="previous chapter">LocExt</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_recordstream.html"
title="next chapter">RecordStream</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_locrouter.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,432 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>LOCSAT &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="FixedHypocenter" href="global_fixedhypocenter.html" />
<link rel="prev" title="homogeneous" href="global_homogeneous.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">6.9.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="global_fixedhypocenter.html" title="FixedHypocenter"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_homogeneous.html" title="homogeneous"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="locsat">
<span id="global-locsat"></span><h1>LOCSAT<a class="headerlink" href="#locsat" title="Permalink to this heading"></a></h1>
<p>Locator in SeisComP for computing source time and hypocenter
coordinates from phase picks.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>LOCSAT is a locator with a travel-time interface in <cite>SeisComP</cite> for computing
source time and hypocenter coordinates from phase picks considering:</p>
<ul class="simple">
<li><p>Pick time and pick uncertainty,</p></li>
<li><p>Backazimuth and backazimuth uncertainty,</p></li>
<li><p>Slowness and slowness uncertainty,</p></li>
<li><p>Phase-specfic travel-time tables.</p></li>
</ul>
<p>The LOCSAT <a class="reference internal" href="#locsat-li"><span class="std std-ref">locator interface</span></a> implements a wrapper for the
LocSAT locator by <span id="id1">Bratt and Nagy [<a class="reference internal" href="../base/references.html#id21" title="S.R. Bratt and W. Nagy. The LocSAT Program. Science Applications International Corporation (SAIC), San Diego, 1991.">42</a>]</span> (according to the README file shipped
with the LocSAT distribution) referred to as <strong>LOCSAT</strong> in <cite>SeisComP</cite>. The LOCSAT
<a class="reference internal" href="#locsat-tti"><span class="std std-ref">travel-time interface</span></a> provides travel time for specfic
phases, epicentral distance, soure depth and station elevation.</p>
</section>
<section id="locator-interface">
<span id="locsat-li"></span><h2>Locator Interface<a class="headerlink" href="#locator-interface" title="Permalink to this heading"></a></h2>
<p>LOCSAT provides the hypocenter parameters through the locator interface.</p>
</section>
<section id="travel-time-interface">
<span id="locsat-tti"></span><h2>Travel-Time Interface<a class="headerlink" href="#travel-time-interface" title="Permalink to this heading"></a></h2>
<p>LOCSAT provides an interface for computing travel times based on coordinates and
depth. The times are plotted on waveforms, e.g., blue marks in
<a class="reference internal" href="scolv.html#scolv-sec-waveform-review"><span class="std std-ref">scolv picker window</span></a>.</p>
<p>Use “LOCSAT” as a value for the travel-time interface when configurable, e.g.,
by <a class="reference internal" href="global_fixedhypocenter.html#global-fixedhypocenter"><span class="std std-ref">FixedHypocenter</span></a>.</p>
</section>
<section id="travel-time-tables">
<span id="locsat-ttt"></span><h2>Travel-Time Tables<a class="headerlink" href="#travel-time-tables" title="Permalink to this heading"></a></h2>
<p><cite>SeisComP</cite> ships with two sets of predefined travel-time tables which are
made available as the profiles tab and iasp91.</p>
<p>The default profile is <em>iasp91</em>.</p>
<p>LOCSAT travel time tables are located as plain ascii files under
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/locsat/tables/</span></code>.
The tables provide the travel times for particular seismic phases at
given depth and epicentral distance in one file per Earth model and seismic
phase. E.g. P-wave arrival times in the iasp91 model are found in
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/locsat/tables/iasp91.P</span></code>. You may easily add your own tables
for any available Earth model and seismic phase by adopting existing ones in new
files which are added by <a class="reference internal" href="#locsat-station-application"><span class="std std-ref">configuration</span></a> to
your <cite>SeisComP</cite> modules.</p>
<section id="limitations">
<h3>Limitations<a class="headerlink" href="#limitations" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Only phases for which a travel-time table exists can be considered.</p></li>
<li><p>LOCSAT currently considers travel-time tables for phases which are hard-coded</p>
<ul>
<li><p>seismic body waves: P, Pg, Pb, Pn, Rg, pP, sP, PKP, PP, PKPab, PKPbc, PKPdf,
SKPdf, PcP,
S, Sg, Sb, Sn, Lg, SKS, SS, ScS,</p>
<p>where P and S are the direct P and S phases, respectively, at all distances
no matter the take-off angle at the source.</p>
</li>
<li><p>seismic surface waves: LQ, LR.</p></li>
<li><p>infrasound: Is, It, Iw.</p></li>
</ul>
</li>
<li><p>The maximum number of distance and depth intervals per table file is
currently 210 and 50, respectively.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<ul class="simple">
<li><p>Travel-time tables with larger numbers of distance or depth samples are
reported along with command-line error output (stderr). The travel-time
tables should therefore be tested, e.g., with <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> before
unsupervised application.</p></li>
<li><p>Travel times at distance and depth samples exceeding the limits are
ignored. This may lead to undesired behavior during location.</p></li>
<li><p>Phase picks observed outside the distance and depth ranges defined by
travel-time tables may lead to undesired behavior during location.</p></li>
</ul>
</div>
</li>
<li><p>The considered minimum depth is 0 km. Elevations and depths above datum are
not natively considered. The effects of station elevation can be
<a class="reference internal" href="#locsat-station-elevation"><span class="std std-ref">corrected for empirically</span></a>.</p></li>
</ol>
</section>
<section id="station-elevations">
<span id="locsat-station-elevation"></span><h3>Station elevations<a class="headerlink" href="#station-elevations" title="Permalink to this heading"></a></h3>
<p>LOCSAT does not natively support corrections of travel-time tables for station
elevations. At least checking the code:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">sta_cor</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">0.0</span><span class="p">;</span><span class="w"> </span><span class="cm">/* FIX !!!!!!*/</span>
</pre></div>
</div>
<p>However, the <cite>SeisComP</cite> wrapper adds this feature. It allows to define a
<code class="file docutils literal notranslate"><span class="pre">.stacor</span></code> file which defines emperic corrections of observed travel times.
The corrections are provided in seconds and <strong>subtracted</strong> (not added) from
the observation time to be compatible with the NonLinLoc <span id="id2">[<a class="reference internal" href="../base/references.html#id171" title="A. Lomax. The NonLinLoc Software Guide. Manual. URL: http://alomax.free.fr/nlloc/.">52</a>]</span>
station correction definitions.</p>
<p>Each LOCSAT profile (travel time table) can have one associated station
correction file. E.g. for adding station corrections to the iasp91 tables, the
file <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/share/locsat/tables/iasp91.stacor</span></code> needs to be created.</p>
<p>A station correction table takes the form:</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span># LOCDELAY code phase numReadings delay
LOCDELAY GE.MORC P 1 -0.1
</pre></div>
</div>
<p>with</p>
<ul class="simple">
<li><p><strong>code</strong> (<em>string</em>) station code (after all alias evaluations)</p></li>
<li><p><strong>phase</strong> (<em>string</em>) phase type (any of the available travel time tables)</p></li>
<li><p><strong>numReadings</strong> (<em>integer</em>) number of residuals used to calculate mean residual/delay
(not used by NLLoc, included for compatibility with the format of a summary,
phase statistics file)</p></li>
<li><p><strong>delay</strong> (<em>float</em>) delay in seconds, subtracted from observed time</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The fourth column (numReadings) is ignored and just provided for compatibility
reasons with <a class="reference internal" href="global_nonlinloc.html#global-nonlinloc"><span class="std std-ref">NonLinLoc</span></a>.</p>
</div>
</section>
</section>
<section id="application-and-setup">
<span id="locsat-station-application"></span><h2>Application and Setup<a class="headerlink" href="#application-and-setup" title="Permalink to this heading"></a></h2>
<p>LOCSAT is the default and only locator for <a class="reference internal" href="scautoloc.html#scautoloc"><span class="std std-ref">scautoloc</span></a> with <em>iasp91</em> as the
default profile. However, LOCSAT can be used optionally in other modules such as
<a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a>.</p>
<section id="custom-travel-time-tables">
<span id="locsat-custom-ttt"></span><h3>Custom travel-time tables<a class="headerlink" href="#custom-travel-time-tables" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Generate your travel-time tables from a custom Earth model, depth and
distance intervals. Use the same format as the defaults as the <em>iasp91</em>
tables. Tools such as <span id="id3"><em>TauP</em> [<a class="reference internal" href="../base/references.html#id274" title="TauP. Toolkit for seismic travel times. URL: https://www.seis.sc.edu/taup/.">25</a>]</span> allow the generation.</p></li>
<li><p>Add your custom travel-time tables along with station corrections to
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/locsat/tables/</span></code></p></li>
<li><p>Add your available custom LOCSAT travel-time tables in global configuration,
e.g., to the list of tables of travel-time interfaces</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>ttt.LOCSAT.tables = iasp91, tab, custom
</pre></div>
</div>
<p>and to the list of locator profiles</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>LOCSAT.profiles = iasp91, tab, custom
</pre></div>
</div>
<p>and optionally to locators which make use of LOCSAT tables, e.g.,
<a class="reference internal" href="global_fixedhypocenter.html#global-fixedhypocenter"><span class="std std-ref">FixedHypocenter</span></a>.</p>
</li>
</ol>
</section>
<section id="application-with-modules">
<h3>Application with modules<a class="headerlink" href="#application-with-modules" title="Permalink to this heading"></a></h3>
<p>Additional parameters of LOCSAT may be configured in global module configuration
(<code class="xref std std-confval docutils literal notranslate"><span class="pre">LOCSAT.*</span></code>).</p>
<ul class="simple">
<li><p>The profiles for locating may be extended or limited by
<a class="reference internal" href="#confval-LOCSAT.profiles"><code class="xref std std-confval docutils literal notranslate"><span class="pre">LOCSAT.profiles</span></code></a>.</p></li>
<li><p>When using picks with time uncertainties, consider
<a class="reference internal" href="#confval-LOCSAT.usePickUncertainties"><code class="xref std std-confval docutils literal notranslate"><span class="pre">LOCSAT.usePickUncertainties</span></code></a> and <a class="reference internal" href="#confval-LOCSAT.defaultTimeError"><code class="xref std std-confval docutils literal notranslate"><span class="pre">LOCSAT.defaultTimeError</span></code></a>.</p></li>
<li><p>Measurements of backazimuth and slowness may be deactivated by
<code class="xref std std-confval docutils literal notranslate"><span class="pre">LOCSAT.useBackazimuth</span></code> and <code class="xref std std-confval docutils literal notranslate"><span class="pre">LOCSAT.useSlownewss</span></code>, respectively.
Such measurements may be obtained from array processing or from feature
extraction using <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>.</p></li>
</ul>
<p>You may also configure some <cite>SeisComP</cite> modules with LOCSAT and a profile.</p>
<ul class="simple">
<li><p><a class="reference internal" href="scautoloc.html#scautoloc"><span class="std std-ref">scautoloc</span></a>: Configure a profile for automatic locations,</p></li>
<li><p><a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a>: Configure <em>LOCSAT</em> along with a profile for automatically
relocating.</p></li>
<li><p><a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>: Configure <em>LOCSAT</em> along with a profile as defaults for
interactive locations.</p></li>
</ul>
<p>When using LOCSAT in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> you may interactively some settings. The
changes only apply during runtime.</p>
<figure class="align-center" id="id4">
<a class="reference internal image-reference" href="../_images/scolv-locsat-settings.png"><img alt="../_images/scolv-locsat-settings.png" src="../_images/scolv-locsat-settings.png" style="width: 10cm;" /></a>
<figcaption>
<p><span class="caption-text">scolv Location tab with LOCSAT selected and the settings menu.</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
</section>
<section id="module-configuration">
<span id="global-locsat-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>LOCSAT.*</strong>
<em>Locator parameters: LOCSAT</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.profiles">
<span class="sig-name descname"><span class="pre">LOCSAT.profiles</span></span><a class="headerlink" href="#confval-LOCSAT.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">iasp91,</span> <span class="pre">tab</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Defines a list of available LOCSAT travel-time tables.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.depthInit">
<span class="sig-name descname"><span class="pre">LOCSAT.depthInit</span></span><a class="headerlink" href="#confval-LOCSAT.depthInit" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20.0</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>The initial depth estimate for LOCSAT.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.usePickUncertainties">
<span class="sig-name descname"><span class="pre">LOCSAT.usePickUncertainties</span></span><a class="headerlink" href="#confval-LOCSAT.usePickUncertainties" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to use pick time untertainties for arrival deltim rather
than a fixed time error. If true then the uncertainties are
retrieved from each individual pick object. If they are not
defined then the default pick time uncertainty will be used
as fallback.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.defaultTimeError">
<span class="sig-name descname"><span class="pre">LOCSAT.defaultTimeError</span></span><a class="headerlink" href="#confval-LOCSAT.defaultTimeError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1.0</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>The default pick time uncertainty assigned to LOCSATs arrival deltim
attribute if pick uncertainties are not going to be used or
if they are absent. A time uncertainty of 0 s may result in
errors of the SVD decomposition in LOCSAT.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.usePickBackazimuth">
<span class="sig-name descname"><span class="pre">LOCSAT.usePickBackazimuth</span></span><a class="headerlink" href="#confval-LOCSAT.usePickBackazimuth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to forward pick backazimuth to LOCSAT or not. In an
automatic mode backazimuth measurements might be inaccurrate
and disabling their usage in LOCSAT can be controlled with
this parameter.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.usePickSlowness">
<span class="sig-name descname"><span class="pre">LOCSAT.usePickSlowness</span></span><a class="headerlink" href="#confval-LOCSAT.usePickSlowness" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to forward pick horizontal slowness to LOCSAT or not.
In an automatic mode slowness measurements might be
inaccurrate and disabling their usage in LOCSAT can be
controlled with this parameter.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.degreesOfFreedom">
<span class="sig-name descname"><span class="pre">LOCSAT.degreesOfFreedom</span></span><a class="headerlink" href="#confval-LOCSAT.degreesOfFreedom" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">9999</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of degrees of freedom.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.confLevel">
<span class="sig-name descname"><span class="pre">LOCSAT.confLevel</span></span><a class="headerlink" href="#confval-LOCSAT.confLevel" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.9</span></code></p>
<p>Type: <em>double</em></p>
<p>Confidence level between 0.5 and 1.0.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-LOCSAT.enableConfidenceEllipsoid">
<span class="sig-name descname"><span class="pre">LOCSAT.enableConfidenceEllipsoid</span></span><a class="headerlink" href="#confval-LOCSAT.enableConfidenceEllipsoid" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Compute the confidence ellipsoid from covariance matrix in 3D.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">LOCSAT</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#locator-interface">Locator Interface</a></li>
<li><a class="reference internal" href="#travel-time-interface">Travel-Time Interface</a></li>
<li><a class="reference internal" href="#travel-time-tables">Travel-Time Tables</a><ul>
<li><a class="reference internal" href="#limitations">Limitations</a></li>
<li><a class="reference internal" href="#station-elevations">Station elevations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#application-and-setup">Application and Setup</a><ul>
<li><a class="reference internal" href="#custom-travel-time-tables">Custom travel-time tables</a></li>
<li><a class="reference internal" href="#application-with-modules">Application with modules</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_homogeneous.html"
title="previous chapter">homogeneous</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_fixedhypocenter.html"
title="next chapter">FixedHypocenter</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_locsat.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,220 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>mb &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="ML_IDC" href="global_ml_idc.html" />
<link rel="prev" title="Ms_20" href="global_ms_20.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">6.9.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="global_ml_idc.html" title="ML_IDC"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_ms_20.html" title="Ms_20"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mb">
<span id="global-mb"></span><h1>mb<a class="headerlink" href="#mb" title="Permalink to this heading"></a></h1>
<p>Body wave magnitude at teleseismic distances</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>mb is the standard body-wave magnitude.
Compare also with the <a class="reference internal" href="global_mb_bb.html#global-mb-bb"><span class="std std-ref">mB magnitude</span></a>.</p>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>mb is defined on the amplitude of the first few cycles of the P-wave,
typically a time window of 20 s - 30 s. Only the first few cycles are used to
minimize the effects of radiation pattern and depth phases, which result in
complicate waveform signatures.
In <cite>SeisComP</cite> mb amplitudes are measured on vertical-component displacement seismograms
in a 30 s time window after simulation of a <a class="reference internal" href="../base/glossary.html#term-WWSSN_SP"><span class="xref std std-term">WWSSN_SP</span></a> short-period
seismometer. Amplitudes are used from stations with epicentral distances between
5° and 105° (configurable). The methods for measuring amplitudes are configurable
in the global bindings.</p>
</section>
<section id="station-magnitude">
<h3>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h3>
<p>The general formula is</p>
<div class="math">
<p><img src="../_images/math/557ff47b5e6e082cc7dd08a231e296efbdf54331.png" alt="mb = \log \left(\frac{A}{T}\right) + Q(h,\Delta) - 3.0"/></p>
</div><p>with A as the displacement amplitude in micrometers, T as the dominant period of
the signal in seconds, Q as a correction term for depth and distance. mb is
usually determined at periods around 1s in adaptation to the use
of the World-Wide Standard Seismograph Network (WWSSN) short-period stations.
A scatter in the order of +/- 0.3 for the station magnitudes is usual.
Typically, mb is determined for stations with distances larger than 5° to
have a distinct direct P-wave phase. A correction term for the distance has to
be determined empirically, which is quite complicate for distances smaller than 20°.
This reflects the complexity of the body waves that traverse only in the upper
mantle. mb saturates at about magnitude 5.5 to 6.0 because the maximum amplitudes of larger
earthquakes occur at lower frequencies than the frequency range between 0.7 Hz - 2 Hz
used for the magnitude calculation.</p>
<ul class="simple">
<li><p>Amplitude unit in <cite>SeisComP</cite>: <strong>nanometers</strong> (nm)</p></li>
<li><p>Time window: 30 s</p></li>
<li><p>Default distance range: 5 - 105 deg, configurable: <a class="reference internal" href="global.html#confval-magnitudes.mb.minDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mb.minDist</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.mb.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mb.maxDist</span></code></a></p></li>
<li><p>Depth range: no limitation, for depth &lt; 0 km, depth = 0 km is assumed</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In 2013 the IASPEI commission (<span id="id1">IASPEI [<a class="reference internal" href="../base/references.html#id40" title="IASPEI. Summary of magnitude working group recommendations on standard procedures for determining earthquake magnitudes from digital data. IASPEI Website, 2013. URL: http://www.iaspei.org/commissions/commission-on-seismological-observation-and-interpretation/Summary_WG_recommendations_20130327.pdf.">46</a>]</span>) recommended a minimum distance of
20 deg. However, <a class="reference internal" href="scautoloc.html#scautoloc"><span class="std std-ref">scautoloc</span></a> requires mb amplitudes by default for
considering a pick.
For maintaining consistency, 5 deg is therefore kept as the default
for <a class="reference internal" href="global.html#confval-magnitudes.mb.minDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mb.minDist</span></code></a>.</p>
</div>
</section>
<section id="network-magnitude">
<h3>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>By default, the trimmed mean is calculated from the station magnitudes to form
the <a class="reference internal" href="../base/glossary.html#term-network-magnitude"><span class="xref std std-term">network magnitude</span></a>. Outliers beyond the outer 12.5% percentiles are
removed before forming the mean.</p>
</section>
<section id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h3>
<p>Adjust the configurable parameters in global bindings in the mB section or use
<code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>
as in <a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a>. Add mb to the list of computed amplitudes and magnitudes
in the configuration of
<a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> and <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> and in <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>/<a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a>
for visibility.</p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">mb</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_ms_20.html"
title="previous chapter">Ms_20</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_ml_idc.html"
title="next chapter">ML_IDC</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mb.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,227 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>mB_BB &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="mb_IDC" href="global_mb_idc.html" />
<link rel="prev" title="MLv" href="global_mlv.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">6.9.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="global_mb_idc.html" title="mb_IDC"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mlv.html" title="MLv"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mb-bb">
<span id="global-mb-bb"></span><h1>mB_BB<a class="headerlink" href="#mb-bb" title="Permalink to this heading"></a></h1>
<p>Body wave magnitude at teleseismic distances similar to mb</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The <strong>mB</strong>/<strong>mB_BB</strong> magnitude has been recommended by the IASPEI commission
(<span id="id1">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span>, <span id="id2">Bormann and Saul [<a class="reference internal" href="../base/references.html#id19" title="P. Bormann and J. Saul. A Fast, Non-saturating Magnitude Estimator for Great Earthquakes. Seismol. Res. Lett., 80(5):808 - 816, 2009. doi:10.1785/gssrl.80.5.808.">39</a>]</span>, <span id="id3">IASPEI [<a class="reference internal" href="../base/references.html#id40" title="IASPEI. Summary of magnitude working group recommendations on standard procedures for determining earthquake magnitudes from digital data. IASPEI Website, 2013. URL: http://www.iaspei.org/commissions/commission-on-seismological-observation-and-interpretation/Summary_WG_recommendations_20130327.pdf.">46</a>]</span>).
It is based on amplitude measurements of body waves like <a class="reference internal" href="global_mb.html#global-mb"><span class="std std-ref">mb</span></a>, but
with the amplitude measured in a broad frequency range and longer time windows.
Instead of amplitude measurements on displacement data together with the
dominant period, the maximum velocity amplitude Vmax is taken directly from
velocity-proportional records with <img class="math" src="../_images/math/3e38ca2d603956fc616a5148453d32f873cfdbd0.png" alt="V = 2 \pi A/T"/>. The time window for
the measurement can be determined by the duration of the high-frequency (1-3 Hz)
radiation (<span id="id4">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span>). This time window usually contains the phases
P, pP, sP, PcP, but not PP. According to the long time window and broad
frequency range used for amplitude measurements mB saturates not like mb.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In <cite>SeisComP</cite> the term <strong>m_B</strong> is a synonym for <strong>mB_BB</strong> which is used
by IASPEI <span id="id5">[<a class="reference internal" href="../base/references.html#id40" title="IASPEI. Summary of magnitude working group recommendations on standard procedures for determining earthquake magnitudes from digital data. IASPEI Website, 2013. URL: http://www.iaspei.org/commissions/commission-on-seismological-observation-and-interpretation/Summary_WG_recommendations_20130327.pdf.">46</a>]</span>.</p>
</div>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>mB amplitudes are calculated on vertical-component displacement seismograms
in accordance with <span id="id6">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span> and similar to <a class="reference internal" href="global_mb.html#global-mb"><span class="std std-ref">mb</span></a>.
A default time window of 60 s is considered for amplitude measurements
at stations in the distance range of 5° to 105°.
If the epicentral is known, the length of the time window after the P wave onset
is</p>
<div class="math">
<p><img src="../_images/math/9d9190e1e9d976d40144e676d30933251d58b7a0.png" alt="t = min(\Delta * 11.5, 60)"/></p>
</div><p>where <img class="math" src="../_images/math/6450616b75212cb568e905db49efd0c3dd584648.png" alt="\Delta"/> is the epicentral distance. The methods for measuring
amplitudes are configurable in the global bindings.</p>
</section>
<section id="station-magnitude">
<h3>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h3>
<p>The mB station magnitudes are calculated in accordance with <span id="id7">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span>.</p>
<div class="math">
<p><img src="../_images/math/c4e29d7f89b54eff7de102b648e87d8c0f96afd6.png" alt="mB = \log \left(\frac{A}{2\Pi}\right) + Q(h,\Delta) - 3.0"/></p>
</div><p>with A as the displacement amplitude in micrometers, T as the dominant period of
the signal in seconds, Q as a correction term for depth and distance.</p>
<ul class="simple">
<li><p>Amplitude unit in <cite>SeisComP</cite>: <strong>nanometers/s</strong> (nm/s),</p></li>
<li><p>Time window: 60 s if set by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>, otherwise 0 s - 11.5 * distance
(deg) with 60 s minimum</p></li>
<li><p>Default distance range: 5 - 105 deg, configurable: <a class="reference internal" href="global.html#confval-magnitudes.mB.minDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mB.minDist</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.mB.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mB.maxDist</span></code></a>,</p></li>
<li><p>Depth range: no limitation.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In 2013 the IASPEI commission (<span id="id8">IASPEI [<a class="reference internal" href="../base/references.html#id40" title="IASPEI. Summary of magnitude working group recommendations on standard procedures for determining earthquake magnitudes from digital data. IASPEI Website, 2013. URL: http://www.iaspei.org/commissions/commission-on-seismological-observation-and-interpretation/Summary_WG_recommendations_20130327.pdf.">46</a>]</span>) recommended a minimum
distance of
20 deg. However, the calibration formula (<span id="id9">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span>) which is
integrated in
<cite>SeisComP</cite> allows the extension down to 5 deg while maintaining consistent magnitudes
at 20 deg and beyond. Therefore, 5 deg is used as the default in
<a class="reference internal" href="global.html#confval-magnitudes.mB.minDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mB.minDist</span></code></a>.</p>
</div>
</section>
<section id="network-magnitude">
<h3>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>By default, the trimmed mean is calculated from the station magnitudes to form
the <a class="reference internal" href="../base/glossary.html#term-network-magnitude"><span class="xref std std-term">network magnitude</span></a>. Outliers beyond the outer 12.5% percentiles are
removed before forming the mean.</p>
</section>
<section id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h3>
<p>Adjust the configurable parameters in global bindings in the mB section or use
<code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>
as <a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a>. Add mB to the list of computed amplitudes and magnitudes
in the configuration of
<a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> and <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> and in <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> for visibility.</p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">mB_BB</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mlv.html"
title="previous chapter">MLv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mb_idc.html"
title="next chapter">mb_IDC</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mb_bb.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>mb_IDC &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="FX-DFX" href="global_fx-dfx.html" />
<link rel="prev" title="mB_BB" href="global_mb_bb.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">6.9.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="global_fx-dfx.html" title="FX-DFX"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mb_bb.html" title="mB_BB"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mb-idc">
<span id="global-mb-idc"></span><h1>mb_IDC<a class="headerlink" href="#mb-idc" title="Permalink to this heading"></a></h1>
<p>Body wave magnitude computed at CTBTO/IDC (mb) is calculated for seismic
events from the time-defining primary body waves recorded at seismic
stations at an epicentral distance between 20 and 105 degrees
from the event.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>The A5/2 amplitudes are calculated on the vertical component seismograms filtered
between 0.8 and 4.5 Hz and converted to displacement.</p>
</section>
<section id="station-magnitude">
<h3>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h3>
<div class="math">
<p><img src="../_images/math/be87b4ff8e5530b3bf22b3e2f2d2f23b57c93bf4.png" alt="mag = \log10(\frac{A}{T}) + Q(\Delta,h)"/></p>
</div><p>with</p>
<p>A: amplitude of type A5/2</p>
<p>T: period of the signal in seconds</p>
<p>Q: attenuation correction function of event distance and event depth</p>
<p>h: event depth in km</p>
<p>The attenuation corrections as a function of distance and depth are based on
(Veith, K. F., and Clawson, G. E., 1972). The corrections are tabulated every
degree for distances out to 180 degrees and for depths 0, 15, 40 km, and
100-800 km in steps of 100 km. Bi-cubic splines were used for interpolating the
tables. The tabulated values were adjusted for the fact that the original
(Veith, K. F., and Clawson, G. E., 1972) tables relate to peak-to-peak
amplitudes, whereas the measured amplitudes for mb calculations are half
peak-to-peak. The default corrections are read from a file installed at
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/magnitudes/IDC/qfvc.mb</span></code>.If that file is not present no magnitude
will be calculated.</p>
</section>
<section id="station-corrections">
<h3>Station corrections<a class="headerlink" href="#station-corrections" title="Permalink to this heading"></a></h3>
<p>Station magnitudes can be computed with a station specific correction table
which is configured in the global bindings. The parameter <a class="reference internal" href="global.html#confval-magnitudes.mb-IDC-.Q"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.mb(IDC).Q</span></code></a>
takes a path and allows to use placeholders for network code (<code class="code docutils literal notranslate"><span class="pre">{net}</span></code>),
station code (<code class="code docutils literal notranslate"><span class="pre">{sta}</span></code>) and location code (<code class="code docutils literal notranslate"><span class="pre">{loc}</span></code>).</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">magnitudes</span><span class="o">.</span><span class="n">mb</span><span class="p">(</span><span class="n">IDC</span><span class="p">)</span><span class="o">.</span><span class="n">Q</span> <span class="o">=</span> <span class="nd">@DATADIR</span><span class="o">@/</span><span class="n">magnitudes</span><span class="o">/</span><span class="n">IDC</span><span class="o">/</span><span class="p">{</span><span class="n">net</span><span class="p">}</span><span class="o">.</span><span class="p">{</span><span class="n">sta</span><span class="p">}</span><span class="o">.</span><span class="n">mb</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Amplitude unit in SeisComP: <strong>nanometer</strong> (nm)</p></li>
<li><p>Time window: 5.5 s</p></li>
<li><p>Default distance range: 20 - 105 deg</p></li>
<li><p>Depth range: 0 - 800 km</p></li>
</ul>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">mb_IDC</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#station-corrections">Station corrections</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mb_bb.html"
title="previous chapter">mB_BB</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_fx-dfx.html"
title="next chapter">FX-DFX</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mb_idc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,209 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Md &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="NonLinLoc" href="global_nonlinloc.html" />
<link rel="prev" title="Hypo71" href="global_hypo71.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">6.9.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="global_nonlinloc.html" title="NonLinLoc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_hypo71.html" title="Hypo71"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="md">
<span id="global-md"></span><h1>Md<a class="headerlink" href="#md" title="Permalink to this heading"></a></h1>
<p>Duration magnitude plugin</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The duration magnitude is based on coda duration measurement.
Its usually valid for small earthquakes up to magnitude 4 to 5.</p>
<p>First used in 1972 by Lee et al., Duration magnitude (Md) or Coda duration
magnitude plugin estimates Richter magnitude of local earthquakes by using
signal duration on vertical components of seismographs.</p>
<p>Estimations are quite stable for local earthquakes ranging from magnitude
Md 0.0 to 5.0.</p>
<section id="amplitude-processing">
<h3>Amplitude processing<a class="headerlink" href="#amplitude-processing" title="Permalink to this heading"></a></h3>
<p>Duration magnitude is usually computed on short period seismometers by searching
the time at which the amplitude of the signal is close to pre-earthquake amplitude.</p>
<p>Since its mainly used for small earthquake whose signal is at rather high frequency,
its usefull to highpass filter broadband seismomters (select sismo type 6 and a
Butterworth filter “3,1.5”).
Or a better solution is to deconvolve the signals and reconvolve with a widely used
short-period instrument : the 1Hz eigen-frequency L4C (select sismo type 9).
If you have the full responses in your inventory and have activated them
(amplitudes.enableResponses set to true), you will be able to use also accelerometers.</p>
<p>The plugin then searches for the maximum amplitude of the signal, which should be
the S-wave and then computed mean amplitude of one-second time windows.
As soon as a one-second time window mean amplitude vs pre-earthquake amplitude
reaches the configured SNR ratio, the process is stopped.
The middle of the one-second time window is assumed to be the end of the Coda and
the time difference between Coda time and P arrival time is stored as Coda duration.</p>
</section>
<section id="magnitude-processing">
<h3>Magnitude processing<a class="headerlink" href="#magnitude-processing" title="Permalink to this heading"></a></h3>
<p>Once amplitudes calculated by the AmplitudeProcessor and a Coda has been found,
the generic formula is applied and the duration magnitude is computed
for a given station, if it fits the criteria (max depth, max distance).</p>
<div class="math">
<p><img src="../_images/math/a3010f147479b84f14b15be9438d4940ab36bca0.png" alt="mag = FMA + FMB \times \log10(period) + (FMF \times period) + (FMD \times epidistkm) + (FMZ \times depth) + STACOR"/></p>
</div></section>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>The Coda duration magnitude plugin (Md) is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/md.so</span></code>.
It provides a new implementations of AmplitudeProcessor and MagnitudeProcessor.</p>
<p>To add the plugin to a module add it to the modules configuration, either
<code class="file docutils literal notranslate"><span class="pre">modulename.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>md
</pre></div>
</div>
<p>Basically it can be used by modules: <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a>, <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>, <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>.</p>
<section id="more-information">
<h3>More information<a class="headerlink" href="#more-information" title="Permalink to this heading"></a></h3>
<p>Description of the formula can be found in Hypo2000 manual from USGS website.
<a class="reference external" href="http://earthquake.usgs.gov/research/software/#HYPOINVERSE">http://earthquake.usgs.gov/research/software/#HYPOINVERSE</a></p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Md</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude-processing">Amplitude processing</a></li>
<li><a class="reference internal" href="#magnitude-processing">Magnitude processing</a></li>
</ul>
</li>
<li><a class="reference internal" href="#plugin">Plugin</a><ul>
<li><a class="reference internal" href="#more-information">More information</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_hypo71.html"
title="previous chapter">Hypo71</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_nonlinloc.html"
title="next chapter">NonLinLoc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_md.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,227 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ML &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="MLc" href="global_mlc.html" />
<link rel="prev" title="ML_IDC" href="global_ml_idc.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">6.9.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="global_mlc.html" title="MLc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_ml_idc.html" title="ML_IDC"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ml">
<span id="global-ml"></span><h1>ML<a class="headerlink" href="#ml" title="Permalink to this heading"></a></h1>
<p>Standard local (Richter) magnitude</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>ML is the standard local (Richter) magnitude originally designed for
Southern California by <span id="id1">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>.</p>
<p>General (default) conditions apply:</p>
<ul class="simple">
<li><p>Amplitude unit in SeisComP: <strong>millimeter</strong> (mm) by simulation of a <a class="reference internal" href="../base/glossary.html#term-Wood-Anderson-seismometer"><span class="xref std std-term">Wood-Anderson seismometer</span></a>.</p></li>
<li><p>Time window, configurable: 150 s by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or distance dependent, configurable.</p></li>
<li><p>Distance type: epicentral distance.</p></li>
<li><p>Distance range: 0 - 8 deg, maximum is configurable:
<a class="reference internal" href="global.html#confval-magnitudes.ML.maxDistanceKm"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.ML.maxDistanceKm</span></code></a>,
measurements beyond 8 deg will be strictly ignored.</p></li>
<li><p>Depth range: 0 - 80 km, configurable for amplitude measurements.</p></li>
</ul>
<section id="amplitudes">
<h3>Amplitudes<a class="headerlink" href="#amplitudes" title="Permalink to this heading"></a></h3>
<p>The ML amplitude calculation is similar to the original ML. Waveforms from both
horizontal components are time-windowed and restituted to the Wood-Anderson
seismograph. Within the time window the amplitudes are measured on both
horizontal components and combined. The methods for measuring and combining
amplitudes are configurable in the global bindings.</p>
</section>
<section id="station-magnitudes">
<h3>Station Magnitudes<a class="headerlink" href="#station-magnitudes" title="Permalink to this heading"></a></h3>
<p>The individual station ML is calculated using the following formula:</p>
<div class="math">
<p><img src="../_images/math/2ac00af8e0cff8bc51992386e723083d633de181.png" alt="ML = \log10(A) - \log10(A0)"/></p>
</div><p><em>A</em> is the measured ML Wood-Anderson amplitude in millimeters. The second term
is the empirical calibration function, which in turn is a function
of the epicentral distance (<span id="id2">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>). This calibration
function and distance range can be configured globally or per station using
global bindings or the global module configuration variable
module.trunk.global.magnitudes.ML.logA0 in <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>, e.g.</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>module.trunk.global.magnitudes.ML.logA0 = &quot;0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85&quot;
module.trunk.global.magnitudes.ML.maxDistanceKm = &quot;-1&quot;
</pre></div>
</div>
<p>The <em>logA0</em> configuration string consists of an arbitrary number of
distance-value pairs separated by comma. Within the pairs, the values are
separated by colon. The distance is epicentral distance in km
and the second value corresponds to the <em>log10(A0)</em> term above.</p>
<p>Within each interval the values are computed by linear
interpolation. E.g. for the above default specification, at a
distance of 80 km the <em>log10(A0)</em> value would be</p>
<div class="math">
<p><img src="../_images/math/6e45a883605015d556a6b6fe63821c64d8263242.png" alt="\log10(A0) &amp;= ((-3.0)-(-2.8))*(80-60)/(100-60)-2.8 \\
&amp;= -2.9"/></p>
</div><p>In other words, at 80 km distance the magnitude would be</p>
<div class="math">
<p><img src="../_images/math/d201277e64aa494949afae6e3509d37320084dc7.png" alt="ML &amp;= \log10(A) - (-2.9) \\
&amp;= \log10(A) + 2.9"/></p>
</div><p>which is according to the original Richter formula <span id="id3">[<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span> if the
amplitude is measured in millimeters.</p>
<p>Several distance-value pairs can be configured for different ranges of
epicenter distance.</p>
</section>
<section id="network-magnitude">
<h3>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>By default, the mean is calculated from the station magnitudes to form the
network magnitude.</p>
</section>
<section id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h3>
<p>Set the configuration and calibration parameters in the global bindings similar
to <a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a>.
Instead configuring lots of global bindings profiles or station bindings one
line per parameter can be added to the global module configuration
(<code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>).</p>
<p>Add ML to the list of computed amplitudes and magnitudes in the configuration of
<a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> and <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> and in <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> for visibility.</p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ML</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitudes">Amplitudes</a></li>
<li><a class="reference internal" href="#station-magnitudes">Station Magnitudes</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_ml_idc.html"
title="previous chapter">ML_IDC</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mlc.html"
title="next chapter">MLc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_ml.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,189 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ML_IDC &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="ML" href="global_ml.html" />
<link rel="prev" title="mb" href="global_mb.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">6.9.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="global_ml.html" title="ML"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mb.html" title="mb"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ml-idc">
<span id="global-ml-idc"></span><h1>ML_IDC<a class="headerlink" href="#ml-idc" title="Permalink to this heading"></a></h1>
<p>CTBTO/IDC local magnitude.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>The SNSNR amplitudes are calculated on the vertical component seismograms.</p>
</section>
<section id="station-magnitude">
<h3>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h3>
<div class="math">
<p><img src="../_images/math/0fa61d5b31e348e0325d65192561b1f1af9c9cdd.png" alt="mag = \log10(A) + B(\Delta)"/></p>
</div><p>with</p>
<p>A: amplitude of type SBSNR</p>
<p>B: attenuation correction function of epicentral distance in km</p>
<p>The default corrections are read from a file installed at
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/magnitudes/IDC/global.ml</span></code>. If that file is not present no magnitude
will be calculated.</p>
</section>
<section id="station-corrections">
<h3>Station corrections<a class="headerlink" href="#station-corrections" title="Permalink to this heading"></a></h3>
<p>Station magnitudes can be computed with a station specific correction table
which is configured in the global bindings. The parameter <a class="reference internal" href="global.html#confval-magnitudes.ML-IDC-.A"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.ML(IDC).A</span></code></a>
takes a path and allows to use placeholders for network code (<code class="code docutils literal notranslate"><span class="pre">{net}</span></code>),
station code (<code class="code docutils literal notranslate"><span class="pre">{sta}</span></code>) and location code (<code class="code docutils literal notranslate"><span class="pre">{loc}</span></code>).</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">magnitudes</span><span class="o">.</span><span class="n">ML</span><span class="p">(</span><span class="n">IDC</span><span class="p">)</span><span class="o">.</span><span class="n">A</span> <span class="o">=</span> <span class="nd">@DATADIR</span><span class="o">@/</span><span class="n">magnitudes</span><span class="o">/</span><span class="n">IDC</span><span class="o">/</span><span class="p">{</span><span class="n">net</span><span class="p">}</span><span class="o">.</span><span class="p">{</span><span class="n">sta</span><span class="p">}</span><span class="o">.</span><span class="n">ml</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Amplitude unit in SeisComP: <strong>nanometer</strong> (nm)</p></li>
<li><p>Time window: 4.5 s</p></li>
<li><p>Default distance range: 0 - 20 deg</p></li>
<li><p>Depth range: 0 - 40 km</p></li>
</ul>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ML_IDC</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#station-corrections">Station corrections</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mb.html"
title="previous chapter">mb</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_ml.html"
title="next chapter">ML</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_ml_idc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,409 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MLc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="MLv" href="global_mlv.html" />
<link rel="prev" title="ML" href="global_ml.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">6.9.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="global_mlv.html" title="MLv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_ml.html" title="ML"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mlc">
<span id="global-mlc"></span><h1>MLc<a class="headerlink" href="#mlc" title="Permalink to this heading"></a></h1>
<p>Custom magnitude for local events measured on horizontal components</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>MLc is a custom magnitude for local events based on <a class="reference internal" href="global_ml.html#global-ml"><span class="std std-ref">ML</span></a> but
with greater flexibility.
The original implementation is based on specifications by the Hessian Agency for
Nature Conservation, Environment and Geology, Hessian Earthquake Service.
More options have been added allowing the magnitude to be configured with
great flexibility in order to account for many different conditions. The
general procedures for measuring amplitudes and computing magnitudes are
outlined in the <a class="reference internal" href="../base/concepts/magnitudes.html#concepts-magnitudes"><span class="std std-ref">“Concepts” section on magnitudes</span></a>.</p>
<p>The MLc magnitude is very similar to the original <a class="reference internal" href="global_ml.html#global-ml"><span class="std std-ref">ML</span></a>,
except that</p>
<ul class="simple">
<li><p>Amplitude pre-filtering is applied by default.</p></li>
<li><p>Wood-Anderson simulation is optionally applied and can be deactivated.</p></li>
<li><p>Measured amplitudes can be scaled accounting for expected units.</p></li>
<li><p>Measured amplitudes are combined by taking the maximum instead of the average.</p></li>
<li><p>A parametric <a class="reference internal" href="#mlc-station-magnitude"><span class="std std-ref">magnitude calibration</span></a> function
applies but a correction in the form log10(A0) can be configured for converting
measured amplitudes to station magnitudes.</p></li>
<li><p>Hypocentral instead of epicentral distance is considered by default.</p></li>
</ul>
<section id="amplitudes">
<h3>Amplitudes<a class="headerlink" href="#amplitudes" title="Permalink to this heading"></a></h3>
<p>Some general conditions apply for measuring amplitudes:</p>
<ul class="simple">
<li><p>Measured amplitude type: MLc.</p></li>
<li><p>Expected unit of gain-corrected input data: m/s. Activate response correction
in global bindings in case data are provided in acceleration.</p></li>
<li><p>Components used for amplitude measurements: both horizontal components
separately.</p></li>
</ul>
<p>The default parameters for measuring MLc amplitudes can be adjusted by global
binding parameters:</p>
<ul class="simple">
<li><p>Filtering before instrument simulation: <a class="reference internal" href="../base/filter-grammar.html#filter-bw"><span class="std std-ref">BW(3,0.5,12)</span></a>,
configurable by <a class="reference internal" href="global.html#confval-amplitudes.MLc.preFilter"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.preFilter</span></code></a>.</p></li>
<li><p><a class="reference internal" href="../base/glossary.html#term-Wood-Anderson-seismometer"><span class="xref std std-term">Wood-Anderson seismometer</span></a> simulation: yes, can be deactivated by
<a class="reference internal" href="global.html#confval-amplitudes.MLc.applyWoodAnderson"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.applyWoodAnderson</span></code></a>.</p></li>
<li><p>Characteristics of <a class="reference internal" href="../base/glossary.html#term-Wood-Anderson-seismometer"><span class="xref std std-term">Wood-Anderson seismometer</span></a>: according to IASPEI
recommendations. Can be adjusted by <a class="reference internal" href="global.html#confval-2"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.WoodAnderson.gain</span></code></a>,
<a class="reference internal" href="global.html#confval-3"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.WoodAnderson.T0</span></code></a>, <a class="reference internal" href="global.html#confval-4"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.WoodAnderson.h</span></code></a>
in global bindings or global module configuration.</p></li>
<li><p>Amplitude scaling: 1, configure by <a class="reference internal" href="global.html#confval-amplitudes.MLc.amplitudeScale"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.amplitudeScale</span></code></a>
for considering non-default units by magnitude.</p></li>
<li><p>Method applied for measuring amplitudes: absolute maximum, configurable in
global bindings by <a class="reference internal" href="global.html#confval-amplitudes.MLc.measureType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.measureType</span></code></a>.</p></li>
<li><p>Method for combining amplitude measurements: <em>max</em> (maximum from both
horizontal components), configurable in global bindings by
<a class="reference internal" href="global.html#confval-amplitudes.MLc.combiner"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.combiner</span></code></a>.</p></li>
</ul>
<p>Some additional parameters require you to create an amplitude-type profile for
global binding parameters. Name the profile like the amplitude name, hence MLc:</p>
<ul class="simple">
<li><p>Time window for measuring signal amplitudes [s]: P pick time + 150 s by
<a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or distance [km]/3 km/s + 30 s,
the relevant parameters are: <code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.signalBegin</span></code>,
<code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.signalEnd</span></code>. <a class="reference internal" href="../base/time-grammar.html#time-grammar"><span class="std std-ref">Time grammar</span></a> may be
applied for begin and end times.</p></li>
<li><p>Time window for measuring noise amplitudes [s]: 30 s before the P pick,
the relevant parameters are: <code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.noiseBegin</span></code>,
<code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.noiseEnd</span></code>. <a class="reference internal" href="../base/time-grammar.html#time-grammar"><span class="std std-ref">Time grammar</span></a> may be
applied for begin and end times.</p></li>
<li><p>Minimum SNR: 0, configurable by <code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.minSNR</span></code>.</p></li>
<li><p>Distance range: 0 - 8 deg, configurable by <code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.minDist</span></code>,
<code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.maxDist</span></code>, stations at distances beyond 8 deg will be strictly
ignored.</p></li>
<li><p>Depth range: &lt;= 80 km, can be adjusted and extended by
<code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.minDepth</span></code> and <code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.maxDepth</span></code>.</p></li>
</ul>
<p>Most parameters controlling the amplitude measurements are configurable in
global bindings or global module configuration.</p>
<p>The Wood-Anderson simulation will convert input velocity data to ground
displacement in mm. The input data may be of a different unit after applying
<a class="reference internal" href="global.html#confval-amplitudes.MLc.preFilter"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.preFilter</span></code></a>, e.g. when integration is applied, and / or
when Wood-Anderson simulation is disabled. Configure
<a class="reference internal" href="global.html#confval-amplitudes.MLc.amplitudeScale"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.amplitudeScale</span></code></a> for converting the unit of the
processed data to the unit expected by the
<a class="reference internal" href="#mlc-station-magnitude"><span class="std std-ref">station magnitude calibration</span></a> for the measured
amplitude.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For comparing MLc amplitudes with <a class="reference internal" href="global_ml.html#global-ml"><span class="std std-ref">ML amplitudes</span></a> set the
global bindings parameters</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">amplitudes</span><span class="o">.</span><span class="n">MLc</span><span class="o">.</span><span class="n">preFilter</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">amplitudes</span><span class="o">.</span><span class="n">MLc</span><span class="o">.</span><span class="n">combiner</span> <span class="o">=</span> <span class="n">average</span>
</pre></div>
</div>
</div>
</section>
<section id="station-magnitudes">
<span id="mlc-station-magnitude"></span><h3>Station magnitudes<a class="headerlink" href="#station-magnitudes" title="Permalink to this heading"></a></h3>
<p>Default properties, most parameters are configurable in global bindings:</p>
<ul class="simple">
<li><p>Distance type: hypocentral, epicentral can be selected by <a class="reference internal" href="global.html#confval-magnitudes.MLc.distMode"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.distMode</span></code></a>.</p></li>
<li><p>Distance range: 0 - 8 deg, configurable by <a class="reference internal" href="global.html#confval-magnitudes.MLc.minDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.minDist</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.MLc.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.maxDist</span></code></a>, measurements beyond 8 deg will be strictly
ignored.</p></li>
<li><p>Depth range: &lt;= 80 km, can be extended by <a class="reference internal" href="global.html#confval-magnitudes.MLc.maxDepth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.maxDepth</span></code></a>.</p></li>
<li><p>Expected amplitude type: MLc, configurable by magnitude alias.</p></li>
<li><p>Expected amplitude unit: millimeter (mm), other units can be assumed by
amplitude scaling with <a class="reference internal" href="global.html#confval-amplitudes.MLc.amplitudeScale"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.amplitudeScale</span></code></a>.</p></li>
<li><p>Magnitude calibration type: parametric, parametric and non-parametric are
available through <a class="reference internal" href="global.html#confval-magnitudes.MLc.calibrationType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.calibrationType</span></code></a>.</p></li>
<li><p>Calibration function (see below for the equations), configurable by global bindings
depending on the actual calibration type:</p>
<ul>
<li><p>parametric: <a class="reference internal" href="global.html#confval-magnitudes.MLc.parametric.c0"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.parametric.c0</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.MLc.parametric.c1"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.parametric.c1</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.MLc.parametric.c2"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.parametric.c2</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.MLc.parametric.c3"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.parametric.c3</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.MLc.parametric.c4"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.parametric.c4</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.MLc.parametric.c5"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.parametric.c5</span></code></a></p></li>
<li><p>A0: <a class="reference internal" href="global.html#confval-magnitudes.MLc.A0.logA0"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.A0.logA0</span></code></a></p></li>
</ul>
</li>
<li><p>Station correction: none, configurable by a magnitude-type profile in global
bindings with <code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.offset</span></code> or the equivalent in global
module configuration as <code class="xref std std-confval docutils literal notranslate"><span class="pre">module.trunk.NET.STA.magnitudes.MLc.offset</span></code>.
The latter is not supported by <a class="reference internal" href="scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a> but it reduces the amount of
required bindings.</p></li>
</ul>
<p>The calibration function is considered in one of the forms</p>
<ul>
<li><p>parametric when <a class="reference internal" href="global.html#confval-magnitudes.MLc.calibrationType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.calibrationType</span></code></a> = “parametric”<a href="#id1"><span class="problematic" id="id2">`</span></a>:</p>
<div class="math">
<p><img src="../_images/math/bfdf8455f23a75bf18652720e491939a20ac8fa6.png" alt="MLc = \log_{10}(A) + c_3 * \log_{10}(r/c_5) + c_2 * (r + c_4) + c_1 + c_0(station)"/></p>
</div><p>where</p>
<ul class="simple">
<li><p><em>A</em>: displacement amplitude measured in unit of mm or as per configuration</p></li>
<li><p><em>r</em>: hypocentral (default) or epicentral distance</p></li>
<li><p><em>c1</em>, <em>c2</em>, <em>c3</em>, <em>c4</em>, <em>c5</em>: general calibration parameters</p></li>
<li><p><em>c0</em>: station-specific correction</p></li>
<li><p><em>r</em>: Hypocentral (default) or epicentral distance as configured by
<a class="reference internal" href="global.html#confval-magnitudes.MLc.distMode"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.distMode</span></code></a>.</p></li>
</ul>
<p>The default values are valid for SW-Germany (<span id="id3">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span>), c6 and H
have been added for supporting dependency on depth (<span id="id4">Rhoades <em>et al.</em> [<a class="reference internal" href="../base/references.html#id72" title="D.A. Rhoades, A. Christophersen, S. Bourguignon, J. Ristau, and J. Salichon. A DepthDependent Local Magnitude Scale for New Zealand Earthquakes Consistent with Moment Magnitude. Bull. Seismol. Soc. Am., 111(2):10561066, 2020. doi:10.1785/0120200252.">56</a>]</span>).</p>
</li>
<li><p>log10(A0)-based non-parametric when <a class="reference internal" href="global.html#confval-magnitudes.MLc.calibrationType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.calibrationType</span></code></a> = “A0”<a href="#id5"><span class="problematic" id="id6">`</span></a>:</p>
<div class="math">
<p><img src="../_images/math/ccab4425809584f06dd1ddcaf88fa0b15cb94841.png" alt="MLc = \log_{10}(A) - \log_{10}(A_0)"/></p>
</div><p>where</p>
<ul class="simple">
<li><p><img class="math" src="../_images/math/93675c26b872cb6c8401f3a9d037d0e7383ae06b.png" alt="log_{10}(A_0)"/>: distance-dependent correction value. Read
<a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a> for the details.</p></li>
</ul>
</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The magnitude calibration function can be regionalized by adjusting global
module configuration parameters in MLc region profiles of
<code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLc.region.*</span></code> and in a <em>MLc</em> Magnitude type profile e.g.
in <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>.</p>
</div>
<p>The flexibility of the amplitude and magnitude processing allows for MLc to be
applied in various use cases. Examples are given below.</p>
<ul>
<li><p><strong>Default:</strong> Pre-filtered and gain-corrected amplitudes, Wood-Anderson
corrected and measured in mm for Southwestern Germany, <span id="id7">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span>:</p>
<div class="math">
<p><img src="../_images/math/d949c4542df9586bfdd0006602e3f0b3a56fbc5b.png" alt="MLc = \log_{10}(A) + 1.11 * \log_{10}(r) + 0.00095 * r + 0.69 + c_0"/></p>
</div></li>
<li><p>Wood-Anderson-corrected displacement amplitudes measured in mm for
Southern California, <span id="id8">Hutton and Boore [<a class="reference internal" href="../base/references.html#id39" title="L.K. Hutton and D.M. Boore. The ML scale in southern California. Bull. Seismol. Soc. Am,, 77(6):20742094, 1987. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140905-113510505.">45</a>]</span>:</p>
<div class="math">
<p><img src="../_images/math/fe3a90edfdebbbcc8730ea60fd0048e251cda93c.png" alt="MLc = \log_{10}(A) + 1.110 * \log_{10}(r / 100) + 0.00189 * (r - 100) + 3.0"/></p>
</div></li>
<li><p>Pre-filtered velocity amplitudes in units of mym/s (requiring to set
<a class="reference internal" href="global.html#confval-amplitudes.MLc.amplitudeScale"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.MLc.amplitudeScale</span></code></a>), no Wood-Anderson correction,
for West Bohemia, e.g. <span id="id9">Hiemer and Roessler [<a class="reference internal" href="../base/references.html#id38" title="S. Hiemer and D. Roessler. Monitoring the West Bohemian earthquake swarm in 2008/2009 by a temporary small-aperture seismic array. J. Seismol., 16:169-182, 2012. doi:10.1007/s10950-011-9256-5.">44</a>]</span>:</p>
<div class="math">
<p><img src="../_images/math/b21da4311b2f4882dbbadbcb617d04c5e5e35e7b.png" alt="MLc = \log_{10}(A) - log_{10}(2\Pi) + 2.1 * \log_{10}(r) - 1.7 + c_0"/></p>
</div></li>
</ul>
<figure class="align-center" id="id13">
<a class="reference internal image-reference" href="../_images/magnitude-calibrations_MLc_s_MLc_hb.png"><img alt="../_images/magnitude-calibrations_MLc_s_MLc_hb.png" src="../_images/magnitude-calibrations_MLc_s_MLc_hb.png" style="width: 18cm;" /></a>
<figcaption>
<p><span class="caption-text">MLc magnitudes for measured amplitude of 1 mm with default magnitude
calibration (<em>MLc_s</em>, <span id="id10">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span>) and calibration values for Southern
California (<em>MLc_hb</em>, <span id="id11">Hutton and Boore [<a class="reference internal" href="../base/references.html#id39" title="L.K. Hutton and D.M. Boore. The ML scale in southern California. Bull. Seismol. Soc. Am,, 77(6):20742094, 1987. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140905-113510505.">45</a>]</span>).</span><a class="headerlink" href="#id13" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="network-magnitude">
<h3>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>The network magnitude is computed from station magnitudes automatically by
<a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> or interactively by <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>.
Originally the median was computed from all station MLc to form the
<a class="reference internal" href="../base/glossary.html#term-network-magnitude"><span class="xref std std-term">network magnitude</span></a> MLc. Here, the trimmed mean is applied. Outliers
beyond the outer 12.5% percentiles are removed before forming the mean. The
method can be adjusted in <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> by <a class="reference internal" href="scmag.html#confval-magnitudes.average"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.average</span></code></a>.</p>
</section>
<section id="moment-magnitude">
<h3>Moment magnitude<a class="headerlink" href="#moment-magnitude" title="Permalink to this heading"></a></h3>
<p>MLc can be scaled to a moment magnitude, Mw(MLc), by a magnitude-type profile in
global module configuration. Read the
<a class="reference internal" href="../base/tutorials/magnitude-regionalization.html#tutorials-mags-moment"><span class="std std-ref">Tutorial on moment magnitudes</span></a> for the details.</p>
</section>
<section id="magnitude-aliases">
<h3>Magnitude aliases<a class="headerlink" href="#magnitude-aliases" title="Permalink to this heading"></a></h3>
<p>Magnitude aliases can be created by <a class="reference internal" href="global.html#confval-magnitudes.aliases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.aliases</span></code></a> in
global module configuration in order to derive other magnitude types from
original amplitudes and magnitudes. The actual amplitude and magnitude
parameters of the aliases will be configured in global bindings or by
magnitude-type profiles in global module configuration. Read the
<a class="reference internal" href="../base/tutorials/magnitude-regionalization.html#tutorials-magnitude-aliases"><span class="std std-ref">Tutorial on magnitude aliases</span></a> for the
details.</p>
</section>
<section id="regionalization">
<h3>Regionalization<a class="headerlink" href="#regionalization" title="Permalink to this heading"></a></h3>
<p>Regionalization may be achieved by a magnitude-type profile in global module
configuration. Read the
<a class="reference internal" href="../base/tutorials/magnitude-regionalization.html#tutorials-magnitude-region"><span class="std std-ref">Tutorial on regionalization</span></a> for the details.</p>
</section>
</section>
<section id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p><strong>Set the configuration and calibration parameters</strong> in the global bindings
similar
to <a class="reference internal" href="global_ml.html#global-ml"><span class="std std-ref">ML</span></a>. Instead of configuring lots of global bindings profiles
or station bindings one line per parameter can be added to the global module
configuration (<code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>) which takes the form</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>module.trunk.NET.STA.amplitudes.MLc.preFilter = value
module.trunk.NET.STA.magnitudes.MLc.parametric.c0 = value
</pre></div>
</div>
</li>
<li><p>Add MLc to the list of default amplitudes and magnitudes if MLc is to be
computed by automatic modules, e.g. of <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a>, <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>.</p></li>
<li><p>Configure <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> (<a class="reference internal" href="scmag.html#confval-magnitudes.average"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.average</span></code></a> in <code class="file docutils literal notranslate"><span class="pre">scmag.cfg</span></code>)
for choosing the method to form the
network magnitude from station magnitudes, e.g.</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>magnitudes.average = MLc:median
</pre></div>
</div>
</li>
<li><p>Add MLc to the list of magnitudes preferred by <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>
(<a class="reference internal" href="scevent.html#confval-eventAssociation.magTypes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.magTypes</span></code></a> in <code class="file docutils literal notranslate"><span class="pre">scevent.cfg</span></code>) in order to let
MLc become the preferred magnitude.</p></li>
<li><p>Set defaults/visibility of MLc in <a class="reference internal" href="../base/glossary.html#term-GUI"><span class="xref std std-term">GUI</span></a> modules, e.g. <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>
or <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a>.</p></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>All default values for bindings configuration parameters are from
<span id="id12">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span>.</p>
</div>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MLc</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitudes">Amplitudes</a></li>
<li><a class="reference internal" href="#station-magnitudes">Station magnitudes</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#moment-magnitude">Moment magnitude</a></li>
<li><a class="reference internal" href="#magnitude-aliases">Magnitude aliases</a></li>
<li><a class="reference internal" href="#regionalization">Regionalization</a></li>
</ul>
</li>
<li><a class="reference internal" href="#setup">Setup</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_ml.html"
title="previous chapter">ML</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mlv.html"
title="next chapter">MLv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mlc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MLh &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="iLoc" href="global_iloc.html" />
<link rel="prev" title="NonLinLoc" href="global_nonlinloc.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">6.9.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="global_iloc.html" title="iLoc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_nonlinloc.html" title="NonLinLoc"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mlh">
<span id="global-mlh"></span><h1>MLh<a class="headerlink" href="#mlh" title="Permalink to this heading"></a></h1>
<p>The MLh plugin (previously MLsed) is designed to compute amplitudes
and magnitudes according to the Swiss Seismological Service (SED)
standards.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>The MLh amplitude calculation is very similar to the original <a class="reference internal" href="global_ml.html#global-ml"><span class="std std-ref">ML</span></a>.
The two differences are:</p>
<ul class="simple">
<li><p>It uses the maximum of the two horizontal components (average can be configured if necessary)</p></li>
<li><p>It uses zero-to-peak in stead of peak-to-peak values</p></li>
</ul>
<p>Zero-to-peak is calculated by just dividing the peak-to-peak amplitude by two.
This is not exact for unsymmetrical signals, but that doesnt matter because the
code actually generates zero-to-peak amplitudes internally and multiplies them
with two. So in the end we get real zero-to-peak values.</p>
</section>
<section id="station-magnitude">
<h3>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h3>
<p>The MLh plugin calculates the individual station magnitude using the following formula:</p>
<div class="math">
<p><img src="../_images/math/4cfbd65af2e9b33bf217b7f95d186fabbf6a6db7.png" alt="mag = \log10(waamp1) + A \times hypdistkm + B"/></p>
</div><p>waampl is the amplitude produced by the MLh plugin. Hypdistkm is the distance
from the sensor to the hypocenter in kilometers. A and B are parameters that
can be configured in a config file. Several pairs of A and B can be configured
for different ranges of hypocenter distance.</p>
<ul class="simple">
<li><p>Amplitude unit in SeisComP: <strong>millimeter</strong> (mm)</p></li>
<li><p>Time window: 150 s by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or distance dependent</p></li>
<li><p>Distance range: 0 - 20 deg</p></li>
<li><p>Depth range: 0 - 80 km</p></li>
</ul>
</section>
<section id="network-magnitude">
<h3>Network Magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>To compute the network magnitude from station magnitudes the SED standard is applied
by computing the median value of all contributing station magnitudes without any trimming.</p>
</section>
<section id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h3>
<p>Add the <em>mlh</em> plugin to the existing plugins in the global configuration.
Set the calibration parameters in the global bindings to compute MLh.
There exist no default configuration. Add MLh to the list of
amplitudes and magnitudes in the configuration of <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> and <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> for computation
and in <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a> for visibility.</p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MLh</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#network-magnitude">Network Magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_nonlinloc.html"
title="previous chapter">NonLinLoc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_iloc.html"
title="next chapter">iLoc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mlh.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,207 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MLr &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="GUI" href="global_gui.html" />
<link rel="prev" title="MN" href="global_mn.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">6.9.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="global_gui.html" title="GUI"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mn.html" title="MN"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mlr">
<span id="global-mlr"></span><h1>MLr<a class="headerlink" href="#mlr" title="Permalink to this heading"></a></h1>
<p>The GNS/Geonet local magnitude</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The MLr magnitude provides a GNS/Geonet local magnitude (<span id="id1">Ristau <em>et al.</em> [<a class="reference internal" href="../base/references.html#id64" title="J. Ristau, D. Harte, and J. Salichon. A Revised Local Magnitude (ML) Scale for New Zealand Earthquakes. Bull. Seismol. Soc. Am., 106(2):, 2016. doi:10.1785/0120150293.">58</a>]</span>).
MLr magnitudes are implemented by the <em>mlr</em> plugin.
It is a modified version of the gempa ML magnitude developed
at the Liverpool developer meeting (<span id="id2"><em>gempa GmbH</em> [<a class="reference internal" href="../base/references.html#id122" title="gempa GmbH. The SeisComP development and maintenance company. URL: https://www.gempa.de/.">28</a>]</span>) based on the SED
<a class="reference internal" href="global_mlh.html#global-mlh"><span class="std std-ref">MLh</span></a> magnitude.
The <em>mlr</em> plugin is designed to use the MLv station amplitudes for computing
MLr magnitudes.
The magnitude uses a station correction term and the hypocentral distance.</p>
</section>
<section id="amplitude">
<h2>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h2>
<p>The MLr amplitude calculation is that of <a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a>.</p>
</section>
<section id="station-magnitude">
<h2>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h2>
<p>The <em>mLr</em> plugin calculates individual MLr station local magnitudes from
<a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a> amplitudes as:</p>
<div class="math">
<p><img src="../_images/math/3b314bd56ab94770a2a623ebc60d9d2527f3eda6.png" alt="MLr = \log10(waampl) - \log10(waamplRef)"/></p>
</div><div class="math">
<p><img src="../_images/math/af651135a1453eaa75fcec6a10fd5195d34d83b0.png" alt="\log10(waamplRef)= 0.2869 - 1.272 \times 1^{-3} \times hypdistkm - 1.493 \times \log10(hypdistkm) + StationCorrection"/></p>
</div><p>with</p>
<ul>
<li><p><em>waampl:</em> the <a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a> amplitude.</p></li>
<li><p><em>hypdistkm:</em> the distance from the sensor to the hypocenter in kilometers.</p></li>
<li><p><em>A(station):</em> Station correction is given by module.trunk.NZ.WEL.MLR.params, A.
Station Correction is set to be distance dependent.</p>
<p>Format: “UpToKilometers A ; UpToNextKilometers A “.
The option “nomag” disables the station magnitude.</p>
</li>
</ul>
<p>General parameters:</p>
<ul class="simple">
<li><p>Amplitude unit in SeisComP: <strong>millimeter</strong> (mm) from <a class="reference internal" href="global_mlv.html#global-mlv"><span class="std std-ref">MLv</span></a></p></li>
<li><p>Time window: 150 s by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or distance dependent</p></li>
<li><p>Distance range: 0 - 20 deg (hypocentral distance, hard-coded)</p></li>
<li><p>Depth range: 0 - 800 km (hard-coded)</p></li>
</ul>
</section>
<section id="network-magnitude">
<h2>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h2>
<p>The GNS/Geonet Mlr local magnitude is using the default <cite>SeisComP</cite> behaviour for
the automatic network magnitudes.
Hard-coded ranges are 0-20 degrees maximum distance and 800 km maximum depth.</p>
</section>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h2>
<p>Add the mlr plugin to the existing plugins in the global configuration.
Set the calibration parameters in the global bindings. Add MLr to the list of
magnitudes in the configuration of <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> and <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> for computation
and in <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a> for visibility.</p>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MLr</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mn.html"
title="previous chapter">MN</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_gui.html"
title="next chapter">GUI</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mlr.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,239 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MLv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="mB_BB" href="global_mb_bb.html" />
<link rel="prev" title="MLc" href="global_mlc.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">6.9.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="global_mb_bb.html" title="mB_BB"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_mlc.html" title="MLc"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mlv">
<span id="global-mlv"></span><h1>MLv<a class="headerlink" href="#mlv" title="Permalink to this heading"></a></h1>
<p>Local (Richter) magnitude measured on the vertical component</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>MLv is the local (Richter) magnitude (<span id="id1">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>) computed from amplitudes measured on the
vertical component.</p>
<p>General (default) conditions apply:</p>
<ul class="simple">
<li><p>Amplitude unit in SeisComP: <strong>millimeter</strong> (mm) by simulation of a <a class="reference internal" href="../base/glossary.html#term-Wood-Anderson-seismometer"><span class="xref std std-term">Wood-Anderson seismometer</span></a>.</p></li>
<li><p>Time window: 150 s by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or distance dependent, configurable.</p></li>
<li><p>Default distance range: 0 - 8 deg, maximum is configurable
<a class="reference internal" href="global.html#confval-magnitudes.MLv.maxDistanceKm"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLv.maxDistanceKm</span></code></a>, measurements beyond 8 deg will be
strictly ignored.</p></li>
<li><p>Depth range: no limitation.</p></li>
</ul>
<section id="amplitudes">
<h3>Amplitudes<a class="headerlink" href="#amplitudes" title="Permalink to this heading"></a></h3>
<p>The MLv amplitude calculation is very similar to the original <a class="reference internal" href="global_ml.html#global-ml"><span class="std std-ref">ML</span></a>,
except that the amplitude is measured on the vertical component. The methods
for measuring amplitudes are configurable in the global bindings.</p>
</section>
<section id="station-magnitudes">
<h3>Station Magnitudes<a class="headerlink" href="#station-magnitudes" title="Permalink to this heading"></a></h3>
<p>The individual station MLv is calculated up to the epicentral distance
<a class="reference internal" href="global.html#confval-magnitudes.MLv.maxDistanceKm"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.MLv.maxDistanceKm</span></code></a> using the following formula:</p>
<div class="math">
<p><img src="../_images/math/f73f0c80f57e4c0aa9f75af47267f7aa55522b40.png" alt="MLv = \log10(A) - \log10(A0)"/></p>
</div><p>A is the MLv Wood-Anderson amplitude in millimeters. The second term
is the empirical calibration function, which in turn is a function
of the epicentral distance (see <span id="id2">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>). This calibration
function can be configured globally or per station using global
bindings or the global module configuration variable
module.trunk.global.magnitudes.MLv.logA0 in <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>, e.g.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">module</span><span class="o">.</span><span class="n">trunk</span><span class="o">.</span><span class="k">global</span><span class="o">.</span><span class="n">magnitudes</span><span class="o">.</span><span class="n">MLv</span><span class="o">.</span><span class="n">logA0</span> <span class="o">=</span> <span class="s2">&quot;0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85&quot;</span>
<span class="n">module</span><span class="o">.</span><span class="n">trunk</span><span class="o">.</span><span class="k">global</span><span class="o">.</span><span class="n">magnitudes</span><span class="o">.</span><span class="n">MLv</span><span class="o">.</span><span class="n">maxDistanceKm</span> <span class="o">=</span> <span class="s2">&quot;-1&quot;</span>
</pre></div>
</div>
<p>The logA0 configuration string consists of an arbitrary number of
distance-value pairs separated by semicolons. The distance is in km
and the value corresponds to the <em>log10(A0)</em> term above.</p>
<p>Within each interval the values are computed by linear
interpolation. E.g. for the above default specification, at a
distance of 80 km the <em>log10(A0)</em> value would be</p>
<div class="math">
<p><img src="../_images/math/6e45a883605015d556a6b6fe63821c64d8263242.png" alt="\log10(A0) &amp;= ((-3.0)-(-2.8))*(80-60)/(100-60)-2.8 \\
&amp;= -2.9"/></p>
</div><p>In other words, at 80 km distance the magnitude would be</p>
<div class="math">
<p><img src="../_images/math/e43775c444e67a786957a45f52e1b6a4b4d757a8.png" alt="MLv &amp;= \log10(A) - (-2.9) \\
&amp;= \log10(A) + 2.9"/></p>
</div><p>which is according to the original Richter formula <span id="id3">[<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span> if the
amplitude is measured in millimeters.</p>
</section>
<section id="network-magnitude">
<h3>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>By default, the trimmed mean is calculated from the station magnitudes to form
the <a class="reference internal" href="../base/glossary.html#term-network-magnitude"><span class="xref std std-term">network magnitude</span></a>. Outliers beyond the outer 12.5% percentiles are
removed before forming the mean.</p>
</section>
<section id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h3>
<p>Several distance-value pairs can be configured for different ranges of
epicentral distance.
The calibration function and maximum distance can be configured globally,
per network or per station using the configuration variables. Instead configuring
lots of global bindings profiles or station bindings one line per parameter can be
added to the global module configuration (<code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>), e.g.</p>
<p>global:</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>module.trunk.global.magnitudes.MLv.logA0 = &quot;0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85&quot;
module.trunk.global.magnitudes.MLv.maxDistanceKm = -1
</pre></div>
</div>
<p>or per network:</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>module.trunk.GR.magnitudes.MLv.logA0 = &quot;0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85&quot;
module.trunk.GR.magnitudes.MLv.maxDistanceKm = -1
</pre></div>
</div>
<p>or per station:</p>
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>module.trunk.GR.MOX.magnitudes.MLv.logA0 = &quot;0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85&quot;
module.trunk.GR.MOX.magnitudes.MLv.maxDistanceKm = -1
</pre></div>
</div>
<p>Set the configuration and calibration parameters in the global bindings. By
default MLv is computed by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> and is visible in GUIs.</p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MLv</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitudes">Amplitudes</a></li>
<li><a class="reference internal" href="#station-magnitudes">Station Magnitudes</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_mlc.html"
title="previous chapter">MLc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mb_bb.html"
title="next chapter">mB_BB</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mlv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,245 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MN &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="MLr" href="global_mlr.html" />
<link rel="prev" title="iLoc" href="global_iloc.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">6.9.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="global_mlr.html" title="MLr"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_iloc.html" title="iLoc"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="mn">
<span id="global-mn"></span><h1>MN<a class="headerlink" href="#mn" title="Permalink to this heading"></a></h1>
<p>Nuttli magnitude for Canada and other Cratonic regions</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>MN is the Nuttli magnitude <span id="id1">[<a class="reference internal" href="../base/references.html#id58" title="O.W. Nuttli. Seismic wave attenuation and magnitude relations for eastern north america. J. Geophys. Res., 5:876 - 885, 1973. doi:10.1029/JB078i005p00876.">53</a>]</span> for Canada and other Cratonic
regions. It is implemented by the <em>nuttli</em> plugin according to the
Geological Survey of Canada (NRCan).</p>
<p>For measuring AMN amplitudes and for computing MN magnitudes <cite>SeisComP</cite> provides
regionalization.</p>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>Amplitude unit in <cite>SeisComP</cite>: <strong>meter/second</strong> (m/s)</p>
</section>
</section>
<section id="settings">
<h2>Settings<a class="headerlink" href="#settings" title="Permalink to this heading"></a></h2>
<p>Add the <em>nuttli</em> plugin to the list of loaded plugins e.g. in the global module configuration:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,nuttli
</pre></div>
</div>
<p>Adjust MN-specific global bindings parameters in the amplitude section and set the
region-specific calibration parameters in the global module configuration.</p>
<section id="scamp">
<h3>scamp<a class="headerlink" href="#scamp" title="Permalink to this heading"></a></h3>
<p>Add the Nuttli amplitude type, <strong>AMN</strong>, to the range of magnitudes for which the amplitudes are
to be calculated by <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a>, e.g.:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">amplitudes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>AMN
</pre></div>
</div>
<p>Adjust MN-specific global bindings parameters in the amplitude section and set the
region-specific calibration parameters in the global module configuration
(amplitude section).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Provide <em>AMN</em> for computing Nuttli-type amplitudes.</p>
</div>
</section>
<section id="scmag">
<h3>scmag<a class="headerlink" href="#scmag" title="Permalink to this heading"></a></h3>
<p>Add the Nuttli magnitude type, <strong>MN</strong>, to the range of magnitudes to be calculated by
<a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>, e.g.:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">magnitudes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>MN
</pre></div>
</div>
<p>Adjust MN-specific global bindings parameters in the magnitude section and define
the region polygons in the global module configuration (magnitude section).</p>
</section>
</section>
<section id="module-configuration">
<span id="global-mn-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>amplitudes.MN.*</strong>
<em>Amplitude control parameters for MN (Nuttli magnitude).</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-amplitudes.MN.velocityModel">
<span class="sig-name descname"><span class="pre">amplitudes.MN.velocityModel</span></span><a class="headerlink" href="#confval-amplitudes.MN.velocityModel" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">iasp91</span></code></p>
<p>Type: <em>string</em></p>
<p>The travel time table set compiled for LocSAT. The tables
are located in &quot;share/locsat/tables/[vmodel].*&quot;.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>magnitudes.MN.*</strong>
<em>Regionalization of MN (Nuttli magnitude).</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-magnitudes.MN.region">
<span class="sig-name descname"><span class="pre">magnitudes.MN.region</span></span><a class="headerlink" href="#confval-magnitudes.MN.region" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/magnitudes/MN/MN.bna</span></code></p>
<p>Type: <em>path</em></p>
<p>The path to the BNA file which defines the valid region
for the MN magnitude. Note that the entire path from
source to receiver must lie entirely within the polygon(s).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-magnitudes.MN.offsetMw">
<span class="sig-name descname"><span class="pre">magnitudes.MN.offsetMw</span></span><a class="headerlink" href="#confval-magnitudes.MN.offsetMw" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>The offset applied to the MN network magnitude to
estimate Mw(MN). If not configured then no Mw estimation
will be applied.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MN</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
</ul>
</li>
<li><a class="reference internal" href="#settings">Settings</a><ul>
<li><a class="reference internal" href="#scamp">scamp</a></li>
<li><a class="reference internal" href="#scmag">scmag</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_iloc.html"
title="previous chapter">iLoc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mlr.html"
title="next chapter">MLr</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_mn.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Ms_20 &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="mb" href="global_mb.html" />
<link rel="prev" title="RecordStream" href="global_recordstream.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">6.9.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="global_mb.html" title="mb"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_recordstream.html" title="RecordStream"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ms-20">
<span id="global-ms-20"></span><h1>Ms_20<a class="headerlink" href="#ms-20" title="Permalink to this heading"></a></h1>
<p>Surface wave magnitude measured at around 20 s</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Ms_20 is the surface wave magnitude measured on the vertical component at around
20 s period in accordance with the IASPEI standards.</p>
<section id="amplitude">
<h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this heading"></a></h3>
<p>The Ms_20 amplitudes are calculated on vertical-component displacement seismograms
corrected for the instrument response of a <a class="reference internal" href="../base/glossary.html#term-WWSSN_LP"><span class="xref std std-term">WWSSN_LP</span></a> seismograph.</p>
</section>
<section id="station-magnitude">
<h3>Station Magnitude<a class="headerlink" href="#station-magnitude" title="Permalink to this heading"></a></h3>
<p>Ms_20 is the surface-wave magnitude at 20 s period based on the recommendations
by the IASPEI magnitude working group issued on 27 March, 2013 (<span id="id1">IASPEI [<a class="reference internal" href="../base/references.html#id40" title="IASPEI. Summary of magnitude working group recommendations on standard procedures for determining earthquake magnitudes from digital data. IASPEI Website, 2013. URL: http://www.iaspei.org/commissions/commission-on-seismological-observation-and-interpretation/Summary_WG_recommendations_20130327.pdf.">46</a>]</span>).</p>
<div class="math">
<p><img src="../_images/math/e09fa212079ab87241b0d94c484f2a485283c708.png" alt="M_s = \log \left(\frac{A}{T}\right) + 1.66 \log(\Delta) + 0.3"/></p>
</div><p>with</p>
<p>A: <a class="reference internal" href="../base/glossary.html#term-WWSSN_LP"><span class="xref std std-term">WWSSN_LP</span></a> corrected ground displacement in units of nm measured on the vertical-component
seismogram as the maximum absolute trace amplitude of a surface wave at periods between
18 s and 22 s,</p>
<p>T: period of the surface wave in seconds.</p>
<p>The term <em>Ms_20</em> is chosen in accordance with the IASPEI standard as of 2013 (<span id="id2">IASPEI [<a class="reference internal" href="../base/references.html#id40" title="IASPEI. Summary of magnitude working group recommendations on standard procedures for determining earthquake magnitudes from digital data. IASPEI Website, 2013. URL: http://www.iaspei.org/commissions/commission-on-seismological-observation-and-interpretation/Summary_WG_recommendations_20130327.pdf.">46</a>]</span>).
Alternatively, the term <em>Ms(20)</em> may be used.</p>
<ul class="simple">
<li><p>Amplitude unit in <cite>SeisComP</cite>: <strong>nanometer</strong> (nm)</p></li>
<li><p>Time window: 0 s - distance (km) / 3.5 km/s + 30 s</p></li>
<li><p>Period range: 18 s - 22 s, configurable: <a class="reference internal" href="global.html#confval-magnitudes.Ms_20.lowerPeriod"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.Ms_20.lowerPeriod</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.Ms_20.upperPeriod"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.Ms_20.upperPeriod</span></code></a></p></li>
<li><p>Default distance range: 20 - 160 deg, configurable: <a class="reference internal" href="global.html#confval-magnitudes.Ms_20.minDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.Ms_20.minDist</span></code></a>,
<a class="reference internal" href="global.html#confval-magnitudes.Ms_20.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.Ms_20.maxDist</span></code></a></p></li>
<li><p>Depth range: &lt;= 100 km, configurable: <a class="reference internal" href="global.html#confval-magnitudes.Ms_20.maxDepth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.Ms_20.maxDepth</span></code></a></p></li>
</ul>
</section>
<section id="network-magnitude">
<h3>Network magnitude<a class="headerlink" href="#network-magnitude" title="Permalink to this heading"></a></h3>
<p>By default, the trimmed mean is calculated from the station magnitudes to form
the <a class="reference internal" href="../base/glossary.html#term-network-magnitude"><span class="xref std std-term">network magnitude</span></a>. Outliers below the 12.5% and above the 12.5% percentiles are
removed before the calculation.</p>
</section>
<section id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h3>
<p>Adjust the configurable parameters in global bindings in the Ms_20 section. Add
Ms_20 to the list of computed amplitudes and magnitudes in the configuration of
<a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> and <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> and in <a class="reference internal" href="scesv.html#scesv"><span class="std std-ref">scesv</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> for visibility.</p>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Ms_20</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#station-magnitude">Station Magnitude</a></li>
<li><a class="reference internal" href="#network-magnitude">Network magnitude</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_recordstream.html"
title="previous chapter">RecordStream</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mb.html"
title="next chapter">mb</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_ms_20.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,704 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>NonLinLoc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="MLh" href="global_mlh.html" />
<link rel="prev" title="Md" href="global_md.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">6.9.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="global_mlh.html" title="MLh"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_md.html" title="Md"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="nonlinloc">
<span id="global-nonlinloc"></span><h1>NonLinLoc<a class="headerlink" href="#nonlinloc" title="Permalink to this heading"></a></h1>
<p>NonLinLoc locator wrapper plugin for SeisComP.
NonLinLoc was written by Anthony Lomax (<a class="reference external" href="http://alomax.free.fr/nlloc">http://alomax.free.fr/nlloc</a>).</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Funded by <a class="reference external" href="http://www.seismo.ethz.ch/">SED/ETH Zurich</a>, developed by <a class="reference external" href="http://www.gempa.de">gempa GmbH</a>.
This plugin is available from SeisComP version Release Potsdam 2010 and later.</p>
<p>The <a class="reference external" href="http://alomax.free.fr/nlloc">NonLinLoc (NLL)</a> locator algorithm has been
implemented into SeisComP through the plugin mechanism. A new plugin locnll
contains the LocatorInterface implementation for NonLinLoc.</p>
<p>The implementation bundles the NonLinLoc source files required to use the library
function calls. The following source files are included:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>GridLib.c
GridLib.h
GridMemLib.c
GridMemLib.h
NLLocLib.h
NLLoc1.c
NLLocLib.c
calc_crust_corr.c
calc_crust_corr.h
crust_corr_model.h
crust_type_key.h
crust_type.h
loclist.c
octtree.h
octtree.c
phaseloclist.h
phaselist.c
geo.c
geo.h
geometry.h
map_project.c
map_project.h
otime_limit.c
otime_limit.h
ran1.c
ran1.h
velmod.c
velmod.h
util.h
util.c
alomax_matrix/alomax_matrix.c
alomax_matrix/alomax_matrix.h
alomax_matrix/alomax_matrix_svd.c
alomax_matrix/alomax_matrix_svd.h
</pre></div>
</div>
</section>
<section id="error-measures">
<h2>Error measures<a class="headerlink" href="#error-measures" title="Permalink to this heading"></a></h2>
<p>After running NonLinLoc the output is converted into a SeisComP (QuakeML) origin
object including all available error measures. The following table shows how
the NLL error measures are mapped to the SeisComP data model:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>SeisComP</p></th>
<th class="head"><p>NLL</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Origin.latitude.uncertainty</p></td>
<td><p>sqrt(phypo-&gt;cov.yy)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.longitude.uncertainty</p></td>
<td><p>sqrt(phypo-&gt;cov.xx)</p></td>
</tr>
<tr class="row-even"><td><p>Origin.depth.uncertainty</p></td>
<td><p>sqrt(phypo-&gt;cov.zz)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.standardError</p></td>
<td><p>phypo-&gt;rms</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.secondaryAzimuthalGap</p></td>
<td><p>phypo-&gt;gap_secondary</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.usedStationCount</p></td>
<td><p>phypo-&gt;usedStationCount</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.associatedStationCount</p></td>
<td><p>phypo-&gt;associatedStationCount</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.associatedPhaseCount</p></td>
<td><p>phypo-&gt;associatedPhaseCount</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.usedPhaseCount</p></td>
<td><p>phypo-&gt;nreadings</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.depthPhaseCount</p></td>
<td><p>phypo-&gt;depthPhaseCount</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.minimumDistance</p></td>
<td><p>km2deg(phypo-&gt;minimumDistance)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.maximumDistance</p></td>
<td><p>km2deg(phypo-&gt;maximumDistance)</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originQuality.medianDistance</p></td>
<td><p>km2deg(phypo-&gt;medianDistance)</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originQuality.groundTruthLevel</p></td>
<td><p>phypo-&gt;groundTruthLevel</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originUncertainty.horizontalUncertainty</p></td>
<td><p>phypo-&gt;ellipse.len2</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originUncertainty.minHorizontalUncertainty</p></td>
<td><p>phypo-&gt;ellipse.len1</p></td>
</tr>
<tr class="row-even"><td><p>Origin.originUncertainty.maxHorizontalUncertainty</p></td>
<td><p>phypo-&gt;ellipse.len2</p></td>
</tr>
<tr class="row-odd"><td><p>Origin.originUncertainty.azimuthMaxHorizontalUncertainty</p></td>
<td><p>phypo-&gt;ellipse.az1 + 90</p></td>
</tr>
<tr class="row-even"><td><p>ConfidenceEllipsoid.semiMajorAxisLength</p></td>
<td><p>phypo-&gt;ellipsoid.len3</p></td>
</tr>
<tr class="row-odd"><td><p>ConfidenceEllipsoid.semiMinorAxisLength</p></td>
<td><p>phypo-&gt;ellipsoid.len1</p></td>
</tr>
<tr class="row-even"><td><p>ConfidenceEllipsoid.semiIntermediateAxisLength</p></td>
<td><p>phypo-&gt;ellipsoid.len2</p></td>
</tr>
<tr class="row-odd"><td><p>ConfidenceEllipsoid.majorAxisPlunge</p></td>
<td><p>(phypo-&gt;ellipsoid.axis1 x phypo-&gt;ellipsoid.axis2).dip</p></td>
</tr>
<tr class="row-even"><td><p>ConfidenceEllipsoid.majorAxisAzimuth</p></td>
<td><p>(phypo-&gt;ellipsoid.axis1 x phypo-&gt;ellipsoid.axis2).az</p></td>
</tr>
<tr class="row-odd"><td><p>ConfidenceEllipsoid.majorAxisRotation</p></td>
<td><p>T.B.D.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>The NonLinLoc plugin is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/locnll.so</span></code>.
It provides a new implementation of the LocatorInterface with the name NonLinLoc.</p>
<p>To add the plugin to a module add it to the modules configuration, either
<code class="file docutils literal notranslate"><span class="pre">modulename.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>locnll
</pre></div>
</div>
<p>Basically it can be used by two modules: <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> and <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>.</p>
</section>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h2>
<p>All output is stored in the configured <a class="reference internal" href="#confval-NonLinLoc.outputPath"><code class="xref std std-confval docutils literal notranslate"><span class="pre">NonLinLoc.outputPath</span></code></a>.
The file prefix for a location is the originID (<a class="reference internal" href="#confval-NonLinLoc.publicID"><code class="xref std std-confval docutils literal notranslate"><span class="pre">NonLinLoc.publicID</span></code></a>).</p>
<p>The following file are stored:</p>
<ul class="simple">
<li><p>Input observations (.obs)</p></li>
<li><p>Input configuration (.conf)</p></li>
<li><p>NLL location (.loc.hyp)</p></li>
<li><p>NLL 3D grid header (.loc.hdr)</p></li>
<li><p>NLL octree (.loc.octree)</p></li>
<li><p>NLL scatter file (.loc.scat)</p></li>
</ul>
<p>In addition to the native NLL output a SeisComP origin object is created and
returned to the calling instance. Usually this object is then sent via messaging.</p>
</section>
<section id="profiles">
<h2>Profiles<a class="headerlink" href="#profiles" title="Permalink to this heading"></a></h2>
<p>The plugin allows to specify multiple configuration profiles (<a class="reference internal" href="#confval-NonLinLoc.profiles"><code class="xref std std-confval docutils literal notranslate"><span class="pre">NonLinLoc.profiles</span></code></a>).
The profile to use can selected both in <cite>scolv</cite> and <cite>screloc</cite>, however a
virtual profile automatic is also provided, which selects the best matching
configured profile based on the initial location. For this reason each profile
contains some configuration parameters that defines where the profile is valid
(<cite>transform</cite>, <cite>region</cite>, <cite>origin</cite>, <cite>rotation</cite>). The <cite>transform</cite> profile
configuration parameter supports only <cite>GLOBAL</cite> or <cite>SIMPLE</cite> at the moment: only the
profile has this limitation, not the NonLinLoc control file, which supports
all transformations available in NonLinLoc.</p>
<p><strong>NOTE</strong>: If a profile <cite>transform</cite> is set as <cite>GLOBAL</cite> and the <cite>region</cite> parameter is
left <cite>empty</cite>, then the plugin adds the line <cite>TRANS GLOBAL</cite> to the control file,
forcing a global transformation.</p>
</section>
<section id="configuration-example">
<h2>Configuration example<a class="headerlink" href="#configuration-example" title="Permalink to this heading"></a></h2>
<p>To add the plugin to an application such as scolv or screloc, add the plugin
name to the list of plugins that are loaded (e.g. <code class="file docutils literal notranslate"><span class="pre">scolv.cfg</span></code>):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>locnll
</pre></div>
</div>
<p>Futhermore add the plugin configuration (e.g. <code class="file docutils literal notranslate"><span class="pre">scolv.cfg</span></code>):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1">########################################################</span>
<span class="c1">################ NonLinLoc configuration################</span>
<span class="c1">########################################################</span>
<span class="nv">NLLROOT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/nll/data
NonLinLoc.outputPath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/output/
<span class="c1"># Define the default control file if no profile specific</span>
<span class="c1"># control file is defined.</span>
NonLinLoc.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.default.conf
<span class="c1"># Set the default pick error in seconds passed to NonLinLoc</span>
<span class="c1"># if no SeisComP pick uncertainty is available.</span>
NonLinLoc.defaultPickError<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>.1
<span class="c1"># Define the available NonLinLoc location profiles. The order</span>
<span class="c1"># implicitly defines the priority for overlapping regions</span>
<span class="c1">#NonLinLoc.profiles = swiss_3d, swiss_1d, global</span>
NonLinLoc.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>swiss_3d,<span class="w"> </span>global
<span class="c1"># The earthModelID is copied to earthModelID attribute of the</span>
<span class="c1"># resulting origin</span>
NonLinLoc.profile.swiss_1d.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;swiss regional 1D&quot;</span>
<span class="c1"># Specify the velocity model table path as used by NonLinLoc</span>
NonLinLoc.profile.swiss_1d.tablePath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/time_1d_regio/regio
<span class="c1"># Specify the region valid for this profile</span>
<span class="c1"># Without this parameter the plugin will add an additional</span>
<span class="c1"># TRANS GLOBAL statement in the NLL control file</span>
NonLinLoc.profile.swiss_1d.region<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">41</span>.2,<span class="w"> </span><span class="m">3</span>.8,<span class="w"> </span><span class="m">50</span>.1,<span class="w"> </span><span class="m">16</span>.8
<span class="c1"># The NonLinLoc control file to use for this profile</span>
NonLinLoc.profile.swiss_1d.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.swiss_1d.conf
<span class="c1"># Configure the swiss_3d profile</span>
NonLinLoc.profile.swiss_3d.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;swiss regional 3D&quot;</span>
NonLinLoc.profile.swiss_3d.tablePath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/time_3d/ch
NonLinLoc.profile.swiss_3d.region<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">45</span>.15,<span class="w"> </span><span class="m">5</span>.7,<span class="w"> </span><span class="m">48</span>.3,<span class="w"> </span><span class="m">11</span>.0
NonLinLoc.profile.swiss_3d.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.swiss_3d.conf
<span class="c1"># And the global profile</span>
NonLinLoc.profile.global.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span>iaspei91
NonLinLoc.profile.global.tablePath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/iasp91/iasp91
NonLinLoc.profile.global.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.global.conf
</pre></div>
</div>
<p>An example of a NonLinLoc control file configuration that contains all the
required statements, but it must be adapted to the specific use case. The
missing statements are generated by the plugin (LOCFILES, LOCHYPOUT, LOCSRCE):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># -1 = no logs, useful for playback with screloc --ep option</span>
CONTROL<span class="w"> </span>-1<span class="w"> </span><span class="m">123456</span>
<span class="c1"># This must be the same TRANS used for generating the grid files</span>
TRANS<span class="w"> </span>SDC<span class="w"> </span><span class="m">46</span>.51036987<span class="w"> </span><span class="m">8</span>.47575546<span class="w"> </span><span class="m">0</span>.0
LOCSIG<span class="w"> </span>Swiss<span class="w"> </span>Seismological<span class="w"> </span>Service,<span class="w"> </span>ETHZ
LOCCOM<span class="w"> </span>location<span class="w"> </span>using<span class="w"> </span>my<span class="w"> </span><span class="nb">local</span><span class="w"> </span>velocity<span class="w"> </span>model
LOCSEARCH<span class="w"> </span>OCT<span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="m">0</span>.001<span class="w"> </span><span class="m">10000</span><span class="w"> </span><span class="m">1000</span>
<span class="c1"># This grid origin is relative to the TRANS statement. The grid</span>
<span class="c1"># must be wholly contained in the grid files</span>
LOCGRID<span class="w"> </span><span class="m">101</span><span class="w"> </span><span class="m">101</span><span class="w"> </span><span class="m">101</span><span class="w"> </span>-0.5<span class="w"> </span>-0.5<span class="w"> </span>-1.8<span class="w"> </span><span class="m">0</span>.01<span class="w"> </span><span class="m">0</span>.01<span class="w"> </span><span class="m">0</span>.01<span class="w"> </span>PROB_DENSITY<span class="w"> </span>SAVE
LOCMETH<span class="w"> </span>EDT_OT_WT<span class="w"> </span><span class="m">9999</span>.0<span class="w"> </span><span class="m">4</span><span class="w"> </span>-1<span class="w"> </span>-1<span class="w"> </span>-1<span class="w"> </span><span class="m">0</span><span class="w"> </span>-1<span class="w"> </span><span class="m">1</span>
LOCGAU<span class="w"> </span><span class="m">0</span>.001<span class="w"> </span><span class="m">0</span>.0
LOCPHASEID<span class="w"> </span>P<span class="w"> </span>P<span class="w"> </span>p<span class="w"> </span>G<span class="w"> </span>Pn<span class="w"> </span>Pg<span class="w"> </span>P1
LOCPHASEID<span class="w"> </span>S<span class="w"> </span>S<span class="w"> </span>s<span class="w"> </span>G<span class="w"> </span>Sn<span class="w"> </span>Sg<span class="w"> </span>S1
LOCQUAL2ERR<span class="w"> </span><span class="m">0</span>.025<span class="w"> </span><span class="m">0</span>.050<span class="w"> </span><span class="m">0</span>.100<span class="w"> </span><span class="m">0</span>.200<span class="w"> </span><span class="m">0</span>.400<span class="w"> </span><span class="m">99999</span>.9
LOCANGLES<span class="w"> </span>ANGLES_YES<span class="w"> </span><span class="m">5</span>
</pre></div>
</div>
<p><strong>NOTE</strong>: The LOCHYPOUT parameter statement is always generated by the plugin.
By default it outputs <cite>LOCHYPOUT NONE</cite>. If <cite>enableSEDParameters</cite> is enabled
or if the original control file contains <cite>CALC_SED_ORIGIN</cite>, it will append
<cite>CALC_SED_ORIGIN</cite>. If the original control file contains <cite>SAVE_NLLOC_EXPECTATION</cite>,
that flag will also be preserved. Currently, only <cite>CALC_SED_ORIGIN</cite> and
<cite>SAVE_NLLOC_EXPECTATION</cite> are supported by the plugin. Any other options are
omitted and will not be forwarded to NonLinLoc.</p>
</section>
<section id="stations-names">
<h2>Stations names<a class="headerlink" href="#stations-names" title="Permalink to this heading"></a></h2>
<p>When generating the grid files the station names used in the GTSRCE statement
must match the rule set in the plugin configuration. E.g.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Format of the station name used to select the right travel time table (grid)</span>
<span class="c1"># file for a station. By default only the station code is used (e.g.</span>
<span class="c1"># tablePath.P.@STA@.time.*), but that doesn&#39;t allow to distinguish between</span>
<span class="c1"># multiple network codes or location codes that use the same station code. To</span>
<span class="c1"># overcome this limitation this parameter could be set in a more general way,</span>
<span class="c1"># for example @NET@_@STA@_@LOC@. In this way NonLinLoc will look for travel</span>
<span class="c1"># time table (grid) files of the form: tablePath.P.@NET@_@STA@_@LOC@.time.*</span>
<span class="c1"># Where @NET@ @STA@ @LOC@ are just placeholder for the actual codes</span>
NonLinLoc.profile.MYPROFILE.stationNameFormat<span class="w"> </span><span class="o">=</span><span class="w"> </span>@NET@_@STA@_@LOC@
</pre></div>
</div>
<p>Given the above plugin configuration, the GTSRCE statement should be something
like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>GTSRCE<span class="w"> </span>CH_STA01_<span class="w"> </span>LATLON<span class="w"> </span><span class="m">46</span>.519<span class="w"> </span><span class="m">8</span>.474<span class="w"> </span><span class="m">0</span>.0<span class="w"> </span><span class="m">1</span>.295
GTSRCE<span class="w"> </span>CH_STA02_01<span class="w"> </span>LATLON<span class="w"> </span><span class="m">46</span>.456<span class="w"> </span><span class="m">8</span>.474<span class="w"> </span><span class="m">0</span>.0<span class="w"> </span><span class="m">1</span>.323
GTSRCE<span class="w"> </span>CH_STA03_AA<span class="w"> </span>LATLON<span class="w"> </span><span class="m">46</span>.784<span class="w"> </span><span class="m">8</span>.474<span class="w"> </span><span class="m">0</span>.0<span class="w"> </span><span class="m">1</span>.292
</pre></div>
</div>
<p>Alternatively the names could just contain the station code:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>NonLinLoc.profile.MYPROFILE.stationNameFormat<span class="w"> </span><span class="o">=</span><span class="w"> </span>@STA@
</pre></div>
</div>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>GTSRCE<span class="w"> </span>STA01<span class="w"> </span>LATLON<span class="w"> </span><span class="m">46</span>.519<span class="w"> </span><span class="m">8</span>.474<span class="w"> </span><span class="m">0</span>.0<span class="w"> </span><span class="m">1</span>.295
GTSRCE<span class="w"> </span>STA02<span class="w"> </span>LATLON<span class="w"> </span><span class="m">46</span>.456<span class="w"> </span><span class="m">8</span>.474<span class="w"> </span><span class="m">0</span>.0<span class="w"> </span><span class="m">1</span>.323
GTSRCE<span class="w"> </span>STA03<span class="w"> </span>LATLON<span class="w"> </span><span class="m">46</span>.784<span class="w"> </span><span class="m">8</span>.474<span class="w"> </span><span class="m">0</span>.0<span class="w"> </span><span class="m">1</span>.292
</pre></div>
</div>
</section>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
<section id="locator">
<h3>Locator<a class="headerlink" href="#locator" title="Permalink to this heading"></a></h3>
<p>The usage of the new NLL plugin is straight forward. Once loaded successfully the
new locator shows up in the lower left corners combo box.</p>
<figure class="align-default">
<img alt="../_images/locator_selection_small1.png" src="../_images/locator_selection_small1.png" />
</figure>
<p>Select the new NonLinLoc locator and the configured profiles will be loaded into
the combo box right of it.</p>
<figure class="align-default">
<img alt="../_images/locator_profile_selection_small1.png" src="../_images/locator_profile_selection_small1.png" />
</figure>
<p>The NonLinLoc implementation provides a virtual profile automatic. This emulates
the complete automatic case and selects the best matching configured profiles
based on the initial location.</p>
<p>If an origin has been relocated the method should be set to “NonLinLoc” and
the earth model contains the string NonLinLoc.profile.[name].earthModelID
configured for the selected profile.</p>
<figure class="align-default">
<img alt="../_images/origin_information1.png" src="../_images/origin_information1.png" />
</figure>
</section>
<section id="settings">
<h3>Settings<a class="headerlink" href="#settings" title="Permalink to this heading"></a></h3>
<p>The NLL locator implementation supports to override configured settings or
control parameters for a session. Those changes are not persistent and lost if
the locator is changed to another one or the profile has been changed. However
this feature is particularly useful when trying differnt settings on a particular
origin or for enabling the NonLinLoc logs (<cite>CONTROL</cite> statement) that becomes
visible on the console.</p>
<p>To open the settings dialog press the button right to the locator selection
combo box.</p>
<figure class="align-default">
<img alt="../_images/locator_settings1.png" src="../_images/locator_settings1.png" />
</figure>
<p>Then the NLL specific parameters show up.</p>
<figure class="align-default">
<img alt="../_images/NLL_settings.png" src="../_images/NLL_settings.png" />
</figure>
</section>
<section id="seismicity-viewer">
<h3>Seismicity Viewer<a class="headerlink" href="#seismicity-viewer" title="Permalink to this heading"></a></h3>
<p>scolv provides two additional configurable buttons. To bind
<a class="reference external" href="http://alomax.free.fr/seismicity">Seismicity Viewer</a> to the first one the
following configuration can be used:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">button0</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;Seismicity Viewer&quot;</span>
scripts.script0<span class="w"> </span><span class="o">=</span><span class="w"> </span>@CONFIGDIR@/scripts/sv
</pre></div>
</div>
<p>A small wrapper script sv has been created that calls Seismicity Viewer based
on the origin ID passed to the script.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="nv">FILE</span><span class="o">=</span><span class="nv">$HOME</span>/nll/data/output/<span class="nv">$1</span>.loc.hyp
java<span class="w"> </span>-classpath<span class="w"> </span><span class="nv">$HOME</span>/nll/bin/SeismicityViewer50.jar<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>net.alomax.seismicity.Seismicity<span class="w"> </span><span class="nv">$FILE</span>
</pre></div>
</div>
<p>This examples assumes that Seismicity Viewer has been installed in $HOME/nll/bin.</p>
</section>
</section>
<section id="module-configuration">
<span id="global-nonlinloc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.publicID">
<span class="sig-name descname"><span class="pre">NonLinLoc.publicID</span></span><a class="headerlink" href="#confval-NonLinLoc.publicID" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">NLL.&#64;time/%Y%m%d%H%M%S.%f&#64;.&#64;id&#64;</span></code></p>
<p>Type: <em>string</em></p>
<p>PublicID creation pattern for an origin created by NonLinLoc.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.outputPath">
<span class="sig-name descname"><span class="pre">NonLinLoc.outputPath</span></span><a class="headerlink" href="#confval-NonLinLoc.outputPath" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/tmp/sc3.nll</span></code></p>
<p>Type: <em>path</em></p>
<p>Defines the output path for all native NonLinLoc input and output files.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.saveInput">
<span class="sig-name descname"><span class="pre">NonLinLoc.saveInput</span></span><a class="headerlink" href="#confval-NonLinLoc.saveInput" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Save input files *.obs in outputPath for later processing.
Setting to false reduces file i/o and saves disk space.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.saveIntermediateOutput">
<span class="sig-name descname"><span class="pre">NonLinLoc.saveIntermediateOutput</span></span><a class="headerlink" href="#confval-NonLinLoc.saveIntermediateOutput" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Save output files in outputPath for later processing or
for viewing by the Seismicity Viewer.
Setting to false reduces file i/o and saves disk space.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.controlFile">
<span class="sig-name descname"><span class="pre">NonLinLoc.controlFile</span></span><a class="headerlink" href="#confval-NonLinLoc.controlFile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
<p>The default NonLinLoc control file to use.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.defaultPickError">
<span class="sig-name descname"><span class="pre">NonLinLoc.defaultPickError</span></span><a class="headerlink" href="#confval-NonLinLoc.defaultPickError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>The default pick error in seconds passed to NonLinLoc if a SeisComP pick
object does not provide pick time uncertainties.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.fixedDepthGridSpacing">
<span class="sig-name descname"><span class="pre">NonLinLoc.fixedDepthGridSpacing</span></span><a class="headerlink" href="#confval-NonLinLoc.fixedDepthGridSpacing" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.1</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>Since NLL does not support fixing the depth natively so this
feature is emulated by settings the Z grid very tight around
the depth to be fixed. This value sets the Z grid spacing.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.allowMissingStations">
<span class="sig-name descname"><span class="pre">NonLinLoc.allowMissingStations</span></span><a class="headerlink" href="#confval-NonLinLoc.allowMissingStations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Picks from stations with missing configuration will be
ignored. The origin will be relocated without that pick
if possible.</p>
<p>If set to false, the plug-in throws
an excepection without locating.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profiles">
<span class="sig-name descname"><span class="pre">NonLinLoc.profiles</span></span><a class="headerlink" href="#confval-NonLinLoc.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defines a list of active profiles to be used by the plugin.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>NonLinLoc.profile.$name.*</strong>
<em>Defines a regional profile that is used if a prelocation falls</em>
<em>inside the configured region.</em>
$name is a placeholder for the name to be used and needs to be added to <a class="reference internal" href="#confval-NonLinLoc.profiles"><code class="xref std std-confval docutils literal notranslate"><span class="pre">NonLinLoc.profiles</span></code></a> to become active.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>NonLinLoc.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>a,b
NonLinLoc.profile.a.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
NonLinLoc.profile.b.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
<span class="c1"># c is not active because it has not been added</span>
<span class="c1"># to the list of NonLinLoc.profiles</span>
NonLinLoc.profile.c.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.earthModelID">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.earthModelID</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.earthModelID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>earthModelID that is stored in the created origin.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.methodID">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.methodID</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.methodID" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">NonLinLoc</span></code></p>
<p>Type: <em>string</em></p>
<p>methodID that is stored in the created origin.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.tablePath">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.tablePath</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.tablePath" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
<p>Path to travel time tables (grids).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.stationNameFormat">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.stationNameFormat</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.stationNameFormat" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;STA&#64;</span></code></p>
<p>Type: <em>string</em></p>
<p>Format of the station name used to select the right travel time table (grid) file
for a station.
By default only the station code is used (e.g. tablePath.P.&#64;STA&#64;.time.*), but
that doesnt allow to distinguish between multiple network codes or location codes
that use the same station code.
To overcome this limitation this parameter could be set in a more general way, for
example &#64;NET&#64;_&#64;STA&#64;_&#64;LOC&#64;. In this way NonLinLoc will look for
travel time table (grid) files of the form: tablePath.P.&#64;NET&#64;_&#64;STA&#64;_&#64;LOC&#64;.time.*
Where &#64;NET&#64; &#64;STA&#64; &#64;LOC&#64; are just placeholder for the actual codes</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.controlFile">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.controlFile</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.controlFile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
<p>Control file of the current profile. If not set, the default
control file will be used instead.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.transform">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.transform</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.transform" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code></p>
<p>Type: <em>string</em></p>
<p>Transformation type of the configured region. Supported are
SIMPLE and GLOBAL.</p>
<p>Default: GLOBAL is assumed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.region">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.region</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.region" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:double</em></p>
<p>Defines the 4 corner values of the epicentral region for selecting the profile.
The original epicentre must be within the region.</p>
<p>If transform is GLOBAL: min_lat, min_lon, max_lat, max_lon.
The values define the geographic corner coordinates. Unit is degree.</p>
<p>If transform is SIMPLE: xmin, ymin, xmax, ymax.
The values define the region relative to the configured origin.
Unit is km.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.origin">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.origin</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.origin" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:double</em></p>
<p>Unit: <em>deg</em></p>
<p>Only used for transformation SIMPLE. Expects 2 values: latitude, longitude.
The value define the geographic origin of the area spanned by region.
Unit is degree.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-NonLinLoc.profile.-name.rotation">
<span class="sig-name descname"><span class="pre">NonLinLoc.profile.$name.rotation</span></span><a class="headerlink" href="#confval-NonLinLoc.profile.-name.rotation" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Only used for transformation SIMPLE. Defines the rotation around the
origin of the defined region.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">NonLinLoc</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#error-measures">Error measures</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
<li><a class="reference internal" href="#profiles">Profiles</a></li>
<li><a class="reference internal" href="#configuration-example">Configuration example</a></li>
<li><a class="reference internal" href="#stations-names">Stations names</a></li>
<li><a class="reference internal" href="#usage">Usage</a><ul>
<li><a class="reference internal" href="#locator">Locator</a></li>
<li><a class="reference internal" href="#settings">Settings</a></li>
<li><a class="reference internal" href="#seismicity-viewer">Seismicity Viewer</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_md.html"
title="previous chapter">Md</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_mlh.html"
title="next chapter">MLh</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_nonlinloc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,749 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>RecordStream &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Ms_20" href="global_ms_20.html" />
<link rel="prev" title="LocRouter" href="global_locrouter.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">6.9.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="global_ms_20.html" title="Ms_20"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_locrouter.html" title="LocRouter"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="recordstream">
<span id="global-recordstream"></span><h1>RecordStream<a class="headerlink" href="#recordstream" title="Permalink to this heading"></a></h1>
<p>RecordStream interface for SeisComP.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><cite>SeisComP</cite> applications access waveform data through the RecordStream interface.
The following tables lists available implementations:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>URL Scheme(s)</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="#rs-arclink"><span class="std std-ref">ArcLink</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">arclink</span></code></p></td>
<td><p>Connects to an ArcLink server</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#rs-balanced"><span class="std std-ref">Balanced</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">balanced</span></code></p></td>
<td><p>Distributes requests to multiple proxy streams</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#rs-routing"><span class="std std-ref">Routing</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">routing</span></code></p></td>
<td><p>Distributes requests to multiple proxy streams according to user defined rules</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#rs-caps"><span class="std std-ref">CAPS</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">caps</span></code>, <code class="docutils literal notranslate"><span class="pre">capss</span></code></p></td>
<td><p>Connects to a <a class="reference external" href="https://www.gempa.de/products/caps/">gempa CAPS server</a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#rs-combined"><span class="std std-ref">Combined</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">combined</span></code></p></td>
<td><p>Combines archive and real-time stream</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#rs-dec"><span class="std std-ref">Decimation</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">dec</span></code></p></td>
<td><p>Decimates (downsamples) a proxy stream</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#rs-fdsnws"><span class="std std-ref">FDSNWS</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">fdsnws</span></code>, <code class="docutils literal notranslate"><span class="pre">fdsnwss</span></code></p></td>
<td><p>Connects to <a class="reference internal" href="fdsnws.html#fdsnws"><span class="std std-ref">FDSN web service</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#rs-file"><span class="std std-ref">File</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">file</span></code></p></td>
<td><p>Reads records from file</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#rs-memory"><span class="std std-ref">Memory</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">memory</span></code></p></td>
<td><p>Reads records from memory</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#rs-resample"><span class="std std-ref">Resample</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">resample</span></code></p></td>
<td><p>Resamples (up or down) a proxy stream to a given sampling rate</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#rs-sdsarchive"><span class="std std-ref">SDSArchive</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">sdsarchive</span></code></p></td>
<td><p>Reads records from <cite>SeisComP</cite> archive (<a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a>)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#rs-slink"><span class="std std-ref">SeedLink</span></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">slink</span></code></p></td>
<td><p>Connects to <a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">SeedLink server</span></a></p></td>
</tr>
</tbody>
</table>
</section>
<section id="application">
<h2>Application<a class="headerlink" href="#application" title="Permalink to this heading"></a></h2>
<p>The RecordStream parameters considered by an application are provided as a <em>URL</em>
in 2 alternative ways:</p>
<ul class="simple">
<li><p>Specification of the <em>URL</em> on the command line. Use the option <code class="docutils literal notranslate"><span class="pre">-I</span> <span class="pre">URL</span></code></p></li>
<li><p>Configuration of the <em>URL</em> using the global parameter <a class="reference internal" href="global.html#confval-recordstream"><code class="xref std std-confval docutils literal notranslate"><span class="pre">recordstream</span></code></a>.</p></li>
</ul>
<p>The URL scheme defines the specific RecordStream implementation. If the scheme
is omitted, the <a class="reference internal" href="#rs-file"><span class="std std-ref">File</span></a> implementation is used as default.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Older SeisComP versions used to split the URL into the parameters
<code class="xref std std-confval docutils literal notranslate"><span class="pre">recordstream.service</span></code> and <code class="xref std std-confval docutils literal notranslate"><span class="pre">recordstream.source</span></code>.
These parameters are not being used anymore.</p>
</div>
</section>
<section id="implementations">
<h2>Implementations<a class="headerlink" href="#implementations" title="Permalink to this heading"></a></h2>
<section id="seedlink">
<span id="rs-slink"></span><h3>SeedLink<a class="headerlink" href="#seedlink" title="Permalink to this heading"></a></h3>
<p>This RecordStream fetches data from a SeedLink server.</p>
<section id="definition">
<h4>Definition<a class="headerlink" href="#definition" title="Permalink to this heading"></a></h4>
<p>URL: <code class="docutils literal notranslate"><span class="pre">slink://[host][:port][?parameter]</span></code></p>
<p>The default host is set to <cite>localhost</cite>, the default port to <cite>18000</cite>. Optional
URL encoded parameters are:</p>
<ul class="simple">
<li><p><cite>timeout</cite> - connection timeout in seconds, default: 300</p></li>
<li><p><cite>retries</cite> - number of connection retry attempts, default: -1</p></li>
<li><p><cite>no-batch</cite> - disables BATCH mode to request data, does not take a value</p></li>
</ul>
</section>
<section id="examples">
<h4>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">slink://</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">slink://geofon.gfz-potsdam.de?timeout=60&amp;retries=5</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">slink://localhost:18000</span></code></p></li>
</ul>
</section>
</section>
<section id="arclink">
<span id="rs-arclink"></span><h3>ArcLink<a class="headerlink" href="#arclink" title="Permalink to this heading"></a></h3>
<p>This RecordStream fetches data from a ArcLink server.</p>
<section id="id1">
<h4>Definition<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h4>
<p>URL: <code class="docutils literal notranslate"><span class="pre">arclink://[host][:port][?parameters]</span></code></p>
<p>The default host is set to <cite>localhost</cite>, the default port to <cite>18001</cite>. Optional
URL encoded parameters are:</p>
<ul class="simple">
<li><p><cite>user</cite> - user name required on some servers</p></li>
<li><p><cite>pwd</cite> - password required on some servers</p></li>
<li><p><cite>dump</cite> - optional output file for all records being received</p></li>
</ul>
</section>
<section id="id2">
<h4>Examples<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclink://</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">arclink://geofon.gfz-potsdam.de?user=foo&amp;pwd=secret</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">arclink://localhost:18042</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">arclink://localhost?dump=test.mseed</span></code></p></li>
</ul>
</section>
</section>
<section id="fdsnws">
<span id="rs-fdsnws"></span><h3>FDSNWS<a class="headerlink" href="#fdsnws" title="Permalink to this heading"></a></h3>
<p>This RecordStream fetches data from a FDSN web service.</p>
<section id="id3">
<h4>Definition<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h4>
<p>URL: <code class="docutils literal notranslate"><span class="pre">fdsnws[s]://host[:port][path]</span></code></p>
<p>The host is a mandatory parameter. The default port depends on the URL scheme
used:</p>
<ul class="simple">
<li><p><cite>fdsnws</cite>: <cite>80</cite> (HTTP)</p></li>
<li><p><cite>fdsnwss</cite>: <cite>443</cite> (HTTPS)</p></li>
</ul>
<p>The default path is set to <cite>/fdsnws/dataselect/1/query</cite>. If a path is specified,
it needs to be complete up until the <cite>query</cite> resource.</p>
<p>Authentication via the <cite>queryauth</cite> resource is currently not supported.</p>
</section>
<section id="id4">
<h4>Examples<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">fdsnws://service.iris.edu</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fdsnws://service.iris.edu:80/fdsnws/dataselect/1/query</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fdsnwss://geofon.gfz-potsdam.de</span></code></p></li>
</ul>
</section>
</section>
<section id="file">
<span id="rs-file"></span><h3>File<a class="headerlink" href="#file" title="Permalink to this heading"></a></h3>
<p>This RecordStream reads data from a file.</p>
<section id="id5">
<h4>Definition<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h4>
<p>URL: <code class="docutils literal notranslate"><span class="pre">file://path</span></code></p>
<p>The path may be a absolute or relative path to a file. Environment variables
are <strong>not</strong> resolved. If path is set to <code class="docutils literal notranslate"><span class="pre">-</span></code> the data is read from <cite>stdin</cite>.</p>
<p>Supported files types are:</p>
<ul class="simple">
<li><p>miniSEED</p></li>
<li><p>SAC</p></li>
<li><p>XML</p></li>
<li><p>binary</p></li>
</ul>
<p>By default the record type is set to <cite>mseed</cite>. SAC data can be read using the <em>#sac</em>
descriptor. If a file name extension is available, then the record type is set as
follows:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Extension</p></th>
<th class="head"><p>Record Type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><cite>*.xml</cite></p></td>
<td><p><cite>xml</cite></p></td>
</tr>
<tr class="row-odd"><td><p><cite>*.bin</cite></p></td>
<td><p><cite>binary</cite></p></td>
</tr>
<tr class="row-even"><td><p><cite>*.mseed</cite></p></td>
<td><p><cite>mseed</cite></p></td>
</tr>
</tbody>
</table>
<p>Optional descriptor:</p>
<ul class="simple">
<li><p><cite>sac</cite> - input data are in SAC format.</p></li>
</ul>
</section>
<section id="id6">
<h4>Examples<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">file://-</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">file:///tmp/input.mseed</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">file:///tmp/input.sac#sac</span></code></p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When defining the File RecordStream on the command line using the option <cite>-I</cite>,
the file name can also be passed without the URL scheme, e.g.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">I</span> <span class="o">-</span>
<span class="o">-</span><span class="n">I</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="nb">input</span><span class="o">.</span><span class="n">mseed</span>
</pre></div>
</div>
</div>
</section>
</section>
<section id="sdsarchive">
<span id="rs-sdsarchive"></span><h3>SDSArchive<a class="headerlink" href="#sdsarchive" title="Permalink to this heading"></a></h3>
<p>This RecordStream reads data from one or more <cite>SeisComP</cite> (<a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a>) archives using the
<a class="reference internal" href="#rs-file"><span class="std std-ref">File</span></a> RecordStream.</p>
<section id="id7">
<h4>Definition<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h4>
<p>URL: <code class="docutils literal notranslate"><span class="pre">sdsarchive://[path[,path2[,</span> <span class="pre">...]]]</span></code></p>
<p>The default path is set to <cite>$SEISCOMP_ROOT/var/lib/archive</cite>.</p>
<p>In contrast to a formal URL definition, the URL path is interpreted as a directory path list
separated by commas.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When defining multiple directories separated by comma in a configuration
file, please enclose the entire definition (including <code class="docutils literal notranslate"><span class="pre">sdsarchive://</span></code> with
double quotes. Otherwise the configuration parser will interpret it as a list
and will only return the first part up to the first comma.</p>
</div>
<p>Different SDS archives are not merged, but are read sequentially depending on
data existence. If a requested file is missing in the current SDS archive, it is
searched for in the archive next in the list. On success it will deliver all
the rest of files for the current channel from this SDS archive. On failure the
next SDS archive is searched.</p>
<p>This process is repeated for each requested channel individually. It always
starts to search data from the first given SDS to the last one, for each data
channel.</p>
</section>
<section id="id8">
<h4>Examples<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sdsarchive://</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sdsarchive:///home/sysop/seiscomp/var/lib/archive</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sdsarchive:///SDSA,/SDSB,/SDSC</span></code></p></li>
</ul>
</section>
</section>
<section id="caps">
<span id="rs-caps"></span><h3>CAPS<a class="headerlink" href="#caps" title="Permalink to this heading"></a></h3>
<p>This RecordStream reads data from a
<a class="reference external" href="https://www.gempa.de/products/caps/">gempa CAPS server</a>.</p>
<section id="id10">
<h4>Definition<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h4>
<p>URL: <code class="docutils literal notranslate"><span class="pre">caps[s]://[user:pass&#64;][host[:port]][?parameters]</span></code></p>
<p>The default host is set to <cite>localhost</cite>. The default port depends on the URL scheme
used:</p>
<ul class="simple">
<li><p><cite>caps</cite>: <cite>18002</cite></p></li>
<li><p><cite>capss</cite>: <cite>18022</cite> (SSL)</p></li>
</ul>
<p>Optional URL encoded parameters are:</p>
<ul class="simple">
<li><dl class="simple">
<dt><cite>arch</cite> - No parameter. Retrieve only archived data. In this mode the connection</dt><dd><p>finished when all available data has been sent. It wont wait for additional
real-time data.</p>
</dd>
</dl>
</li>
<li><p><cite>ooo</cite> - Allow out-of-order data</p></li>
<li><p><cite>timeout</cite> - The socket timeout in seconds</p></li>
<li><dl class="simple">
<dt><cite>user</cite> - <strong>Deprecated:</strong> The user name of an authenticated request. Please use</dt><dd><p>the standard URL userinfo in front of the host instead.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt><cite>pwd</cite> - <strong>Deprecated:</strong> The password of an authenticated request. Please use</dt><dd><p>the standard URL userinfo in front of the host instead.</p>
</dd>
</dl>
</li>
<li><p><cite>request-file</cite> - Use the given file to feed the request</p></li>
</ul>
</section>
<section id="example">
<h4>Example<a class="headerlink" href="#example" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">caps://</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">caps://localhost:18002</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">capss://localhost:18022</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">caps://localhost:18002?arch</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">capss://user:mysecret&#64;localhost</span></code></p></li>
</ul>
</section>
</section>
<section id="memory">
<span id="rs-memory"></span><h3>Memory<a class="headerlink" href="#memory" title="Permalink to this heading"></a></h3>
<p>This RecordStream reads data from memory and is only useful for developing
applications. For instance a record sequence stored in an internal buffer could
be passed to an instance of this RecordStream for reading.</p>
</section>
<section id="combined">
<span id="rs-combined"></span><h3>Combined<a class="headerlink" href="#combined" title="Permalink to this heading"></a></h3>
<p>This RecordStream combines one archive and one real-time RecordStream, e.g.
<a class="reference internal" href="#rs-arclink"><span class="std std-ref">ArcLink</span></a> and <a class="reference internal" href="#rs-slink"><span class="std std-ref">SeedLink</span></a>. First the archive stream is read up to
the size of the real-time buffer. Then the acquisition is switched to the
real-time stream. The syntax for the source is similar to an URL:</p>
<section id="id11">
<h4>Definition<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h4>
<p>URL-like: <code class="docutils literal notranslate"><span class="pre">combined://[real-time-stream];[archive-stream][??parameters]</span></code></p>
<p>By default the real-time stream is set to <a class="reference internal" href="#rs-slink"><span class="std std-ref">SeedLink</span></a> and the
archive-stream is set to <a class="reference internal" href="#rs-arclink"><span class="std std-ref">ArcLink</span></a>. Any other streams may be configured.</p>
<p>The definition of the proxy streams has slightly changed: Scheme and source are
only separated by a slash, e.g. <cite>slink://localhost</cite> needs to be defined as
<cite>slink/localhost</cite>.</p>
<p>The URL parameters of the combined stream are separated by 2 question marks
(<cite>??</cite>) in order to distinguish them from the parameters used in the proxy
streams:</p>
<ul>
<li><p><cite>slinkMax|rtMax|1stMax</cite> - Buffer size in seconds of the first stream
(typically the real-time stream), default: 3600</p>
<p>Time spans can be configured with an additional and optional suffix:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Suffix</p></th>
<th class="head"><p>Multiplicator</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>s</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p>m</p></td>
<td><p>60</p></td>
</tr>
<tr class="row-even"><td><p>h</p></td>
<td><p>3600</p></td>
</tr>
<tr class="row-odd"><td><p>d</p></td>
<td><p>86400</p></td>
</tr>
<tr class="row-even"><td><p>w</p></td>
<td><p>86400*7</p></td>
</tr>
</tbody>
</table>
</li>
<li><p><cite>splitTime</cite> - The absolute time of the separation of both sources. The argument
is an ISO time string, e.g. 2018-05-10T12:00:00Z or a year, e.g. 2018, which is
the same as 2018-01-01T00:00:00.000Z.
<cite>splitTime</cite> can be used if the waveform archives are spread over several
directories or hard disks. See also the <a class="reference internal" href="#rs-splittime"><span class="std std-ref">examples</span></a>.</p></li>
</ul>
<p>The combined record stream may be nested allowing the configuration of a
(theoretically) infinite number of archive streams. The URL syntax for a nested
configuration uses parenthesis:</p>
<p><code class="docutils literal notranslate"><span class="pre">combined://real-time-stream;combined/(archive-stream1;archive-stream2??parameters)??parameters</span></code></p>
</section>
<section id="rs-splittime">
<span id="id12"></span><h4>Examples<a class="headerlink" href="#rs-splittime" title="Permalink to this heading"></a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>URL</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">combined://localhost:18000;localhost:18001</span></code></p></td>
<td><p>Seedlink on localhost:18000 combined with Arclink on localhost 18001</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">combined://slink/localhost:18000;arclink/localhost:18001</span></code></p></td>
<td><p>Same as above</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">combined://;</span></code></p></td>
<td><p>Same as above</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">combined://:18042;?user=foo&amp;pwd=secret??rtMax=1800</span></code></p></td>
<td><p>Seedlink on localhost:18042 combined with Arclink on localhost 18001, real-time (SeedLink) buffer size set to 30min</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">combined://slink/localhost:18000;sdsarchive//home/sysop/seiscomp/var/lib/archive</span></code></p></td>
<td><p>Seedlink combined with SDS archive</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">combined://slink/localhost:18000;combined/(arclink/localhost:18001;arclink/localhost:18002??1stMax=30d)??1stMax=1h</span></code></p></td>
<td><p>Seedlink combined with a combined record stream using two Arclink sources</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">combined://slink/localhost:18000;combined/(sdsarchive//home/sysop/seiscomp/var/lib/archive;combined/(sdsarchive//home/sysop/seiscomp/var/lib/archive2017;sdsarchive//home/sysop/seiscomp/var/lib/archive2016??splitTime=2017)??splitTime=2018)</span></code></p></td>
<td><p>Seedlink combined with a combined recordStream providing access to 3 different SDS archives separated by time. The first SDS archive contains the most recent archived data. The other two contain the data from 2016 and 2017.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">combined://slink/localhost:18000;combined/(sdsarchive//home/sysop/seiscomp/var/lib/archive;combined/(sdsarchive//home/sysop/seiscomp/var/lib/archive2017;sdsarchive//home/sysop/seiscomp/var/lib/archive2016??splitTime=2017-06-01T00:00:00Z)??splitTime=2018-06-01T00:00:00Z)</span></code></p></td>
<td><p>Seedlink combined with a combined recordStream providing access to 3 different SDS archives separated by time. The first SDS archive contains the most recent archived data. The other two are separated in mid of 2016.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="balanced">
<span id="rs-balanced"></span><h3>Balanced<a class="headerlink" href="#balanced" title="Permalink to this heading"></a></h3>
<p>This RecordStream distributes requests quasi-equally (but deterministically) to
multiple proxy streams. It can be used for load balancing and to improve failure
tolerance. The algorithm to choose a proxy stream (counting from 0) is based on
station code and can be expressed in Python as follows:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">stationCode</span> <span class="o">=</span> <span class="s2">&quot;WLF&quot;</span>
<span class="n">nproxies</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">x</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">stationCode</span><span class="p">:</span>
<span class="n">x</span> <span class="o">+=</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;choosing proxy stream&quot;</span><span class="p">,</span> <span class="n">x</span> <span class="o">%</span> <span class="n">nproxies</span><span class="p">)</span>
</pre></div>
</div>
<section id="id13">
<h4>Definition<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h4>
<p>URL-like: <code class="docutils literal notranslate"><span class="pre">balanced://proxy-stream[;proxy-stream2[;</span> <span class="pre">...]]</span></code></p>
<p>The definition of the proxy streams has slightly changed: Scheme and source
are only separated by a slash, e.g. <cite>slink://localhost</cite> needs to be defined as
<cite>slink/localhost</cite>.</p>
</section>
<section id="id14">
<h4>Examples<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>URL</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">balanced://slink/server1:18000;slink/server2:18000</span></code></p></td>
<td><p>Distribute requests to 2 <a class="reference internal" href="#rs-slink"><span class="std std-ref">SeedLink</span></a> RecordStreams</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">balanced://combined/(server1:18000;server1:18001);combined/(server2:18000;server2:18001)</span></code></p></td>
<td><p>Distribute requests to 2 <a class="reference internal" href="#rs-combined"><span class="std std-ref">Combined</span></a> RecordStreams</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="routing">
<span id="rs-routing"></span><h3>Routing<a class="headerlink" href="#routing" title="Permalink to this heading"></a></h3>
<p>This RecordStream distributes requests to multiple proxy streams according to
user supplied routing rules, which allow to route specific network, station,
location or channel codes to fixed proxy streams.</p>
<section id="id15">
<h4>Definition<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h4>
<p>URL-like: <code class="docutils literal notranslate"><span class="pre">routing://proxy-stream??match=pattern[;proxy-stream2??match=pattern[;</span> <span class="pre">...]]</span></code></p>
<p>The definition of the proxy streams has slightly changed: Scheme and source
are only separated by a slash, e.g. <cite>slink://localhost</cite> needs to be defined as
<cite>slink/localhost</cite>.</p>
<p>The URL parameters of the routing stream are separated by 2 question marks
(<cite>??</cite>) in order to distinguish them from the parameters used in the proxy
streams.</p>
<p><cite>pattern</cite> defines the rule used to route the request to the proxy stream and it is
in <cite>NET.STA.LOC.CHA</cite> format. The special characters <cite>?</cite> <cite>*</cite> <cite>|</cite> <cite>(</cite> <cite>)</cite> are allowed.</p>
</section>
<section id="id16">
<h4>Examples<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>URL</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">routing://slink/server1:18000??match=(NET1|NET2).*.*.*;slink/server2:18000??match=*.*.*.*</span></code></p></td>
<td><p>Requests for network <cite>NET1</cite> and <cite>NET2</cite> go to server1, all the rest to server2</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">routing://slink/server1:18000??match=TMP?.*.*.*;slink/server2:18000??match=NET.*.*.*</span></code></p></td>
<td><p>Requests for network <cite>TMPX</cite> go to server1, for network <cite>NET</cite> go to server 2, all the rest are not fulfilled</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">routing://slink/server1:18000??match=*.*.*.(HH|EH)?;slink/server2:18000??match=*.*.*.*</span></code></p></td>
<td><p>Requests for channels <cite>HH</cite> and <cite>EH</cite> go to server1, all the rest to server2</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">routing://combined/(server1:18000;server1:18001??rtMax=1800)??match=NET1.*.*.*;combined/(server2:18000;server2:18001??rtMax=1800)??match=NET2.*.*.*</span></code></p></td>
<td><p>Split requests to 2 <a class="reference internal" href="#rs-combined"><span class="std std-ref">Combined</span></a> RecordStreams according to the network code <cite>STA1</cite> or <cite>STA2</cite>. Other network codes are not fullfilled</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">routing://combined/(slink/special-server:18000;sdsarchive//home/sysop/seiscomp/var/lib/special-archive)??match=SP.*.*.*;combined/(slink/default-server:18000;sdsarchive//home/sysop/seiscomp/var/lib/default-archive)??match=*.*.*.*</span></code></p></td>
<td><p>Requests for special network <cite>SP</cite> are fullfilled by seedlink <cite>special-server</cite> and sdsarchive <cite>/home/sysop/seiscomp/var/lib/special-archive</cite>, all the rest are fullfilled by seedlink <cite>default-server</cite> and archive <cite>/home/sysop/seiscomp/var/lib/default-archive</cite></p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="decimation">
<span id="rs-dec"></span><h3>Decimation<a class="headerlink" href="#decimation" title="Permalink to this heading"></a></h3>
<p>This RecordStream decimates (downsamples) a proxy stream, e.g. <a class="reference internal" href="#rs-slink"><span class="std std-ref">SeedLink</span></a>.</p>
<section id="id17">
<h4>Definition<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h4>
<p>URL-like: <code class="docutils literal notranslate"><span class="pre">dec://proxy-stream-scheme[?dec-parameters]/[proxy-stream-source]</span></code></p>
<p>The definition of the proxy streams has slightly changed: Scheme and source are
only separated by a slash, e.g. <cite>slink://localhost</cite> needs to be defined as
<cite>slink/localhost</cite>. Also optional decimation parameters directly follow the proxy
stream scheme.</p>
<p>Optional decimation parameters are:</p>
<ul class="simple">
<li><p><cite>rate</cite> - target sampling rate in Hz, default: 1</p></li>
<li><p><cite>fp</cite> - default: 0.7</p></li>
<li><p><cite>fs</cite> - default: 0.9</p></li>
<li><p><cite>cs</cite> - coefficient scale, default: 10</p></li>
</ul>
</section>
<section id="id18">
<h4>Examples<a class="headerlink" href="#id18" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dec://slink/localhost:18000</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dec://file?rate=2/-</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dec://combined/;</span></code></p></li>
</ul>
</section>
</section>
<section id="resample">
<span id="rs-resample"></span><h3>Resample<a class="headerlink" href="#resample" title="Permalink to this heading"></a></h3>
<p>This RecordStream resamples (up or down) a proxy stream, e.g. <a class="reference internal" href="#rs-slink"><span class="std std-ref">SeedLink</span></a>,
to a given sampling rate.</p>
<section id="id19">
<h4>Definition<a class="headerlink" href="#id19" title="Permalink to this heading"></a></h4>
<p>URL-like: <code class="docutils literal notranslate"><span class="pre">resample://proxy-stream-scheme[?dec-parameters]/[proxy-stream-source]</span></code></p>
<p>The definition of the proxy streams has slightly changed: Scheme and source are
only separated by a slash, e.g. <cite>slink://localhost</cite> needs to be defined as
<cite>slink/localhost</cite>. Also optional decimation parameters directly follow the proxy
stream scheme.</p>
<p>Optional resample parameters are:</p>
<ul class="simple">
<li><p><cite>rate</cite> - target sampling rate in Hz, default: 1</p></li>
<li><p><cite>fp</cite> - default: 0.7</p></li>
<li><p><cite>fs</cite> - default: 0.9</p></li>
<li><p><cite>cs</cite> - coefficient scale, default: 10</p></li>
<li><p><cite>lw</cite> - lanczos kernel width, default: 3</p></li>
<li><p><cite>debug</cite> - enables debug output, default: false</p></li>
</ul>
</section>
<section id="id20">
<h4>Examples<a class="headerlink" href="#id20" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">resample://slink/localhost:18000</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">resample://file?rate=2/-</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">resample://combined/;</span></code></p></li>
</ul>
</section>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">RecordStream</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#application">Application</a></li>
<li><a class="reference internal" href="#implementations">Implementations</a><ul>
<li><a class="reference internal" href="#seedlink">SeedLink</a><ul>
<li><a class="reference internal" href="#definition">Definition</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#arclink">ArcLink</a><ul>
<li><a class="reference internal" href="#id1">Definition</a></li>
<li><a class="reference internal" href="#id2">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#fdsnws">FDSNWS</a><ul>
<li><a class="reference internal" href="#id3">Definition</a></li>
<li><a class="reference internal" href="#id4">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#file">File</a><ul>
<li><a class="reference internal" href="#id5">Definition</a></li>
<li><a class="reference internal" href="#id6">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#sdsarchive">SDSArchive</a><ul>
<li><a class="reference internal" href="#id7">Definition</a></li>
<li><a class="reference internal" href="#id8">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#caps">CAPS</a><ul>
<li><a class="reference internal" href="#id10">Definition</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#memory">Memory</a></li>
<li><a class="reference internal" href="#combined">Combined</a><ul>
<li><a class="reference internal" href="#id11">Definition</a></li>
<li><a class="reference internal" href="#rs-splittime">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#balanced">Balanced</a><ul>
<li><a class="reference internal" href="#id13">Definition</a></li>
<li><a class="reference internal" href="#id14">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#routing">Routing</a><ul>
<li><a class="reference internal" href="#id15">Definition</a></li>
<li><a class="reference internal" href="#id16">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#decimation">Decimation</a><ul>
<li><a class="reference internal" href="#id17">Definition</a></li>
<li><a class="reference internal" href="#id18">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#resample">Resample</a><ul>
<li><a class="reference internal" href="#id19">Definition</a></li>
<li><a class="reference internal" href="#id20">Examples</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_locrouter.html"
title="previous chapter">LocRouter</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_ms_20.html"
title="next chapter">Ms_20</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_recordstream.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,555 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>StdLoc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="LocExt" href="global_locext.html" />
<link rel="prev" title="GUI" href="global_gui.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">6.9.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="global_locext.html" title="LocExt"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="global_gui.html" title="GUI"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/global.html" accesskey="U">global</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="stdloc">
<span id="global-stdloc"></span><h1>StdLoc<a class="headerlink" href="#stdloc" title="Permalink to this heading"></a></h1>
<p>Generic locator plugin for SeisComP.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>StdLoc is a SeisComP locator plugin that combines standard location methods
and was developed with the focus on local seismicity, although the methods
are generic enough to work at larger scales as well.</p>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>To enable StdLoc the plugin <code class="docutils literal notranslate"><span class="pre">stdloc</span></code> must be loaded.</p>
</section>
<section id="how-does-it-work">
<h2>How does it work?<a class="headerlink" href="#how-does-it-work" title="Permalink to this heading"></a></h2>
<p>The locator can apply a multitude of location methods and it is particularly useful to
combine them to achieve better solutions:</p>
<ul>
<li><p>LeastSquares: this is the classic algorithm that solves the linearized problem of
travel time residual minimization via iterative least squares. However an initial
location estimate is required. This is the intended method to select when StdLoc
is used in combination with a pick associator: it provides the initial location
estimate and StdLoc will improve it. When used in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a>,
the location of the origin to be relocated is used as starting estimate.
The configuration doesnt require any mandatory parameters:</p>
<blockquote>
<div><div class="highlight-params notranslate"><div class="highlight"><pre><span></span>method = LeastSquares
</pre></div>
</div>
</div></blockquote>
</li>
<li><p>GridSearch: finds the source parameters by evaluating the hypocenter probability
of each point in a grid and returning the maximum likelihood hypocenter.
Because the search space is fully evaluated there is no need for an initial
location estimate and the location uncertainty is completely known. However the
method is very slow. It can be used to relocate events in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> that seem
difficult to locate via other methods or to verify the uncertainty of a solution.
The following example configuration computes a grid search around the average
location of the picked stations. The grid points are spaced apart 0.5km
horizontally and 2km vertically.</p>
<blockquote>
<div><div class="highlight-params notranslate"><div class="highlight"><pre><span></span>method = GridSearch
GridSearch.center = auto,auto,15
GridSearch.size = 40,40,30
GridSearch.numPoints = 81,81,16
</pre></div>
</div>
</div></blockquote>
</li>
<li><p>GridSearch+LeastSquares: this method can be used in very complex networks where
a bad initial location estimates can get LeastSquares stuck in a local minimum.
The method finds a LeastSquares solution for each cell in a (coarse) grid, using
the cell centroid as initial location estimate. If finally returns the maximum
likelihood solution. This method is intended to be used in <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> or
<a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> to relocate existing events.
The following example configuration returns the best among the 75 (5x5x3)
LeastSquares solutions, computed for every point in the grid.</p>
<blockquote>
<div><div class="highlight-params notranslate"><div class="highlight"><pre><span></span>method = GridSearch+LeastSquares
GridSearch.center = auto,auto,15
GridSearch.size = 100,100,30
GridSearch.numPoints = 5,5,3
</pre></div>
</div>
</div></blockquote>
</li>
<li><p>OctTree: this method produces similar results to GridSearch but it is extremely
faster and it follows the NonLinLoc approach. The OctTree search starts by
evaluating the hypocenter probability of each cell in a grid, computed as the
probability density at the cell center coordinates times the cell volume. The
search then continues by repeatedly fetching the cell with highest probability
and splitting it in 8 sub-cells. These 8 cells are then inserted in the pool of
cells to fetch from at next iteration.
The search terminates after either a maximum number of iterations or after
reaching a minimum cell size. At that point the maximum likelihood hypocenter
is selected. Because the algorithms splits only the cells with higher
probability, the search space is sampled in a very efficient way and it makes
the method way faster than GridSearch.
This method is intended to be used in <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> to
relocate existing events.
The following example is a plausible configuration for the entire Swiss
network:</p>
<blockquote>
<div><div class="highlight-params notranslate"><div class="highlight"><pre><span></span>method = OctTree
GridSearch.center = 47.0,8.5,50
GridSearch.size = 700,700,100
GridSearch.numPoints = 21,21,11
OctTree.maxIterations = 100000
OctTree.minCellSize = 0.001
</pre></div>
</div>
</div></blockquote>
<p>However in this example we are at the size limit for a flat earth study
geometry and for bigger regions <cite>GridSearch.center</cite> should be set to
<cite>auto</cite> and <cite>GridSearch.size</cite> to a smaller size.</p>
</li>
<li><p>OctTree+LeastSquares: this method allows the OctTree search to find the
maximum probability cell in the network and uses that as the initial
location estimate for LeastSquares.
This method is intended to be used in <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a> or <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> to
relocate existing events.
The following example is a plausible configuration for the entire Swiss
network:</p>
<blockquote>
<div><div class="highlight-params notranslate"><div class="highlight"><pre><span></span>method = OctTree+LeastSquares
GridSearch.center = 47.0,8.5,50
GridSearch.size = 700,700,100
GridSearch.numPoints = 21,21,11
OctTree.maxIterations = 10000
OctTree.minCellSize = 1.0
</pre></div>
</div>
</div></blockquote>
<p>However in this example we are at the size limit for a flat earth study
geometry and for bigger regions <cite>GridSearch.center</cite> should be set to
<cite>auto</cite> and <cite>GridSearch.size</cite> to a smaller size.</p>
</li>
</ul>
<p>The algorithms implemented in StdLoc are standard methods described in “Routine Data
Processing in Earthquake Seismology” by Jens Havskov and Lars Ottemoller. The OctTree
search algorithm is based on NonLibLoc by Antony Lomax.</p>
</section>
<section id="why-is-stdloc-suitable-for-local-seismicity">
<h2>Why is stdloc suitable for local seismicity?<a class="headerlink" href="#why-is-stdloc-suitable-for-local-seismicity" title="Permalink to this heading"></a></h2>
<p>When dealing with very local seismicity (few kilometers or hundreds of meters)
simplifications that are common for regional seismicity have to be removed.
In particular the locator should take into consideration:</p>
<ul class="simple">
<li><p>station elevation and even negative elevation (e.g. borehole sensors)</p></li>
<li><p>earthquake location can be above a seismic sensor (e.g. borehole sensors)</p></li>
<li><p>possible negative earthquake depth (above surface)</p></li>
</ul>
<p>More importantly the travel time tables used by the locator must be able to take
into consideration all the above too.</p>
</section>
<section id="travel-time-table">
<h2>Travel Time Table<a class="headerlink" href="#travel-time-table" title="Permalink to this heading"></a></h2>
<p>StdLoc can be configured with any Travel Time Table type available in SeisComP,
however only the <cite>homogeneous</cite> type is able to take into consideration station
elevation, negative source depth and sources happening above stations. For this
reason <cite>homogeneous</cite> should be the preferred choice when working on very local
seismicity and especially with borehole sensors.</p>
</section>
<section id="module-configuration">
<span id="global-stdloc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>StdLoc.*</strong>
<em>Locator parameters: StdLoc. This locator requires the plugin</em>
<em>“stdloc” to be loaded.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profiles">
<span class="sig-name descname"><span class="pre">StdLoc.profiles</span></span><a class="headerlink" href="#confval-StdLoc.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defines a list of profiles to make available to the plugin.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>StdLoc.profile.$name.*</strong>
$name is a placeholder for the name to be used and needs to be added to <a class="reference internal" href="#confval-StdLoc.profiles"><code class="xref std std-confval docutils literal notranslate"><span class="pre">StdLoc.profiles</span></code></a> to become active.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>StdLoc.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>a,b
StdLoc.profile.a.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
StdLoc.profile.b.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
<span class="c1"># c is not active because it has not been added</span>
<span class="c1"># to the list of StdLoc.profiles</span>
StdLoc.profile.c.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.method">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.method</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.method" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">LeastSquares</span></code></p>
<p>Type: <em>string</em></p>
<p>The location method to use: LeastSquares, GridSearch,
OctTree, GridSearch+LeastSquares or OctTree+LeastSquares.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.tableType">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.tableType</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.tableType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">LOCSAT</span></code></p>
<p>Type: <em>string</em></p>
<p>Travel time table format type. Also consider
&quot;tableModel&quot;!</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.tableModel">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.tableModel</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.tableModel" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">iasp91</span></code></p>
<p>Type: <em>string</em></p>
<p>The model to be used. The format depends on
&quot;tableType&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.PSTableOnly">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.PSTableOnly</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.PSTableOnly" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled the arrival travel time information are fetched
using P and S tables only and the user selected
specific phase type is not considered (e.g. Pg, Sg,
PmP, SmS, P1, S1, etc).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.usePickUncertainties">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.usePickUncertainties</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.usePickUncertainties" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use pick time uncertainties rather than a fixed
time error of XXX s. If true, an arrival weight is
associated according to the uncertainty of the pick
and &quot;pickUncertaintyClasses&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.pickUncertaintyClasses">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.pickUncertaintyClasses</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.pickUncertaintyClasses" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.000,0.025,0.050,0.100,0.200,0.400</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Unit: <em>s</em></p>
<p>Comma-separated list of time limits of uncertainty
classes from which, along with pick time uncertainties,
arrival weights are computed. The first value
defines the lower limit of class 0.</p>
<p>The interval into which a pick time uncertainty falls
defines the index of the uncertainty class starting
with 0.</p>
<p>The corresponding arrival weight is computed as:
weight = 1 / 2^(index).</p>
<p>Example: A pick with a time uncertainty of 0.15 s is
within the 4th interval ranging from 0.1 to 0.2 s.
The class index is then 3.</p>
<p>If pick uncertainty is absent, the highest class index
applies.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.confLevel">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.confLevel</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.confLevel" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.9</span></code></p>
<p>Type: <em>double</em></p>
<p>Confidence level, between 0.5 and 1.0, used in
computing the hypocenter confidence ellipsoid.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.enableConfidenceEllipsoid">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.enableConfidenceEllipsoid</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.enableConfidenceEllipsoid" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Compute the hypocenter confidence ellipsoid. Disable
this optional parameter to save some computation time.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>StdLoc.profile.$name.GridSearch.*</strong>
<em>Parameters controlling the GridSearch and OctTree methods.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.GridSearch.center">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.GridSearch.center</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.GridSearch.center" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">auto,auto,20</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Unit: <em>deg,deg,km</em></p>
<p>Grid center defined as: latitude,longitude,depth. The
special value &quot;auto&quot; can be used and the corresponding latitude, longitude
and/or depth will be automatically computed as the average of the arrival
station locations.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.GridSearch.size">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.GridSearch.size</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.GridSearch.size" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">40,40,30</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Unit: <em>km</em></p>
<p>Grid size in km defined as: X,Y,Z
direction extents around the &quot;GridSearch.center&quot;,
where X is the longitudinal extent, Y the
latitudinal extent and Z the vertical extent.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.GridSearch.numPoints">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.GridSearch.numPoints</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.GridSearch.numPoints" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Number of grid points in X, Y, Z
direction. The first and last points are on the
grid boundary unless the number of points is 1
and the point will be in the grid center.</p>
<p>Format: numX,numY,numZ.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.GridSearch.misfitType">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.GridSearch.misfitType</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.GridSearch.misfitType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">L1</span></code></p>
<p>Type: <em>string</em></p>
<p>The type of misfit to use, from which
the likelihood function is derived: L1 or L2 norm.
L1 is less sensitive to outliers and so more
suitable with automatic picks, L2 is the preferred
choice for manual picks.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.GridSearch.travelTimeError">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.GridSearch.travelTimeError</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.GridSearch.travelTimeError" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.25</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Typical error in seconds for travel times to
stations. The value affects the uncertainty
of the location. In OctTree it also influences
the probability density computation: too
conservative values increase the number of
iterations required by OctTree to converge
to a high resolution solution.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>StdLoc.profile.$name.OctTree.*</strong>
<em>Parameters controlling the OctTree method. OctTree</em>
<em>uses the parameters defined in GridSearch, but</em>
<em>applies the OctTree search algorithm on the grid.</em>
<em>The starting cells of the OctTree search are created by</em>
<em>dividing the initial grid in equally sized cells.</em>
<em>The grid points becomes the cell vertices.</em>
<em>Resulting number of cells in each direction:</em>
<em>“GridSearch.numPoints” - 1.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.OctTree.maxIterations">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.OctTree.maxIterations</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.OctTree.maxIterations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">50000</span></code></p>
<p>Type: <em>int</em></p>
<p>Maximum number of iterations after which the
search stops. Zero or negatives values disable
the stopping.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.OctTree.minCellSize">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.OctTree.minCellSize</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.OctTree.minCellSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.1</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>Minimum cell size to be generate by the OctTree
search to stop. A zero or negative value disable
this stopping mechanism.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>StdLoc.profile.$name.LeastSquares.*</strong>
<em>Parameters controlling the LeastSquares method.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.LeastSquares.depthInit">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.LeastSquares.depthInit</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.LeastSquares.depthInit" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>double</em></p>
<p>The initial depth estimate when no initial
hypocenter is provided. Used only with
LeastSquares.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.LeastSquares.iterations">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.LeastSquares.iterations</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.LeastSquares.iterations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of iterations. Each iteration will
use the location and time from the previous
Least Squares solution.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.LeastSquares.dampingFactor">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.LeastSquares.dampingFactor</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.LeastSquares.dampingFactor" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p>
<p>Type: <em>double</em></p>
<p>Damping factor to be used when solving the
system of equations.</p>
<p>0: no damping.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-StdLoc.profile.-name.LeastSquares.solverType">
<span class="sig-name descname"><span class="pre">StdLoc.profile.$name.LeastSquares.solverType</span></span><a class="headerlink" href="#confval-StdLoc.profile.-name.LeastSquares.solverType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">LSMR</span></code></p>
<p>Type: <em>string</em></p>
<p>Algorithm to use: either LSMR or LSQR.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">StdLoc</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#how-does-it-work">How does it work?</a></li>
<li><a class="reference internal" href="#why-is-stdloc-suitable-for-local-seismicity">Why is stdloc suitable for local seismicity?</a></li>
<li><a class="reference internal" href="#travel-time-table">Travel Time Table</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="global_gui.html"
title="previous chapter">GUI</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="global_locext.html"
title="next chapter">LocExt</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/global_stdloc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,383 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>import_inv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="inv2dlsv" href="inv2dlsv.html" />
<link rel="prev" title="fdsnxml2inv" href="fdsnxml2inv.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">6.9.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="inv2dlsv.html" title="inv2dlsv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="fdsnxml2inv.html" title="fdsnxml2inv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="import-inv">
<span id="id1"></span><h1>import_inv<a class="headerlink" href="#import-inv" title="Permalink to this heading"></a></h1>
<p><strong>Import inventory information from various sources.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>import_inv is a wrapper for inventory converters. Inventory converters convert
an input format such as</p>
<table class="docutils align-left">
<colgroup>
<col style="width: 15.0%" />
<col style="width: 15.0%" />
<col style="width: 70.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Format</p></th>
<th class="head"><p>Converter</p></th>
<th class="head"><p>Conversion</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>scml</p></td>
<td><p><span class="xref std std-ref">scml2inv</span></p></td>
<td><p><a class="reference internal" href="../base/concepts/inventory.html#concepts-inventory"><span class="std std-ref">SeisComP inventory XML</span></a>, schema: <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/share/xml/</span></code></p></td>
</tr>
<tr class="row-odd"><td><p>sc3</p></td>
<td><p><span class="xref std std-ref">sc32inv</span></p></td>
<td><p>Alias for scml for backwards compatibility to SeisComP3</p></td>
</tr>
<tr class="row-even"><td><p>arclink</p></td>
<td><p><span class="xref std std-ref">arclink2inv</span></p></td>
<td><p>Arclink inventory XML</p></td>
</tr>
<tr class="row-odd"><td><p>dlsv</p></td>
<td><p><a class="reference internal" href="dlsv2inv.html#dlsv2inv"><span class="std std-ref">dlsv2inv</span></a></p></td>
<td><p><a class="reference external" href="http://www.iris.edu/data/dataless.htm">dataless SEED</a></p></td>
</tr>
<tr class="row-even"><td><p>fdsnxml</p></td>
<td><p><a class="reference internal" href="fdsnxml2inv.html#fdsnxml2inv"><span class="std std-ref">fdsnxml2inv</span></a></p></td>
<td><p><a class="reference external" href="http://www.fdsn.org/xml/station/">FDSN StationXML</a></p></td>
</tr>
</tbody>
</table>
<p>to SeisComP inventory XML which is read by the trunk config module to
synchronize the local inventory file pool with the central inventory database.</p>
<p>For printing all available formats call</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>import_inv<span class="w"> </span><span class="nb">help</span><span class="w"> </span>formats
</pre></div>
</div>
<p>When <strong class="program">import_inv help formats</strong> is called it globs for
<code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/bin/*2inv</span></code>.
If another format needs to be converted, it is very easy to provide a new
converter.</p>
<section id="converter-interface">
<h3>Converter interface<a class="headerlink" href="#converter-interface" title="Permalink to this heading"></a></h3>
<p>For making a new converter work with import_inv it must implement an interface
on shell level. Furthermore the converter program must be named
<code class="file docutils literal notranslate"><em><span class="pre">format</span></em><span class="pre">2inv</span></code> and must live in <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/bin</span></code>.</p>
<p>The converter program must take the input location (file, directory, URL, …)
as first parameter and the output file (SeisComP XML) as second parameter. The
output file must be optional and default to stdout.</p>
<p>To add a new converter for a new format, e.g. Excel, place the new converter
program at <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/bin/excel2inv</span></code>.</p>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<ul>
<li><p>Convert inventory file in FDSN StationXML format (fdsnxml) and copy the content to
<code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/inventoy/inventory.xml</span></code>. The call will invoke
<a class="reference internal" href="fdsnxml2inv.html#fdsnxml2inv"><span class="std std-ref">fdsnxml2inv</span></a> for actually making the conversion:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>import_inv<span class="w"> </span>fdsnxml<span class="w"> </span>inventory_fdsn.xml<span class="w"> </span><span class="nv">$SEISCOMP_ROOT</span>/etc/inventoy/inventory.xml
</pre></div>
</div>
</li>
</ul>
</section>
</section>
<section id="module-configuration">
<span id="import-inv-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/import_inv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/import_inv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/import_inv.cfg</span></code></div>
</div>
<p>import_inv inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">import_inv [FORMAT] input [output]</strong></p>
<p><strong class="program">import_inv help [topic]</strong></p>
<p>The first form takes the format as first parameter and the input
and output location. The input location is either a file or directory
depending on the format and its converter. If the output is not
given it defaults to seiscomp/etc/inventory/{input}.xml. To write
the output to stdout, &quot;-&quot; must be used.</p>
<p>The second form provides help on a particular topic. The only topic
currently supported is &quot;formats&quot; which prints all available input
formats.</p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-h">
<span id="cmdoption-import_inv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-V">
<span id="cmdoption-import_inv-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-D">
<span id="cmdoption-import_inv-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-v">
<span id="cmdoption-import_inv-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-q">
<span id="cmdoption-import_inv-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-s">
<span id="cmdoption-import_inv-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-l">
<span id="cmdoption-import_inv-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-import_inv-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-import_inv-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-import_inv-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">import_inv</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#converter-interface">Converter interface</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="fdsnxml2inv.html"
title="previous chapter">fdsnxml2inv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="inv2dlsv.html"
title="next chapter">inv2dlsv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/import_inv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,192 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>inv2dlsv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="invextr" href="invextr.html" />
<link rel="prev" title="import_inv" href="import_inv.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">6.9.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="invextr.html" title="invextr"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="import_inv.html" title="import_inv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="inv2dlsv">
<span id="id1"></span><h1>inv2dlsv<a class="headerlink" href="#inv2dlsv" title="Permalink to this heading"></a></h1>
<p><strong>Converts SC3 inventory XML to dataless SEED.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>inv2dlsv is a simple filter that converts inventory in <cite>SeisComP</cite> XML (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>)
format from stdin (or a file) to dataless SEED on stdout (or a file). It does
not support processing of input XML such as extraction of networks or channels.
To accomplish this task, combine <strong class="program">inv2dlsv</strong> with <a class="reference internal" href="invextr.html#invextr"><span class="std std-ref">invextr</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Conversion of dataless SEED to <cite>SeisComP</cite> XML is provided by <a class="reference internal" href="dlsv2inv.html#dlsv2inv"><span class="std std-ref">dlsv2inv</span></a>.</p>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>“-” can always be used as filename to refer to the standard input/output channel.</p>
</div>
<ol class="arabic">
<li><p>Convert an inventory XML file to a dataless SEED file</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>inv2dlsv<span class="w"> </span>inv.xml<span class="w"> </span>inv.seed
</pre></div>
</div>
</li>
<li><p>Convert an inventory XML file to a compressed dataless SEED file</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>inv2dlsv<span class="w"> </span>inv.xml<span class="w"> </span><span class="p">|</span><span class="w"> </span>gzip<span class="w"> </span>&gt;<span class="w"> </span>inv.seed.gz
</pre></div>
</div>
</li>
<li><p>Convert a subset of an inventory XML using <a class="reference internal" href="invextr.html#invextr"><span class="std std-ref">invextr</span></a>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;*MORC*&quot;</span><span class="w"> </span>inv.xml<span class="w"> </span><span class="p">|</span><span class="w"> </span>inv2dlsv<span class="w"> </span>-<span class="w"> </span>inv.seed
</pre></div>
</div>
</li>
</ol>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">inv2dlsv [in_xml [out_dataless]]</strong></p>
<p>If in_xml is not given, stdin is used. If out_dataless is not given,
stdout is used.</p>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">inv2dlsv</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="import_inv.html"
title="previous chapter">import_inv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="invextr.html"
title="next chapter">invextr</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/inv2dlsv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,436 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>invextr &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scinv" href="scinv.html" />
<link rel="prev" title="inv2dlsv" href="inv2dlsv.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">6.9.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="scinv.html" title="scinv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="inv2dlsv.html" title="inv2dlsv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="invextr">
<span id="id1"></span><h1>invextr<a class="headerlink" href="#invextr" title="Permalink to this heading"></a></h1>
<p><strong>Extract channels from inventory.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>invextr reads and modifies inventory XML provided as file or on stdin:</p>
<ul class="simple">
<li><p>Extract or remove networks, stations and channels based on</p>
<ul>
<li><p>channel IDs</p></li>
<li><p>geographic region</p></li>
<li><p>time</p></li>
</ul>
</li>
<li><p>Clean inventories from unused objects such as data loggers, sensors or
instrument responses.</p></li>
</ul>
<p>The important parameters are:</p>
<ul class="simple">
<li><p>Channel ID list (required)</p></li>
<li><p>Input file or stdin</p></li>
<li><p>Output file or stdout</p></li>
<li><p>Region bounding box (optional)</p></li>
</ul>
<p>whereas the output file defaults to stdout and the input file to
stdin if not given.</p>
<p>The optional region box will be used to filter the read inventory based on the
coordinates of sensor locations. Only stations with sensor locations within the
region will be considered. All others will be ignored.</p>
<p>A channel ID is a simple string that is matched against the final channel ID
in the inventory. This final channel ID is constructed by joining the codes of
all stages with a dot where the stages are network, station, location and
channel.</p>
<p>The content of the resulting inventory may be listed using <a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>.</p>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<p>Suppose an inventory with network GE, a station MORC and several channels:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>network<span class="w"> </span>GE
<span class="w"> </span>station<span class="w"> </span>MORC
<span class="w"> </span>location<span class="w"> </span>__
<span class="w"> </span>channel<span class="w"> </span>BHZ<span class="w"> </span>ID:<span class="w"> </span>GE.MORC..BHZ
<span class="w"> </span>channel<span class="w"> </span>BHN<span class="w"> </span>ID:<span class="w"> </span>GE.MORC..BHN
<span class="w"> </span>channel<span class="w"> </span>BHE<span class="w"> </span>ID:<span class="w"> </span>GE.MORC..BHE
<span class="w"> </span>channel<span class="w"> </span>LHZ<span class="w"> </span>ID:<span class="w"> </span>GE.MORC..LHZ
<span class="w"> </span>channel<span class="w"> </span>LHN<span class="w"> </span>ID:<span class="w"> </span>GE.MORC..LHN
<span class="w"> </span>channel<span class="w"> </span>LHE<span class="w"> </span>ID:<span class="w"> </span>GE.MORC..LHE
</pre></div>
</div>
<ul>
<li><p>The IDs are matched against streams passed with chans.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;GE*&quot;</span><span class="w"> </span>inv.xml
</pre></div>
</div>
<p>All streams are passed and nothing is filtered because GE* matches all
available IDs and region filter is not used. Since <code class="file docutils literal notranslate"><span class="pre">inv.xml</span></code> only
contains stations from the GE network the option <code class="xref std std-option docutils literal notranslate"><span class="pre">--chans</span></code> is not
useful here at all.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>invextr<span class="w"> </span>-r<span class="w"> </span><span class="m">0</span>,-180,90,180<span class="w"> </span>inv.xml
All<span class="w"> </span>streams<span class="w"> </span>located<span class="w"> </span><span class="k">in</span><span class="w"> </span>the<span class="w"> </span>northern<span class="w"> </span>hemisphere<span class="w"> </span>are<span class="w"> </span>passed<span class="w"> </span>as<span class="w"> </span>commanded<span class="w"> </span>by<span class="w"> </span>the
region<span class="w"> </span>bounding<span class="w"> </span>box.
</pre></div>
</div>
</li>
<li><p>Nothing is filtered again because <em>MORC</em> matches all available IDs.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;*MORC*&quot;</span><span class="w"> </span>inv.xml
</pre></div>
</div>
</li>
<li><p>Everything is filtered because GE.MORC does not match with any ID. To make it
work, an asterisk needs to be appended: GE.MORC* or GE.MORC.*.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;GE.MORC&quot;</span><span class="w"> </span>inv.xml
</pre></div>
</div>
</li>
<li><p>To extract all vertical components, use:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;*Z&quot;</span><span class="w"> </span>inv.xml
</pre></div>
</div>
</li>
<li><p>To extract BHN and LHZ, use:</p></li>
</ul>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;*BHN,*LHZ&quot;</span><span class="w"> </span>inv.xml
</pre></div>
</div>
<ul>
<li><p>To remove all HH and SH channels, use:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>--rm<span class="w"> </span>--chans<span class="w"> </span><span class="s2">&quot;*HH?,*SH?&quot;</span><span class="w"> </span>inv.xml
</pre></div>
</div>
</li>
</ul>
</section>
</section>
<section id="module-configuration">
<span id="invextr-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/invextr.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/invextr.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/invextr.cfg</span></code></div>
</div>
<p>invextr inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">invextr [OPTIONS] [input=stdin] [output=stdout]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-h">
<span id="cmdoption-invextr-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-V">
<span id="cmdoption-invextr-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-D">
<span id="cmdoption-invextr-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-v">
<span id="cmdoption-invextr-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-q">
<span id="cmdoption-invextr-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-s">
<span id="cmdoption-invextr-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-l">
<span id="cmdoption-invextr-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="extract">
<h3>Extract<a class="headerlink" href="#extract" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-begin">
<span class="sig-name descname"><span class="pre">--begin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-begin" title="Permalink to this definition"></a></dt>
<dd><p>Begin time to consider streams. Streams ending at or
before that time will be ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-end">
<span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-end" title="Permalink to this definition"></a></dt>
<dd><p>End time to consider streams. Streams starting after
that time will be ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-chans">
<span class="sig-name descname"><span class="pre">--chans</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-chans" title="Permalink to this definition"></a></dt>
<dd><p>A comma separated list of channel IDs to extract
which can contain wildcards. Default: *.*.*.* meaning
all streams.</p>
<p>Example: invextr --chans &quot;GE.*.*.BHZ,GE.MORC.*.*&quot; inv.xml</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-nslc">
<span class="sig-name descname"><span class="pre">--nslc</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-nslc" title="Permalink to this definition"></a></dt>
<dd><p>Stream list file to be used for extracting inventory.
Wildcards can be used. --chans is ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-r">
<span id="cmdoption-invextr-region"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-r" title="Permalink to this definition"></a></dt>
<dd><p>Filter streams by geographic region given as
&quot;South, East, North, West&quot;. Region is unused by default.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-rm">
<span class="sig-name descname"><span class="pre">--rm</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-invextr-rm" title="Permalink to this definition"></a></dt>
<dd><p>Removes all channels given with --chans instead of
extracting them.</p>
<p>Example: invextr --rm --chans &quot;GE.*&quot; inv.xml</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-f">
<span id="cmdoption-invextr-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-invextr-f" title="Permalink to this definition"></a></dt>
<dd><p>Enables formatted XML output.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">invextr</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#extract">Extract</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="inv2dlsv.html"
title="previous chapter">inv2dlsv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scinv.html"
title="next chapter">scinv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/invextr.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,209 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>kernel &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Utilities" href="../toc/utilities.html" />
<link rel="prev" title="diskmon" href="diskmon.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">6.9.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="../toc/utilities.html" title="Utilities"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="diskmon.html" title="diskmon"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/system.html" accesskey="U">System</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="kernel">
<span id="id1"></span><h1>kernel<a class="headerlink" href="#kernel" title="Permalink to this heading"></a></h1>
<p><strong>SeisComP kernel.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The kernel is the basic configuration for the <strong class="command">seiscomp</strong> tool.
It contains configuration parameters for all init scripts in <code class="file docutils literal notranslate"><span class="pre">etc/init</span></code>. Each init script can, but does not
need to, read the kernel parameters and configure itself accordingly. Kernel parameters are not mandatory but
should be taken as (serious) hints. If for example syslog is enabled in the kernel then all init scripts should
configure syslog as logging backend for the programs they start. But if a program does not support syslog it can
also be started without logging to syslog.</p>
</section>
<section id="module-configuration">
<span id="kernel-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>kernel is a <a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> and does not inherit <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</div>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/kernel.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/kernel.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/kernel.cfg</span></code></div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-syslog">
<span class="sig-name descname"><span class="pre">syslog</span></span><a class="headerlink" href="#confval-syslog" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Sends all logging output to the syslog backend which logs
usually to /var/log/messages.</p>
</dd></dl>
<section id="messaging-extension">
<span id="kernel-messaging"></span><h3>messaging extension<a class="headerlink" href="#messaging-extension" title="Permalink to this heading"></a></h3>
<p>SeisComP messaging component that enables communication of modules over the network.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-messaging.enable">
<span class="sig-name descname"><span class="pre">messaging.enable</span></span><a class="headerlink" href="#confval-messaging.enable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enables/disables local messaging (scmaster).
The messaging component is an integral component
of all modules (except e.g. acquisition modules).
If you are not sure what to do, enable it.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-messaging.bind">
<span class="sig-name descname"><span class="pre">messaging.bind</span></span><a class="headerlink" href="#confval-messaging.bind" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Defines the messaging unencrypted bind address. If
left empty then the configuration file (see scmaster)
will be used instead. Use this to override the
unencrypted bind address. The format is
&quot;[ip:]port&quot;.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">kernel</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a><ul>
<li><a class="reference internal" href="#messaging-extension">messaging extension</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="diskmon.html"
title="previous chapter">diskmon</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../toc/utilities.html"
title="next chapter">Utilities</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/kernel.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,349 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>msrtsimul &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scardac" href="scardac.html" />
<link rel="prev" title="access" href="access.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">6.9.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="scardac.html" title="scardac"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="access.html" title="access"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="msrtsimul">
<span id="id1"></span><h1>msrtsimul<a class="headerlink" href="#msrtsimul" title="Permalink to this heading"></a></h1>
<p><strong>MiniSEED real time playback and simulation</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>msrtsimul simulates a real-time data acquisition by injecting miniSEED data from a
file into the seedlink buffer via the mseedfifo plugin for seedlink. It can be
used for simulating real-time conditions in playbacks for whole-system
demonstrations, user training, etc.</p>
<p>The data is played back as if they were recorded at current time. Therefore,
creation times and the actual data times including pick times, event times etc.
will be <strong>obscured</strong>. <a class="reference internal" href="#sec-msrtsimul-historic"><span class="std std-ref">Historic playbacks</span></a> allow
keeping the actual data times.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<ul class="simple">
<li><p>Playbacks on production systems are normally not recommended.</p></li>
<li><p>For real-time playbacks, the data must be sorted by end time. This
requirement may be violated. Use <a class="reference internal" href="scmssort.html#scmssort"><span class="std std-ref">scmssort</span></a> for sorting the data by
(end) time.</p></li>
<li><p>Stop <a class="reference internal" href="slarchive.html#slarchive"><span class="std std-ref">slarchive</span></a> before running msrtsimul for avoiding that data with
wrong times are archived.</p></li>
<li><p>Normally, <a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> assumes that the data is provided in records of
512 bytes. msrtsimul issues a warning when detecting a record of other size.</p></li>
<li><p>Data available in other record sizes can be repacked to 512 bytes by
external software such as <strong class="program">msrepack</strong> available with
<span id="id2"><em>libmseed - The miniSEED data format library</em> [<a class="reference internal" href="../base/references.html#id147" title="libmseed - The miniSEED data format library. GitHub, 2017. URL: https://github.com/EarthScope/libmseed/wiki.">32</a>]</span>.</p></li>
<li><p>Applications other than standard <a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> in <cite>SeisComP</cite> or
<a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> compiled specifically may accept other record sizes. For
accepting these records use msrtsimul with <code class="xref std std-option docutils literal notranslate"><span class="pre">--unlimited</span></code>.</p></li>
</ul>
</div>
<section id="non-default-seedlink-pipes">
<h3>Non-default seedlink pipes<a class="headerlink" href="#non-default-seedlink-pipes" title="Permalink to this heading"></a></h3>
<p>By default, msrtsimul writes the data into the mseedfifo pipe
<em>$SEISCOMP_ROOT/var/run/seedlink/mseedfifo</em>.
If the data is to be written into the pipe of a <strong class="program">seedlink</strong> alias or
into any other pipe, the pipe name must be adjusted. Use the option</p>
<ul class="simple">
<li><p><code class="xref std std-option docutils literal notranslate"><span class="pre">--seedlink</span></code> to replace <em>seedlink</em> by another name, e.g. a seedlink instance
created as an alias, <strong>seedlink-test</strong>. This would write into
<em>$SEISCOMP_ROOT/var/run/seedlink-test/mseedfifo</em>.</p></li>
<li><p><code class="xref std std-option docutils literal notranslate"><span class="pre">--stdout</span></code> to write to standard output and then redirect to any other location.</p></li>
</ul>
</section>
<section id="historic-playbacks">
<span id="sec-msrtsimul-historic"></span><h3>Historic playbacks<a class="headerlink" href="#historic-playbacks" title="Permalink to this heading"></a></h3>
<p>You may use msrtsimul with the <code class="xref std std-option docutils literal notranslate"><span class="pre">-m</span></code> <em>historic</em> option to maintain the
time of the records,
thus the times of picks, amplitudes, origins, etc. but not the creation times.
Applying <code class="xref std std-option docutils literal notranslate"><span class="pre">-m</span></code> <em>historic</em> will feed the data into the seedlink buffer at the time
of the records. The time of the system is untouched. GUI, processing modules, logging,
etc. will run with current system time. The historic mode allows to process waveforms
with the stream inventory valid at the time when the data were recorded including
streams closed at current time.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>When repeating historic playbacks, the waveforms are fed multiple times to the
seedlink buffer and the resulting picks are also repeated with the same pick
times. This may confuse the real-time system. Therefore, seedlink and other modules
creating or processing picks should be
stopped, the seedlink buffer should be cleared and the processing
modules should be restarted to clear the buffers before starting the
historic playbacks. Make sure <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> is configured or started with
the <code class="xref std std-option docutils literal notranslate"><span class="pre">--playback</span></code> option. Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>stop
rm<span class="w"> </span>-rf<span class="w"> </span><span class="nv">$SEISCOMP_ROOT</span>/var/lib/seedlink/buffer
seiscomp<span class="w"> </span>start
msrtsimul<span class="w"> </span>...
</pre></div>
</div>
</div>
</section>
<section id="seedlink-setup">
<h3>seedlink setup<a class="headerlink" href="#seedlink-setup" title="Permalink to this heading"></a></h3>
<p>For supporting msrtsimul activate the <a class="reference internal" href="seedlink.html#confval-msrtsimul"><code class="xref std std-confval docutils literal notranslate"><span class="pre">msrtsimul</span></code></a> parameter in the
seedlink module configuration (<code class="file docutils literal notranslate"><span class="pre">seedlink.cfg</span></code>), update the configuration
and restart seedlink before running msrtsimul:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config<span class="w"> </span>seedlink
seiscomp<span class="w"> </span>restart<span class="w"> </span>seedlink
msrtsimul<span class="w"> </span>...
</pre></div>
</div>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Playback miniSEED waveforms in real time with verbose output:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>msrtsimul<span class="w"> </span>-v<span class="w"> </span>miniSEED-file
</pre></div>
</div>
</li>
<li><p>Playback miniSEED waveforms in historic mode. This may require <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>
to be started with the option <em>playback</em>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>msrtsimul<span class="w"> </span>-v<span class="w"> </span>-m<span class="w"> </span>historic<span class="w"> </span>miniSEED-file
</pre></div>
</div>
</li>
<li><p>Feed the data into the buffer of a specific seedlink instance, e.g. <em>seedlink-test</em>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>msrtsimul<span class="w"> </span>-v<span class="w"> </span>--seedlink<span class="w"> </span>seedlink-test<span class="w"> </span>miniSEED-file
</pre></div>
</div>
</li>
</ol>
</section>
</section>
<section id="module-configuration">
<span id="msrtsimul-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/msrtsimul.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/msrtsimul.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/msrtsimul.cfg</span></code></div>
</div>
<p>msrtsimul inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">msrtsimul [OPTION] miniSEED-file</strong></p>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-h">
<span id="cmdoption-msrtsimul-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-msrtsimul-h" title="Permalink to this definition"></a></dt>
<dd><p>Display this help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-v">
<span id="cmdoption-msrtsimul-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-msrtsimul-v" title="Permalink to this definition"></a></dt>
<dd><p>Verbose mode.</p>
</dd></dl>
</section>
<section id="playback">
<h3>Playback<a class="headerlink" href="#playback" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-c">
<span id="cmdoption-msrtsimul-stdout"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--stdout</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-msrtsimul-c" title="Permalink to this definition"></a></dt>
<dd><p>Write on standard output. The output my be redirected to a
specific mseedfifo path.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-d">
<span id="cmdoption-msrtsimul-delays"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--delays</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-msrtsimul-d" title="Permalink to this definition"></a></dt>
<dd><p>Add artificial delays.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-j">
<span id="cmdoption-msrtsimul-jump"></span><span class="sig-name descname"><span class="pre">-j</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--jump</span></span><span class="sig-prename descclassname"> <span class="pre">float</span></span><a class="headerlink" href="#cmdoption-msrtsimul-j" title="Permalink to this definition"></a></dt>
<dd><p>Minutes to skip at the beginning.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-m">
<span id="cmdoption-msrtsimul-mode"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--mode</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-msrtsimul-m" title="Permalink to this definition"></a></dt>
<dd><p>Playback mode: choose between realtime and historic</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-seedlink">
<span class="sig-name descname"><span class="pre">--seedlink</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-msrtsimul-seedlink" title="Permalink to this definition"></a></dt>
<dd><p>The seedlink module name. Useful if a seedlink alias or
non-standard names are used. Replaces seedlink
in the standard mseedfifo path.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-s">
<span id="cmdoption-msrtsimul-speed"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--speed</span></span><span class="sig-prename descclassname"> <span class="pre">float</span></span><a class="headerlink" href="#cmdoption-msrtsimul-s" title="Permalink to this definition"></a></dt>
<dd><p>Speed factor. 1 is normal speed.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-msrtsimul-test" title="Permalink to this definition"></a></dt>
<dd><p>Test mode.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-msrtsimul-u">
<span id="cmdoption-msrtsimul-unlimited"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--unlimited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-msrtsimul-u" title="Permalink to this definition"></a></dt>
<dd><p>Allow miniSEED records which are not 512 bytes.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">msrtsimul</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#non-default-seedlink-pipes">Non-default seedlink pipes</a></li>
<li><a class="reference internal" href="#historic-playbacks">Historic playbacks</a></li>
<li><a class="reference internal" href="#seedlink-setup">seedlink setup</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#playback">Playback</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="access.html"
title="previous chapter">access</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scardac.html"
title="next chapter">scardac</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/msrtsimul.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,883 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ql2sc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scalert" href="scalert.html" />
<link rel="prev" title="fdsnws" href="fdsnws.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">6.9.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="scalert.html" title="scalert"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="fdsnws.html" title="fdsnws"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ql2sc">
<span id="id1"></span><h1>ql2sc<a class="headerlink" href="#ql2sc" title="Permalink to this heading"></a></h1>
<p><strong>QuakeLink (gempa GmbH) to SeisComP event parameter exchange.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>ql2sc manages the import of SeisComP objects from one or several QuakeLink servers
into a SeisComP system in real time. Like <a class="reference internal" href="scimex.html#scimex"><span class="std std-ref">scimex</span></a> but contrary to
<a class="reference internal" href="scimport.html#scimport"><span class="std std-ref">scimport</span></a> the exchange of the SeisComP objects is event based. This means no
messages will be exchanged until the exporting system has produced an event.</p>
<p>The user may control at various levels which information to import. Whenever
possible server-side filters should be preferred to reduce both the network
bandwidth consumption as well as the CPU and memory utilization on the local
machine.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>ql2sc does not delete events at the import system although quakelink
allows the deletion of events. Deleted events are ignored by ql2sc and kept
in the SeisComP database.</p>
</div>
</section>
<section id="server-side-event-filter">
<span id="ql2sc-event-filter"></span><h2>Server-Side Event Filter<a class="headerlink" href="#server-side-event-filter" title="Permalink to this heading"></a></h2>
<p>QuakeLink provides a filter syntax similar to SQL-WHERE clauses which may be
used to filter interesting events on the server side:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>clause := condition[ AND|OR [(]clause[)]]
condition := MAG|DEPTH|LAT|LON|PHASES|DIST(lat,lon) op {float} |
DIST(lat,lon) IN [{float}, {float}] |
UPDATED|OTIME op time |
AGENCY|AUTHOR|STATUS|ESTATUS|EMODE|TYPE|REGION|MAG_T op &#39;string&#39; |
MAG|DEPTH|LAT|LON|PHASES|OTIME|UPDATED IS [NOT] NULL
op := =|!=|&gt;|&gt;=|&lt;|&lt;=|eq|gt|ge|lt|ge
time := %Y,%m,%d[,%H,%M,%S,%f]
</pre></div>
</div>
<p>E.g., the following filter string would select only those events with a minimum
magnitude of 6, detected by at least 10 stations and which are shallower than
100km:</p>
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="n">MAG</span><span class="w"> </span><span class="o">&gt;=</span><span class="w"> </span><span class="mi">6</span><span class="p">.</span><span class="mi">0</span><span class="w"> </span><span class="k">AND</span><span class="w"> </span><span class="n">PHASES</span><span class="w"> </span><span class="o">&gt;=</span><span class="w"> </span><span class="mi">10</span><span class="w"> </span><span class="k">AND</span><span class="w"> </span><span class="n">DEPTH</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="mi">100</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The supported filter commands depend on the specific QuakeLink version. To
list all available options you may connect to the server, e.g., using
<cite>telnet localhost 18010</cite>, and request the help page of the <cite>SELECT</cite> command
using <cite>help select</cite>.</p>
</div>
</section>
<section id="server-side-object-filter">
<span id="ql2sc-object-filter"></span><h2>Server-Side Object Filter<a class="headerlink" href="#server-side-object-filter" title="Permalink to this heading"></a></h2>
<p>QuakeLink provides a coarse object filter for the most relevant SeisComP objects:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Option</p></th>
<th class="head"><p>Impact</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>picks</p></td>
<td><p>include picks</p></td>
</tr>
<tr class="row-odd"><td><p>amplitudes</p></td>
<td><p>include amplitudes</p></td>
</tr>
<tr class="row-even"><td><p>arrivals</p></td>
<td><p>include origin arrivals</p></td>
</tr>
<tr class="row-odd"><td><p>staMags</p></td>
<td><p>include origin station magnitudes</p></td>
</tr>
<tr class="row-even"><td><p>staMts</p></td>
<td><p>include moment tensor station contributions and phase settings</p></td>
</tr>
<tr class="row-odd"><td><p>preferred</p></td>
<td><p>include only preferred origin and magnitude information</p></td>
</tr>
</tbody>
</table>
</section>
<section id="local-object-filter-and-routing">
<span id="routing"></span><h2>Local Object Filter and Routing<a class="headerlink" href="#local-object-filter-and-routing" title="Permalink to this heading"></a></h2>
<p>Subsequent to the server-side filters a routing table defines which objects to
import and to which message group to send them. Depending on the <cite>SeisComP</cite> modules
listening to the specified message groups an object may be further processed.
Typically no modules (other than <a class="reference internal" href="scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a>) is connected to the
<code class="docutils literal notranslate"><span class="pre">IMPORT_GROUP</span></code> so that objects sent to this group are just stored to the
database. If an object should be discarded, the special group identifier <code class="docutils literal notranslate"><span class="pre">NULL</span></code>
may be used.</p>
<p>The routing table is defined as a comma-separated list of
<code class="docutils literal notranslate"><span class="pre">object</span> <span class="pre">name:group</span> <span class="pre">name</span></code> pairs. Also the routing rules are inherited
recursively within the SeisComP object tree. If no explicit rule exists for an
object, the routing of its parent is evaluated up to the <code class="docutils literal notranslate"><span class="pre">EventParameters</span></code>
root node.</p>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>EventParameters:IMPORT_GROUP
</pre></div>
</div>
<p>Imports everything</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>EventParameters:IMPORT_GROUP,Comment:NULL
</pre></div>
</div>
<p>Imports everything except comments</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Origin:LOCATION,StationMagnitude:MAGNITUDE,Magnitude:MAGNITUDE
</pre></div>
</div>
<p>Sends origins and its children arrival, origin uncertainty to the <code class="docutils literal notranslate"><span class="pre">LOCATION</span></code>
group but the magnitude children to the <code class="docutils literal notranslate"><span class="pre">MAGNITUDE</span></code> group. Skips picks,
amplitudes, focal mechanisms and events.</p>
</section>
<section id="default-routing-table">
<h3>Default routing table<a class="headerlink" href="#default-routing-table" title="Permalink to this heading"></a></h3>
<p>The default use case of ql2sc is to import earthquake solutions from other data
centers or in-house redundant SeisComP systems. The intention is not to
reprocess the solution but to add them to the local catalog.</p>
<p>By default we route:</p>
<ul class="simple">
<li><p>Picks and Amplitudes to the <code class="docutils literal notranslate"><span class="pre">IMPORT_GROUP</span></code> group to prevent processing by
the local locator and amplitude processor</p></li>
<li><p>Origins (including its StationMagnitude and Magnitude children) to the
<code class="docutils literal notranslate"><span class="pre">LOCATION</span></code> to allow event association.</p></li>
<li><p>FocalMechanisms to the <code class="docutils literal notranslate"><span class="pre">FOCMECH</span></code> group to trigger processing by specialized
applications, e.g., graphical user interfaces for strong motion analysis or
tsunami risk assessment.</p></li>
</ul>
<p>We dont route events at all. With the help of <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> locations are
either associated to existing events or will create new events with local
settings.</p>
<p>We dont route StationMagnitudes and Magnitude to the <code class="docutils literal notranslate"><span class="pre">MAGNITDUE</span></code> group
because <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a> subscribes to <code class="docutils literal notranslate"><span class="pre">LOCATION</span></code> and <code class="docutils literal notranslate"><span class="pre">MAGNITUDE</span></code>. Separated
groups might lead to duplicated magnitude types in case a manual magnitude
solution is imported. In this case the foreign Origin with its Magnitudes would
be split into at least two messages, the first one containing the Origin, the
second one the Magnitude. The Origin message immediately triggers magnitude
calculation, potentially for a magnitude type which is received with the second
message.</p>
<p>The default routing table is set as given in <a class="reference internal" href="#confval-host.-name.routingTable"><code class="xref std std-confval docutils literal notranslate"><span class="pre">host.$name.routingTable</span></code></a>.</p>
</section>
</section>
<section id="agency-list-filter">
<span id="agency-filter"></span><h2>Agency List Filter<a class="headerlink" href="#agency-list-filter" title="Permalink to this heading"></a></h2>
<p>In addition to the local object filter the user may choose to accept only those
objects originating from a set of trusted agencies. If at least one agency is
defined in the <code class="docutils literal notranslate"><span class="pre">processing.whitelist.agencies</span></code> or
<code class="docutils literal notranslate"><span class="pre">processing.blacklist.agencies</span></code> configuration option, then the
<code class="docutils literal notranslate"><span class="pre">creationInfo.agencyID</span></code> of amplitudes, arrivals, comments, events, focal
mechanisms, magnitudes, moment tensors, origins, picks and station magnitudes is
evaluated. Objects with unmatched or unset agency information are filtered out.
If objects with unset agency ID should match, then empty string <code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code> has to be
added to the white list.</p>
<p>The agency filter is applied on remote as well as local objects. In this way
remote objects may be excluded from import and local objects my be protected
from overriding or removing. Also the filter is applied recursively. If parent
object (e.g., an origin) is filtered out, all of its children (e.g., magnitudes)
are also skipped even if they carry a different agency ID.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The agency white list filter might be essential to avoid circular event
updates between cross-connected SeisComP systems.</p>
</div>
</section>
<section id="publicid-prefix-filter">
<span id="publicid-filter"></span><h2>PublicID Prefix Filter<a class="headerlink" href="#publicid-prefix-filter" title="Permalink to this heading"></a></h2>
<p>In addition to the <a class="reference internal" href="#agency-filter"><span class="std std-ref">agency filter</span></a> incoming or local objects
can be skipped by checking their publicID prefix. It behaves similar to the
<a class="reference internal" href="#agency-filter"><span class="std std-ref">agency filter</span></a> but checks the <code class="docutils literal notranslate"><span class="pre">publicID</span></code> attribute rather
than the <code class="docutils literal notranslate"><span class="pre">creationInfo.agencyID</span></code> attribute.
Prefixes can be configure as white- or blacklist with
<code class="docutils literal notranslate"><span class="pre">processing.whitelist.publicIDs</span> <span class="pre">=</span> <span class="pre">...</span></code> and
<code class="docutils literal notranslate"><span class="pre">processing.blacklist.publicIDs</span> <span class="pre">=</span> <span class="pre">...</span></code>.</p>
</section>
<section id="workflow">
<h2>Workflow<a class="headerlink" href="#workflow" title="Permalink to this heading"></a></h2>
<p>Each event update received from a QuakeLink host is parsed and analyzed for
differences to the local database. The comparison starts at the level of the
top-level elements in the following order: picks, amplitudes, origins, focal
mechanisms, events.</p>
<p>For each top-level element the object tree is traversed in a depth-first search
order. Objects on the same level are processed in the order of their appearance.
The differences are collected as a list of notifier objects with the following
operation types:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>ADD</p></td>
<td><p>The object does not exist locally</p></td>
</tr>
<tr class="row-odd"><td><p>UPDATE</p></td>
<td><p>The object does exist locally but differs from the remote one</p></td>
</tr>
<tr class="row-even"><td><p>REMOVE</p></td>
<td><p>The object exist locally but not remotely</p></td>
</tr>
</tbody>
</table>
<p>The <code class="docutils literal notranslate"><span class="pre">ADD</span></code> and <code class="docutils literal notranslate"><span class="pre">REMOVE</span></code> operation always generates notifies of the same type
for all children of the current object. <code class="docutils literal notranslate"><span class="pre">ADD</span></code> notifiers are collected top-down,
<code class="docutils literal notranslate"><span class="pre">REMOVE</span></code> notifiers are collected bottom-up.</p>
<p>Because the order of child objects is arbitrary, e.g., the arrivals of an origin,
each object on the remote side has to be found in the set of local objects. For
public objects (e.g., origins, magnitudes, magnitudes..), the <code class="docutils literal notranslate"><span class="pre">publicID</span></code>
property is used for comparison. All other objects are compared by looking at
their index properties. For e.g., arrivals this is the <code class="docutils literal notranslate"><span class="pre">pickID</span></code> property, for
comments the <code class="docutils literal notranslate"><span class="pre">id</span></code> property.</p>
<p>Ones all notifiers are collected they are send to the local messaging system.
For performance reasons and because of the processing logic of listening <cite>SeisComP</cite>
modules ql2sc tries to batch as many notifiers as possible into one notifier
message. A separate notifier message is created if the target message group
changes between successive notifiers or if the configurable <a class="reference internal" href="#confval-batchSize"><code class="xref std std-confval docutils literal notranslate"><span class="pre">batchSize</span></code></a>
limit is reached.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Care must be taken when configuring the <code class="docutils literal notranslate"><span class="pre">batchSize</span></code> limit. If the value
is to big the overall message size limit (default: 1MB) may be exceeded
resulting in an undeliverable message. On the other hand a much to small
value will create unwanted results in the <cite>SeisComP</cite> processing chain. If for
instance picks are routed to the <code class="docutils literal notranslate"><span class="pre">PICK</span></code> group and the pick set is split
into several notifier messages the local <a class="reference internal" href="scautoloc.html#scautoloc"><span class="std std-ref">scautoloc</span></a> might create
locations based on an incomplete dataset.</p>
</div>
</section>
<section id="event-attributes">
<h2>Event Attributes<a class="headerlink" href="#event-attributes" title="Permalink to this heading"></a></h2>
<p>It might be desirable to synchronize event attributes set at the source with
the local system. In particular the event type, the type uncertainty, event
descriptions and comments might be of interest. Because it is not advisable
to route events and let <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> associate imported origins it can
happen that the imported event ID is different from the event ID of the local
system. The input host configuration parameter <code class="xref std std-confval docutils literal notranslate"><span class="pre">syncEventAttributes</span></code>
controls that behaviour. It is set to true by default which means that imported
event attributes are going to be imported as well. ql2sc does not update
directly the attributes but commandates scevent in as many cases as possible
to do so. To find the matching local event it takes the first occurrence which
has associated the currently imported preferred origin.</p>
<section id="limitations">
<h3>Limitations<a class="headerlink" href="#limitations" title="Permalink to this heading"></a></h3>
<p>There are limitations to this process to avoid infinite loops when cross
connecting two systems. Prior to sending the commands to scevent to change a
particular attribute ql2sc checks if that attribute has been set already by
another module (via JournalEntry database table). If not, then ql2sc is allowed
to request an attribute change otherwise not. To illustrate the issue take the
following example:</p>
<p>scolv connected to system <code class="docutils literal notranslate"><span class="pre">A</span></code> changes the event type to earthquake. ql2sc
of system <code class="docutils literal notranslate"><span class="pre">B</span></code> checks if the event type of the local event has been changed
already which is not the case and it requests that change. System <code class="docutils literal notranslate"><span class="pre">A</span></code>
changes the event type again to unset. ql2sc of system <code class="docutils literal notranslate"><span class="pre">B</span></code> notices that
someone has already changed the event type and it was ql2sc itself. It requests
again a change.</p>
<p>scolv connected to system <code class="docutils literal notranslate"><span class="pre">B</span></code> changes the event type to earthquake again.
ql2sc of system <code class="docutils literal notranslate"><span class="pre">A</span></code> notices that <code class="docutils literal notranslate"><span class="pre">scolv&#64;A</span></code> has already changed the
event type and ignores the request.</p>
<p>That simple case would not create an infinite loop even if <code class="docutils literal notranslate"><span class="pre">ql2sc&#64;A</span></code> would
accept the last change. The situation changes immediately if two subsequent
attribute changes are being received by <code class="docutils literal notranslate"><span class="pre">ql2sc&#64;B</span></code> while both of them are
already applied on system <code class="docutils literal notranslate"><span class="pre">A</span></code>. <code class="docutils literal notranslate"><span class="pre">ql2sc&#64;B</span></code> would “restore” the old state due
to the first received update and then apply the “final” state due to the
second update. Each update triggers again an update at system <code class="docutils literal notranslate"><span class="pre">A</span></code> and the
states start flapping. Without the described check there wouldnt be a well
defined exit condition.</p>
</section>
</section>
<section id="caveats">
<h2>Caveats<a class="headerlink" href="#caveats" title="Permalink to this heading"></a></h2>
<p>Specific combinations of remote and local object filters may result in the loss
of data. If for instance origins are imported from system <code class="docutils literal notranslate"><span class="pre">A</span></code> to <code class="docutils literal notranslate"><span class="pre">B</span></code> and
additional magnitudes for the received origins are calculated on <code class="docutils literal notranslate"><span class="pre">B</span></code>, care must
be taken. Without protection a new event update containing the same origin will
<code class="docutils literal notranslate"><span class="pre">REMOVE</span></code> all newly calculated magnitudes on <code class="docutils literal notranslate"><span class="pre">B</span></code> since they are not included
in the magnitude set sent by <code class="docutils literal notranslate"><span class="pre">A</span></code>.</p>
<p>To avoid losing these local magnitudes one may decide to block magnitudes from
import by routing them to <code class="docutils literal notranslate"><span class="pre">NULL</span></code>. If magnitudes from <code class="docutils literal notranslate"><span class="pre">A</span></code> and from <code class="docutils literal notranslate"><span class="pre">B</span></code>
should be available, an <a class="reference internal" href="#agency-filter"><span class="std std-ref">agency filter</span></a> or
<a class="reference internal" href="#publicid-filter"><span class="std std-ref">publicID filter</span></a> may be defined.</p>
<p>Make sure <code class="docutils literal notranslate"><span class="pre">A</span></code> and <code class="docutils literal notranslate"><span class="pre">B</span></code> use either distinct agency IDs or distinct publicID
patterns and add the agency ID of <code class="docutils literal notranslate"><span class="pre">B</span></code> to <code class="docutils literal notranslate"><span class="pre">processing.blacklist.agencies</span></code> or
the publicID prefix of <code class="docutils literal notranslate"><span class="pre">B</span></code> to <code class="docutils literal notranslate"><span class="pre">processing.blacklist.publicIDs</span></code>.</p>
</section>
<section id="module-configuration">
<span id="ql2sc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/ql2sc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/ql2sc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/ql2sc.cfg</span></code></div>
</div>
<p>ql2sc inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-backLog">
<span class="sig-name descname"><span class="pre">backLog</span></span><a class="headerlink" href="#confval-backLog" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1800</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>Number of seconds to fetch missed updates on start up.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-cacheSize">
<span class="sig-name descname"><span class="pre">cacheSize</span></span><a class="headerlink" href="#confval-cacheSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5000</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of public objects to cache.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-batchSize">
<span class="sig-name descname"><span class="pre">batchSize</span></span><a class="headerlink" href="#confval-batchSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">2000</span></code></p>
<p>Type: <em>int</em></p>
<p>Maximum number of notifiers to batch in one message. If set
to 0 no size limit is enforced. Make sure to not hit the
overall message size limited of 16MiB which is enforced by
the messaging system.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventAssociationTimeout">
<span class="sig-name descname"><span class="pre">eventAssociationTimeout</span></span><a class="headerlink" href="#confval-eventAssociationTimeout" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>If event synchronisation is enabled and an incoming origin
is not yet associated with an event on the target machine,
then this timeout defines the maximum number of seconds to
wait for an association.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts">
<span class="sig-name descname"><span class="pre">hosts</span></span><a class="headerlink" href="#confval-hosts" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Registration of the host profiles defining the connection
parameters to the QuakeLink hosts.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>host.*</strong>
<em>Definition of host profiles. For each host profile a connection</em>
<em>to one QuakeLink server can established. The profiles must be registered</em>
<em>in hosts to apply them.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>host.$name.*</strong>
<em>Provide the connection parameters to one QuakeLink server.</em>
$name is a placeholder for the name to be used and needs to be added to <a class="reference internal" href="#confval-hosts"><code class="xref std std-confval docutils literal notranslate"><span class="pre">hosts</span></code></a> to become active.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">hosts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>a,b
host.a.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
host.b.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
<span class="c1"># c is not active because it has not been added</span>
<span class="c1"># to the list of hosts</span>
host.c.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.url">
<span class="sig-name descname"><span class="pre">host.$name.url</span></span><a class="headerlink" href="#confval-host.-name.url" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">ql://localhost:18010</span></code></p>
<p>Type: <em>string</em></p>
<p>URL of the QuakeLink service, the scheme qls enables SSL.</p>
<p>Format: [ql[s]://][user:pwd&#64;][host][:port].</p>
<p>If set to an empty string the application will run without any QuakeLink connection attempt.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.gzip">
<span class="sig-name descname"><span class="pre">host.$name.gzip</span></span><a class="headerlink" href="#confval-host.-name.gzip" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enable/disable GZip (GNU zip) compression.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.native">
<span class="sig-name descname"><span class="pre">host.$name.native</span></span><a class="headerlink" href="#confval-host.-name.native" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Request native data instead of XML format.
Native data export may be disabled on some hosts.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.syncEventAttributes">
<span class="sig-name descname"><span class="pre">host.$name.syncEventAttributes</span></span><a class="headerlink" href="#confval-host.-name.syncEventAttributes" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Try to update the event attributes of the target event
with the attributes of the source event which includes
event type and event certainty. It will not import
events but tries to find the associated event of the
input preferred origin at the target system and will
update the event attributes via journaling.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.syncPreferred">
<span class="sig-name descname"><span class="pre">host.$name.syncPreferred</span></span><a class="headerlink" href="#confval-host.-name.syncPreferred" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Synchronize the preferred origin and preferred
magnitude selection if different from the imported
selection. ql2sc will wait for the event association
of an imported origin and check if the preferred origin
or preferred magnitude is different from the imported
Quakelink event. If so it will send a journal to
force selection of the preferred origin and selection
of the preferred magnitude type. These are the same
operations as within scolv to fix an origin and
a particular magnitude type.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.syncEventDelay">
<span class="sig-name descname"><span class="pre">host.$name.syncEventDelay</span></span><a class="headerlink" href="#confval-host.-name.syncEventDelay" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>int</em></p>
<p>Delays the synchronization of event attributes in seconds
if set to a value greater than zero.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.keepAlive">
<span class="sig-name descname"><span class="pre">host.$name.keepAlive</span></span><a class="headerlink" href="#confval-host.-name.keepAlive" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Request server to send keep alive message every 30s to
prevent connection reset by firewalls on long idle
periods. If activated the client will reset the
connection if no alive message is received within 60s.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.filter">
<span class="sig-name descname"><span class="pre">host.$name.filter</span></span><a class="headerlink" href="#confval-host.-name.filter" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>SQL like WHERE clause to filter the result set.</p>
<p>clause := condition[ AND|OR [(]clause[)]] __
condition := MAG|DEPTH|LAT|LON|PHASES|OTIME|UPDATED [op float|time]|[IS [NOT] NULL] __
op := =|&gt;|&gt;=|&lt;|&lt;=|eq|gt|ge|lt|ge __
time := %Y,%m,%d[,%H,%M,%S,%f]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.routingTable">
<span class="sig-name descname"><span class="pre">host.$name.routingTable</span></span><a class="headerlink" href="#confval-host.-name.routingTable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">Pick:IMPORT_GROUP,Amplitude:IMPORT_GROUP,FocalMechanism:EVENT,Origin:EVENT</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Map datamodel class names to messaging groups. For unmapped objects
the mapping of their parent objects is evaluated recursively. Objects
may be excluded by mapping them to NULL.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>host.$name.data.*</strong>
<em>Specify the XML components to fetch.</em>
<em>Note: These options are not used if native data is requested.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.data.picks">
<span class="sig-name descname"><span class="pre">host.$name.data.picks</span></span><a class="headerlink" href="#confval-host.-name.data.picks" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Include picks</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.data.amplitudes">
<span class="sig-name descname"><span class="pre">host.$name.data.amplitudes</span></span><a class="headerlink" href="#confval-host.-name.data.amplitudes" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Include amplitudes</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.data.arrivals">
<span class="sig-name descname"><span class="pre">host.$name.data.arrivals</span></span><a class="headerlink" href="#confval-host.-name.data.arrivals" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Include origin arrivals</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.data.staMags">
<span class="sig-name descname"><span class="pre">host.$name.data.staMags</span></span><a class="headerlink" href="#confval-host.-name.data.staMags" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Include origin station magnitudes</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.data.staMts">
<span class="sig-name descname"><span class="pre">host.$name.data.staMts</span></span><a class="headerlink" href="#confval-host.-name.data.staMts" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Include moment tensor station contributions and phase settings</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host.-name.data.preferred">
<span class="sig-name descname"><span class="pre">host.$name.data.preferred</span></span><a class="headerlink" href="#confval-host.-name.data.preferred" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Include only preferred origin and magnitude information</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-processing.blacklist.publicIDs">
<span class="sig-name descname"><span class="pre">processing.blacklist.publicIDs</span></span><a class="headerlink" href="#confval-processing.blacklist.publicIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defines a blacklist of publicID prefixes that are
not allowed for processing. Separate items by comma.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-processing.whitelist.publicIDs">
<span class="sig-name descname"><span class="pre">processing.whitelist.publicIDs</span></span><a class="headerlink" href="#confval-processing.whitelist.publicIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defines a whitelist of publicID prefixes that are
allowed for processing. Separate items by comma.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">ql2sc [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-h">
<span id="cmdoption-ql2sc-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-V">
<span id="cmdoption-ql2sc-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-D">
<span id="cmdoption-ql2sc-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-v">
<span id="cmdoption-ql2sc-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-q">
<span id="cmdoption-ql2sc-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-s">
<span id="cmdoption-ql2sc-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-l">
<span id="cmdoption-ql2sc-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-u">
<span id="cmdoption-ql2sc-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-H">
<span id="cmdoption-ql2sc-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-t">
<span id="cmdoption-ql2sc-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-g">
<span id="cmdoption-ql2sc-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-S">
<span id="cmdoption-ql2sc-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ql2sc-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ql2sc-d">
<span id="cmdoption-ql2sc-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-ql2sc-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ql2sc</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#server-side-event-filter">Server-Side Event Filter</a></li>
<li><a class="reference internal" href="#server-side-object-filter">Server-Side Object Filter</a></li>
<li><a class="reference internal" href="#local-object-filter-and-routing">Local Object Filter and Routing</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#default-routing-table">Default routing table</a></li>
</ul>
</li>
<li><a class="reference internal" href="#agency-list-filter">Agency List Filter</a></li>
<li><a class="reference internal" href="#publicid-prefix-filter">PublicID Prefix Filter</a></li>
<li><a class="reference internal" href="#workflow">Workflow</a></li>
<li><a class="reference internal" href="#event-attributes">Event Attributes</a><ul>
<li><a class="reference internal" href="#limitations">Limitations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#caveats">Caveats</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="fdsnws.html"
title="previous chapter">fdsnws</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scalert.html"
title="next chapter">scalert</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/ql2sc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,609 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scalert &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scart" href="scart.html" />
<link rel="prev" title="ql2sc" href="ql2sc.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">6.9.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="scart.html" title="scart"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="ql2sc.html" title="ql2sc"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scalert">
<span id="id1"></span><h1>scalert<a class="headerlink" href="#scalert" title="Permalink to this heading"></a></h1>
<p><strong>Real time alert template.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>This module executes custom scripts upon arrival of objects or updates.
It provides as template for custom modification and is not a replacement for <a class="reference internal" href="scvoice.html#scvoice"><span class="std std-ref">scvoice</span></a>.</p>
<p>There are four possible trigger mechanisms for calling scripts:</p>
<ul class="simple">
<li><p>Event creation/update,</p></li>
<li><p>Amplitude creation,</p></li>
<li><p>Origin creation (with status = preliminary),</p></li>
<li><p>Pick creation with filter for phase hint.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>People started modifying <a class="reference internal" href="scvoice.html#scvoice"><span class="std std-ref">scvoice</span></a> to send emails or
other alert messages. Then, the name <em>scvoice</em> is then just wrong.
If you want to customize <a class="reference internal" href="scvoice.html#scvoice"><span class="std std-ref">scvoice</span></a>, use scalert instead.</p>
</div>
</section>
<section id="module-configuration">
<span id="scalert-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scalert.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scalert.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scalert.cfg</span></code></div>
</div>
<p>scalert inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-firstNew">
<span class="sig-name descname"><span class="pre">firstNew</span></span><a class="headerlink" href="#confval-firstNew" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Treat an event as new event when it is seen the first time.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-agencyIDs">
<span class="sig-name descname"><span class="pre">agencyIDs</span></span><a class="headerlink" href="#confval-agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of agency IDs to consider picks and origins. The agency ID
is extracted from the pick or the preferred origin of the event
and compared with the configured IDs.</p>
<p>unset (=): use agencyID defined in global, default</p>
<p>empty list (=&quot;&quot;): all agencies are allowed</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-authors">
<span class="sig-name descname"><span class="pre">authors</span></span><a class="headerlink" href="#confval-authors" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of authors to consider picks and origins. The author
is extracted from the pick or the preferred origin of the event
and compared with the configured authors.
empty list (=&quot;&quot;): all authors are allowed</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.message">
<span class="sig-name descname"><span class="pre">poi.message</span></span><a class="headerlink" href="#confval-poi.message" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The default message string for the event-script is
&quot;earthquake, [HOURS] hours [MINS] minutes ago, [DESC],
magnitude [MAG], depth [DEP] kilometers&quot; whereas [DESC]
is the string given in the event.description attribute. This
string can be overwritten using one of the following options.
There are three placeholders that can be used: &#64;region&#64;,
&#64;dist&#64; and &#64;poi&#64;.
Example: &quot;&#64;region&#64;, &#64;dist&#64; kilometers from &#64;poi&#64;
away&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.maxDist">
<span class="sig-name descname"><span class="pre">poi.maxDist</span></span><a class="headerlink" href="#confval-poi.maxDist" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>When using the nearest point of interest (city) as part of
the message string, specify the maximum distance in degrees
from the event. Any point of interest farther away will be
ignored.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.minPopulation">
<span class="sig-name descname"><span class="pre">poi.minPopulation</span></span><a class="headerlink" href="#confval-poi.minPopulation" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">50000</span></code></p>
<p>Type: <em>double</em></p>
<p>Minimum population for a city to become a point of interest.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.pick">
<span class="sig-name descname"><span class="pre">scripts.pick</span></span><a class="headerlink" href="#confval-scripts.pick" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The script to be called when a pick
arrives. Network-, station code, pick publicID are passed
as parameters $1, $2, $3.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.amplitude">
<span class="sig-name descname"><span class="pre">scripts.amplitude</span></span><a class="headerlink" href="#confval-scripts.amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The script to be called when an amplitude
arrives. Network-, station code, amplitude and amplitude
public ID are passed as parameters $1, $2, $3, $4.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.alert">
<span class="sig-name descname"><span class="pre">scripts.alert</span></span><a class="headerlink" href="#confval-scripts.alert" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The script to be called when a preliminary
origin arrives. Latitude and longitude are passed as
parameters $1 and $2.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.event">
<span class="sig-name descname"><span class="pre">scripts.event</span></span><a class="headerlink" href="#confval-scripts.event" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The script to be called when an event has been
declared. The message string, a flag (1=new event,
0=update event), the EventID, the arrival count and the
magnitude (optional when set) are passed as parameters
$1, $2, $3, $4 and $5.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>constraints.*</strong>
<em>Constraints for executing scripts</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-constraints.phaseHints">
<span class="sig-name descname"><span class="pre">constraints.phaseHints</span></span><a class="headerlink" href="#confval-constraints.phaseHints" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">P,S</span></code></p>
<p>Type: <em>list::string</em></p>
<p>Start the pick script only when the phaseHint of the
received pick has one of the value(s).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-constraints.phaseStreams">
<span class="sig-name descname"><span class="pre">constraints.phaseStreams</span></span><a class="headerlink" href="#confval-constraints.phaseStreams" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list::string</em></p>
<p>Start the pick script only when the stream (NET.STA.LOC.CHA)
of the received pick belongs to the list of stream IDs. If empty,
all picks are accepted, otherwise only the ones whose stream ID
matches one of the entry of this comma separated list. Each entry
must follow the NET.STA.LOC.CHA format, but the special
characters ? * | ( ) are also accepeted.
E.g. &quot;CH.*,GR.STA??.*,*.*.*.HH?,*.*.*.??(Z|1)&quot;</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-constraints.phaseNumber">
<span class="sig-name descname"><span class="pre">constraints.phaseNumber</span></span><a class="headerlink" href="#confval-constraints.phaseNumber" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>int</em></p>
<p>Start the pick script only when a minimum number of phases
phaseNumber is received within phaseInterval.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-constraints.phaseInterval">
<span class="sig-name descname"><span class="pre">constraints.phaseInterval</span></span><a class="headerlink" href="#confval-constraints.phaseInterval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>Start the pick script only when a minimum number of phases
phaseNumber is received within phaseInterval.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scalert [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-h">
<span id="cmdoption-scalert-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-V">
<span id="cmdoption-scalert-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-D">
<span id="cmdoption-scalert-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-first-new">
<span class="sig-name descname"><span class="pre">--first-new</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-first-new" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-firstNew"><code class="xref std std-confval docutils literal notranslate"><span class="pre">firstNew</span></code></a>.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-v">
<span id="cmdoption-scalert-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-q">
<span id="cmdoption-scalert-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-s">
<span id="cmdoption-scalert-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-l">
<span id="cmdoption-scalert-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-u">
<span id="cmdoption-scalert-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-H">
<span id="cmdoption-scalert-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-t">
<span id="cmdoption-scalert-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-g">
<span id="cmdoption-scalert-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-S">
<span id="cmdoption-scalert-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-d">
<span id="cmdoption-scalert-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scalert-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="alert">
<h3>Alert<a class="headerlink" href="#alert" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-amp-type">
<span class="sig-name descname"><span class="pre">--amp-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-amp-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify the amplitude type to listen to.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-amp-script">
<span class="sig-name descname"><span class="pre">--amp-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-amp-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-scripts.amplitude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.amplitude</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-alert-script">
<span class="sig-name descname"><span class="pre">--alert-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-alert-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-scripts.alert"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.alert</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-event-script">
<span class="sig-name descname"><span class="pre">--event-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-event-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-scripts.event"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.event</span></code></a>.</p>
</dd></dl>
</section>
<section id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-max-dist">
<span class="sig-name descname"><span class="pre">--max-dist</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-max-dist" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-poi.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">poi.maxDist</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-min-population">
<span class="sig-name descname"><span class="pre">--min-population</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-min-population" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-poi.minPopulation"><code class="xref std std-confval docutils literal notranslate"><span class="pre">poi.minPopulation</span></code></a>.</p>
</dd></dl>
</section>
<section id="debug">
<h3>Debug<a class="headerlink" href="#debug" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scalert-E">
<span id="cmdoption-scalert-eventid"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--eventid</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scalert-E" title="Permalink to this definition"></a></dt>
<dd><p>Specify event ID that is used for testing. After running the
alert scripts scvoice will exit.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scalert</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#alert">Alert</a></li>
<li><a class="reference internal" href="#cities">Cities</a></li>
<li><a class="reference internal" href="#debug">Debug</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="ql2sc.html"
title="previous chapter">ql2sc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scart.html"
title="next chapter">scart</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scalert.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,666 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scamp &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scautoloc" href="scautoloc.html" />
<link rel="prev" title="ew2sc" href="ew2sc.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">6.9.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="scautoloc.html" title="scautoloc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="ew2sc.html" title="ew2sc"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/processing.html" accesskey="U">Processing</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scamp">
<span id="id1"></span><h1>scamp<a class="headerlink" href="#scamp" title="Permalink to this heading"></a></h1>
<p><strong>Calculates amplitudes on basis of incoming origins and the associated picks.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scamp measures several different kinds of amplitudes from waveform data.
It listens for origins and measures amplitudes in time windows determined
from the origin. Thus, in contrast to amplitudes measured by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>
the considered time windows can depend on epicentral distance.
The resulting amplitude objects are sent to the “AMPLITUDE”
messaging group. scamp is the counterpart of <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>. Usually, all
amplitudes are computed at once by scamp and then published.
Only very rarely an amplitude needs to be recomputed if the location of an
origin changes significantly. The amplitude can be reused by <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>, making
magnitude computation and update efficient. Currently, the automatic picker
in SeisComP, scautopick, also measures a small set of amplitudes
(namely “snr” and “mb”, the signal-to-noise ratio and the amplitude used in
mb magnitude computation, respectively) for each automatic pick in fixed
time windows. If there already exists an amplitude, e.g. a previously determined
one by scautopick, scamp will not measure it again for the respective stream.</p>
<p>Amplitudes are also needed, however, for manual picks. scamp does this as well.
Arrivals with weight smaller than 0.5 (default) in the corresponding Origin are
discarded. This minimum weight can be configured with
<a class="reference internal" href="#confval-amptool.minimumPickWeight"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amptool.minimumPickWeight</span></code></a>.</p>
</section>
<section id="amplitude-types">
<h2>Amplitude Types<a class="headerlink" href="#amplitude-types" title="Permalink to this heading"></a></h2>
<p>Amplitudes of many types are currently computed for their corresponding
magnitudes.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In order to be used by scmag, the input amplitude names for the
various magnitude types must typically match exactly. Exceptions:</p>
<ul class="simple">
<li><p><a class="reference internal" href="../base/glossary.html#term-magnitude-Nuttli-MN"><span class="xref std std-term">MN</span></a> requires <em>AMN</em> amplitudes,</p></li>
<li><p><a class="reference internal" href="../base/glossary.html#term-magnitude-local-GNS-GEONET-MLr"><span class="xref std std-term">MLr</span></a> requires <em>MLv</em> amplitudes.</p></li>
</ul>
</div>
<section id="local-distances">
<h3>Local distances<a class="headerlink" href="#local-distances" title="Permalink to this heading"></a></h3>
<dl class="simple">
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-duration-Md"><span class="xref std std-term">Md</span></a></dt><dd><p>Duration magnitude as described in HYPOINVERSE (<span id="id2">Klein [<a class="reference internal" href="../base/references.html#id47" title="F.W. Klein. Users guide to HYPOINVERSE-2000, a Fortran program to solve for earthquake locations and magnitudes. US Geological Survey, 2002-171:, 2002. URL: https://www.usgs.gov/node/279394, doi:10.3133/ofr02171.">50</a>]</span>).</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-JMA-M_JMA"><span class="xref std std-term">Mjma</span></a></dt><dd><p>Mjma is computed on displacement data using body waves of period &lt; 30s.</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-ML"><span class="xref std std-term">ML</span></a></dt><dd><p>Local (Richter) magnitude calculated on the horizontal components using a
correction term to fit with the standard ML (<span id="id3">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>).</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-custom-MLc"><span class="xref std std-term">MLc</span></a></dt><dd><p>Local custom magnitude calculated on the horizontal components according to
Hessian Earthquake Service and <span id="id4">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-horizontal-MLh"><span class="xref std std-term">MLh</span></a></dt><dd><p>Local magnitude calculated on the horizontal components according to SED
specifications.</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-vertical-MLv"><span class="xref std std-term">MLv</span></a></dt><dd><p>Local magnitude calculated on the vertical component using a correction term
to fit with the standard ML.</p>
</dd>
<dt>AMN for <a class="reference internal" href="../base/glossary.html#term-magnitude-Nuttli-MN"><span class="xref std std-term">MN</span></a></dt><dd><p>Nuttli magnitude for Canada and other Cratonic regions (<span id="id5">Nuttli [<a class="reference internal" href="../base/references.html#id58" title="O.W. Nuttli. Seismic wave attenuation and magnitude relations for eastern north america. J. Geophys. Res., 5:876 - 885, 1973. doi:10.1029/JB078i005p00876.">53</a>]</span>).</p>
</dd>
</dl>
</section>
<section id="teleseismic-distances">
<h3>Teleseismic distances<a class="headerlink" href="#teleseismic-distances" title="Permalink to this heading"></a></h3>
<dl class="simple">
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-body-wave-mb"><span class="xref std std-term">mb</span></a></dt><dd><p>Narrow band body wave magnitude measured on a WWSSN-SP filtered trace</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-cumulative-body-wave-mBc"><span class="xref std std-term">mBc</span></a></dt><dd><p>Cumulative body wave magnitude</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-body-wave-mB"><span class="xref std std-term">mB</span></a></dt><dd><p>Broad band body wave magnitude after <span id="id6">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-P-wave-moment-Mwp"><span class="xref std std-term">Mwp</span></a></dt><dd><p>The body wave magnitude of <span id="id7">Tsuboi <em>et al.</em> [<a class="reference internal" href="../base/references.html#id79" title="S. Tsuboi, K. Abe, K. Takano, and Y. Yamanaka. Rapid determination of Mw from broadband P waveforms. Bull. Seismol. Soc. Am., 1995. doi:10.1785/BSSA0850020606.">63</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-surface-wave-Ms_20"><span class="xref std std-term">Ms_20</span></a></dt><dd><p>Surface-wave magnitude at 20 s period</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-surface-wave-Ms-BB"><span class="xref std std-term">Ms(BB)</span></a></dt><dd><p>Broad band surface-wave magnitude</p>
</dd>
</dl>
</section>
</section>
<section id="acceleration-input-data">
<h2>Acceleration Input Data<a class="headerlink" href="#acceleration-input-data" title="Permalink to this heading"></a></h2>
<p>For amplitudes to be computed, the input waveforms are usually given in velocity.
Acceleration data, e.g. from strong-motion instruments must therefore be transformed
to velocity. The transformation is enabled by activating the response correction.
Activate the correction in the global bindings for all
types or in a new Amplitude type profile for specific types.</p>
<p>Example global binding parameters for computing MLv amplitudes from accleration
data. Here, the frequency range is limited to 0.5 - 20 Hz:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>amplitudes.MLv.enableResponses = true
amplitudes.MLv.resp.taper = 5
amplitudes.MLv.resp.minFreq = 0.5
amplitudes.MLv.resp.maxFreq = 20
</pre></div>
</div>
</section>
<section id="re-processing">
<h2>Re-processing<a class="headerlink" href="#re-processing" title="Permalink to this heading"></a></h2>
<p><em>scamp</em> can be used to reprocess and to update amplitudes, e.g. when inventory paramters
had to be changed retrospectively. Updating ampitudes requires waveform access.
The update can be performed</p>
<ol class="arabic">
<li><p>In <strong>offline processing</strong> based on XML files (<code class="xref std std-confval docutils literal notranslate"><span class="pre">--ep</span></code>). <code class="xref std std-confval docutils literal notranslate"><span class="pre">--reprocess</span></code>
will replace exisiting amplitudes. Updated values can be dispatched to the messing by
<a class="reference internal" href="scdispatch.html#scdispatch"><span class="std std-ref">scdispatch</span></a> making them available for further processing, e.g. by <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>.</p>
<p><strong>Example:</strong></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scamp<span class="w"> </span>--ep<span class="w"> </span>evtID.xml<span class="w"> </span>-d<span class="w"> </span><span class="o">[</span>type<span class="o">]</span>://<span class="o">[</span>host<span class="o">]</span>/<span class="o">[</span>database<span class="o">]</span><span class="w"> </span>--reprocess<span class="w"> </span>&gt;<span class="w"> </span>evtID_update.xml
$<span class="w"> </span>scdispatch<span class="w"> </span>-O<span class="w"> </span>merge<span class="w"> </span>-H<span class="w"> </span><span class="o">[</span>host<span class="o">]</span><span class="w"> </span>-i<span class="w"> </span>evtID_update.xml
</pre></div>
</div>
</li>
<li><p><strong>With messaging</strong> by setting <code class="xref std std-confval docutils literal notranslate"><span class="pre">start-time</span></code> or <code class="xref std std-confval docutils literal notranslate"><span class="pre">end-time</span></code>.
All parameters are read from the database. <code class="xref std std-confval docutils literal notranslate"><span class="pre">--commit</span></code> will
send the updated parameters to the messing system making them available for
further processing, e.g. by <a class="reference internal" href="scmag.html#scmag"><span class="std std-ref">scmag</span></a>. Otherwise, XML output is generated.</p>
<p><strong>Example:</strong></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scamp<span class="w"> </span>-u<span class="w"> </span>testuser<span class="w"> </span>-H<span class="w"> </span><span class="o">[</span>host<span class="o">]</span><span class="w"> </span>--commit<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--start-time<span class="w"> </span><span class="s1">&#39;2016-10-15 00:00:00&#39;</span><span class="w"> </span>--end-time<span class="w"> </span><span class="s1">&#39;2016-10-16 19:20:00&#39;</span>
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="scamp-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scamp.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scamp.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scamp.cfg</span></code></div>
</div>
<p>scamp inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-amplitudes">
<span class="sig-name descname"><span class="pre">amplitudes</span></span><a class="headerlink" href="#confval-amplitudes" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">MLv,</span> <span class="pre">mb,</span> <span class="pre">mB,</span> <span class="pre">Mwp</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Definition of magnitude types for which amplitudes are to be calculated.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-amptool.minimumPickWeight">
<span class="sig-name descname"><span class="pre">amptool.minimumPickWeight</span></span><a class="headerlink" href="#confval-amptool.minimumPickWeight" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code></p>
<p>Type: <em>double</em></p>
<p>The minimum arrival weight within an origin to compute amplitudes for the associated pick.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-amptool.streamFromBindings">
<span class="sig-name descname"><span class="pre">amptool.streamFromBindings</span></span><a class="headerlink" href="#confval-amptool.streamFromBindings" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled then global bindings will be used to replace
location code and channel code of a pick with the configured
values of detecLocid and detecStream for amplitude computation.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-amptool.initialAcquisitionTimeout">
<span class="sig-name descname"><span class="pre">amptool.initialAcquisitionTimeout</span></span><a class="headerlink" href="#confval-amptool.initialAcquisitionTimeout" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Timeout in seconds of the first data packet of waveform data acquisition.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-amptool.runningAcquisitionTimeout">
<span class="sig-name descname"><span class="pre">amptool.runningAcquisitionTimeout</span></span><a class="headerlink" href="#confval-amptool.runningAcquisitionTimeout" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">2</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Timeout in seconds of any subsequent data packet of waveform data acquisition.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-h">
<span id="cmdoption-scamp-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-V">
<span id="cmdoption-scamp-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-D">
<span id="cmdoption-scamp-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-x">
<span id="cmdoption-scamp-expiry"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--expiry</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scamp-x" title="Permalink to this definition"></a></dt>
<dd><p>Time span in hours after which objects expire.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-O">
<span id="cmdoption-scamp-origin-id"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--origin-id</span></span><span class="sig-prename descclassname"> <span class="pre">publicID</span></span><a class="headerlink" href="#cmdoption-scamp-O" title="Permalink to this definition"></a></dt>
<dd><p>OriginID to calculate amplitudes for and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-dump-records">
<span class="sig-name descname"><span class="pre">--dump-records</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-dump-records" title="Permalink to this definition"></a></dt>
<dd><p>Dumps the filtered traces to ASCII when using -O.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-v">
<span id="cmdoption-scamp-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-q">
<span id="cmdoption-scamp-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-s">
<span id="cmdoption-scamp-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-l">
<span id="cmdoption-scamp-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-u">
<span id="cmdoption-scamp-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-H">
<span id="cmdoption-scamp-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-t">
<span id="cmdoption-scamp-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-g">
<span id="cmdoption-scamp-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-S">
<span id="cmdoption-scamp-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-test" title="Permalink to this definition"></a></dt>
<dd><p>Test mode where no messages are sent.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-d">
<span id="cmdoption-scamp-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-I">
<span id="cmdoption-scamp-record-url"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scamp-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-ep">
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-scamp-ep" title="Permalink to this definition"></a></dt>
<dd><p>Defines an event parameters XML file to be read and processed. This
implies offline mode and only processes all origins contained
in that file. It computes amplitudes for all picks associated
with an origin and outputs an XML file that additionally
contains the amplitudes.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-p">
<span id="cmdoption-scamp-picks"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--picks</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-p" title="Permalink to this definition"></a></dt>
<dd><p>Force measuring amplitudes for picks only. Origins are
ignored and time windows are independent of distance. Works
only in combination with --ep.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-reprocess">
<span class="sig-name descname"><span class="pre">--reprocess</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-reprocess" title="Permalink to this definition"></a></dt>
<dd><p>Reprocess and update existing amplitudes. Manual amplitudes
will be skipped. Works only in combination with --ep.
This option can be used, e.g., for reprocessing amplitudes
with new inventory information. Waveform access is required.</p>
</dd></dl>
</section>
<section id="reprocess">
<h3>Reprocess<a class="headerlink" href="#reprocess" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-force">
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-force" title="Permalink to this definition"></a></dt>
<dd><p>Forces reprocessing of all amplitudes, even manual ones.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-start-time">
<span class="sig-name descname"><span class="pre">--start-time</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scamp-start-time" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-end-time">
<span class="sig-name descname"><span class="pre">--end-time</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scamp-end-time" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scamp-commit">
<span class="sig-name descname"><span class="pre">--commit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scamp-commit" title="Permalink to this definition"></a></dt>
<dd><p>Send amplitude updates to the messaging otherwise an XML
document will be output.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scamp</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#amplitude-types">Amplitude Types</a><ul>
<li><a class="reference internal" href="#local-distances">Local distances</a></li>
<li><a class="reference internal" href="#teleseismic-distances">Teleseismic distances</a></li>
</ul>
</li>
<li><a class="reference internal" href="#acceleration-input-data">Acceleration Input Data</a></li>
<li><a class="reference internal" href="#re-processing">Re-processing</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#reprocess">Reprocess</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="ew2sc.html"
title="previous chapter">ew2sc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scautoloc.html"
title="next chapter">scautoloc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scamp.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,686 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scardac &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scwfas" href="scwfas.html" />
<link rel="prev" title="msrtsimul" href="msrtsimul.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">6.9.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="scwfas.html" title="scwfas"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="msrtsimul.html" title="msrtsimul"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scardac">
<span id="id1"></span><h1>scardac<a class="headerlink" href="#scardac" title="Permalink to this heading"></a></h1>
<p><strong>Waveform archive data availability collector.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scardac scans an <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS waveform archive</span></a>, e.g.,
created by <a class="reference internal" href="slarchive.html#slarchive"><span class="std std-ref">slarchive</span></a> or <a class="reference internal" href="scart.html#scart"><span class="std std-ref">scart</span></a> for available
<a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> data. It will collect information about</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">DataExtents</span></code> the earliest and latest times data is available
for a particular channel,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DataAttributeExtents</span></code> the earliest and latest times data is available
for a particular channel, quality and sampling rate combination,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DataSegments</span></code> continuous data segments sharing the same quality and
sampling rate attributes.</p></li>
</ul>
<p>scardac is intended to be executed periodically, e.g., as a cronjob.</p>
<p>The availability data information is stored in the SeisComP database under the
root element <a class="reference internal" href="../base/api-python.html#api-datamodel-python"><span class="std std-ref">DataAvailability</span></a>. Access to the
availability data is provided by the <a class="reference internal" href="fdsnws.html#fdsnws"><span class="std std-ref">fdsnws</span></a> module via the services:</p>
<ul class="simple">
<li><p><a class="reference internal" href="fdsnws.html#sec-station"><span class="std std-ref">/fdsnws/station</span></a> (extent information only, see
<code class="docutils literal notranslate"><span class="pre">matchtimeseries</span></code> and <code class="docutils literal notranslate"><span class="pre">includeavailability</span></code> request parameters).</p></li>
<li><p><a class="reference internal" href="fdsnws.html#sec-avail"><span class="std std-ref">/fdsnws/ext/availability</span></a> (extent and segment information
provided in different formats)</p></li>
</ul>
<section id="non-sds-archives">
<span id="scarcac-non-sds"></span><h3>Non-SDS archives<a class="headerlink" href="#non-sds-archives" title="Permalink to this heading"></a></h3>
<p>scardac can be extended by plugins to scan non-SDS archives. For example the
<code class="docutils literal notranslate"><span class="pre">daccaps</span></code> plugin provided by <span id="id2"><em>CAPS</em> [<a class="reference internal" href="../base/references.html#id91" title="CAPS. gempa module. URL: https://docs.gempa.de/caps/current/index.html.">3</a>]</span> allows scanning archives generated
by a CAPS server. Plugins are added to the global module configuration, e.g.:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">${plugins}, daccaps</span>
</pre></div>
</div>
</section>
<section id="definitions">
<span id="scarcac-workflow"></span><h3>Definitions<a class="headerlink" href="#definitions" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Record</span></code> continuous waveform data of same sampling rate and quality bound
by a start and end time. scardac will only read the records meta data and not
the actual samples.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Chunk</span></code> container for records, e.g., a <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> file,
with the following properties:</p>
<ul>
<li><p>overall, theoretical time range of records it may contain</p></li>
<li><p>contains at least one record, otherwise it must be absent</p></li>
<li><p>each record of a chunk must fulfill the following conditions:</p>
<ul>
<li><p><cite>chunk start &lt;= record start &lt; chunk end</cite></p></li>
<li><p><cite>chunk start &lt; record end &lt; next chunk end</cite></p></li>
</ul>
</li>
<li><p>chunks do not overlap, end time of current chunk equals start time of
successive chunk, otherwise a <code class="docutils literal notranslate"><span class="pre">chunk</span> <span class="pre">gap</span></code> is declared</p></li>
<li><p>records may occur unordered within a chunk or across chunk boundaries,
resulting in <cite>DataSegments</cite> marked as <code class="docutils literal notranslate"><span class="pre">outOfOrder</span></code></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Jitter</span></code> maximum allowed deviation between the end time of the current
record and the start time of the next record in multiples of the currents
record sampling rate. E.g., assuming a sampling rate of 100Hz and a jitter
of 0.5 will allow for a maximum end to start time difference of 50ms. If
exceeded a new <cite>DataSegment</cite> is created.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Mtime</span></code> time the content of a chunk was last modified. It is used to</p>
<ul>
<li><p>decided whether a chunk needs to be read in a secondary application run</p></li>
<li><p>calculate the <code class="docutils literal notranslate"><span class="pre">updated</span></code> time stamp of a <cite>DataSegment</cite>,
<cite>DataAttributeExtent</cite> and <cite>DataExtent</cite></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Scan</span> <span class="pre">window</span></code> time window limiting the synchronization of the archive
with the database configured via <a class="reference internal" href="#confval-filter.time.start"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.time.start</span></code></a> and
<a class="reference internal" href="#confval-filter.time.end"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.time.end</span></code></a> respectively <code class="xref std std-option docutils literal notranslate"><span class="pre">--start</span></code> and <code class="xref std std-option docutils literal notranslate"><span class="pre">--end</span></code>.
The scan window is useful to</p>
<ul>
<li><p>reduce the scan time of larger archives. Depending on the size and storage
type of the archive it may take some time to just list available chunks and
their mtime.</p></li>
<li><p>prevent deletion of availability information even though parts of the
archive have been deleted or moved to a different location</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Modification</span> <span class="pre">window</span></code> the mtime of a chunk is compared with this time
window to decide whether it needs to be read or not. It is configured via
<a class="reference internal" href="#confval-mtime.start"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mtime.start</span></code></a> and <a class="reference internal" href="#confval-mtime.end"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mtime.end</span></code></a> repectively
<code class="xref std std-option docutils literal notranslate"><span class="pre">--modified-since</span></code> and <code class="xref std std-option docutils literal notranslate"><span class="pre">--modified-until</span></code>. If no lower bound
is defined then the <code class="docutils literal notranslate"><span class="pre">lastScan</span></code> time stored in the <cite>DataExtent</cite> is used
instead. The mtime check may be disabled using <a class="reference internal" href="#confval-mtime.ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mtime.ignore</span></code></a> or
<code class="xref std std-option docutils literal notranslate"><span class="pre">--deep-scan</span></code>.
<strong>Note:</strong> Chunks in front or right after a chunk gap are read in any case
regardless of the mtime settings.</p></li>
</ul>
</section>
<section id="workflow">
<h3>Workflow<a class="headerlink" href="#workflow" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Read existing <cite>DataExtents</cite> from database.</p></li>
<li><p>Collect a list of available stream IDs either by</p>
<ul class="simple">
<li><p>scanning the archive for available IDs or</p></li>
<li><p>reading an ID file defined by <a class="reference internal" href="#confval-nslcFile"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nslcFile</span></code></a>.</p></li>
</ul>
</li>
<li><p>Identify extents to add, update or remove respecting <cite>scan window</cite>,
<a class="reference internal" href="#confval-filter.nslc.include"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.nslc.include</span></code></a> and <a class="reference internal" href="#confval-filter.nslc.exclude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.nslc.exclude</span></code></a>.</p></li>
<li><p>Subsequently process the <cite>DataExtents</cite> using <a class="reference internal" href="#confval-threads"><code class="xref std std-confval docutils literal notranslate"><span class="pre">threads</span></code></a> number of
parallel threads. For each <cite>DataExtent</cite>:</p>
<ol class="arabic">
<li><p>Collect all available chunks within <cite>scan window</cite>.</p></li>
<li><p>If the <cite>DataExtent</cite> is new (no database entry yet), store a new and
empty <cite>DataExtent</cite> to database, else query existing <cite>DataSegments</cite> from
the database:</p>
<ul class="simple">
<li><p>count segments outside <cite>scan window</cite></p></li>
<li><p>create a database iterator for extents within <cite>scan window</cite></p></li>
</ul>
</li>
<li><p>Create two in-memory segment lists which collect segments to remove and
segments to add/update</p></li>
<li><p>For each chunk</p>
<ul>
<li><p>determine the <cite>chunk window</cite> and <cite>mtime</cite></p></li>
<li><p>decide whether the chunk needs to be read depending on the <cite>mtime</cite>
and a possible <cite>chunk gap</cite>. If necessary, read the chunk and</p>
<ul class="simple">
<li><p>create chunk segments by analyzing the chunk records for
gaps/overlaps defined by <a class="reference internal" href="#confval-jitter"><code class="xref std std-confval docutils literal notranslate"><span class="pre">jitter</span></code></a>, sampling rate or quality
changes</p></li>
<li><p>merge chunk segments with database segments and update the in-memory
segment lists.</p></li>
</ul>
<p>If not necessary, advance the database segment iterator to the end
of the chunk window.</p>
</li>
</ul>
</li>
<li><p>Remove and then add/update the collected segments.</p></li>
<li><p>Merge segment information into <cite>DataAttributeExtents</cite></p></li>
<li><p>Merge <cite>DataAttributeExtents</cite> into overall <cite>DataExtent</cite></p></li>
</ol>
</li>
</ol>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Get command line help or execute scardac with default parameters and informative
debug output:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scardac<span class="w"> </span>-h
scardac<span class="w"> </span>--debug
</pre></div>
</div>
</li>
<li><p>Synchronize the availability of waveform data files existing in the standard
<a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive with the seiscomp database and create an XML file using
<a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scardac<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-a<span class="w"> </span><span class="nv">$SEISCOMP_ROOT</span>/var/lib/archive<span class="w"> </span>--debug
scxmldump<span class="w"> </span>-Yf<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-o<span class="w"> </span>availability.xml
</pre></div>
</div>
</li>
<li><p>Synchronize the availability of waveform data files existing in the standard
<a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive with the seiscomp database. Use <a class="reference internal" href="fdsnws.html#fdsnws"><span class="std std-ref">fdsnws</span></a> to fetch a flat file containing a list
of periods of available data from stations of the CX network sharing the same
quality and sampling rate attributes:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scardac<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-a<span class="w"> </span><span class="nv">$SEISCOMP_ROOT</span>/var/lib/archive
wget<span class="w"> </span>-O<span class="w"> </span>availability.txt<span class="w"> </span><span class="s1">&#39;http://localhost:8080/fdsnws/ext/availability/1/query?network=CX&#39;</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <cite>SeisComP</cite> module <a class="reference internal" href="fdsnws.html#fdsnws"><span class="std std-ref">fdsnws</span></a> must be running for executing this
example.</p>
</div>
</li>
</ol>
</section>
</section>
<section id="module-configuration">
<span id="scardac-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scardac.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scardac.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scardac.cfg</span></code></div>
</div>
<p>scardac inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-archive">
<span class="sig-name descname"><span class="pre">archive</span></span><a class="headerlink" href="#confval-archive" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;SEISCOMP_ROOT&#64;/var/lib/archive</span></code></p>
<p>Type: <em>string</em></p>
<p>The URL to the waveform archive where all data is stored.</p>
<p>Format: [<a class="reference external" href="service://">service://</a>]location[#type]</p>
<p>&quot;service&quot;: The type of the archive. If not given,
&quot;sds://&quot; is implied assuming an SDS archive. The SDS
archive structure is defined as
YEAR/NET/STA/CHA/NET.STA.LOC.CHA.YEAR.DAYFYEAR, e.g.
2018/GE/APE/BHZ.D/GE.APE..BHZ.D.2018.125</p>
<p>Other archive types may be considered by plugins.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-threads">
<span class="sig-name descname"><span class="pre">threads</span></span><a class="headerlink" href="#confval-threads" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of threads scanning the archive in parallel.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-jitter">
<span class="sig-name descname"><span class="pre">jitter</span></span><a class="headerlink" href="#confval-jitter" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code></p>
<p>Type: <em>float</em></p>
<p>Acceptable derivation of end time and start time of successive
records in multiples of sample time.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-maxSegments">
<span class="sig-name descname"><span class="pre">maxSegments</span></span><a class="headerlink" href="#confval-maxSegments" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000000</span></code></p>
<p>Type: <em>int</em></p>
<p>Maximum number of segments per stream. If the limit is reached
no more segments are added to the database and the corresponding
extent is flagged as too fragmented. Set this parameter to 0 to
disable any limits.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-nslcFile">
<span class="sig-name descname"><span class="pre">nslcFile</span></span><a class="headerlink" href="#confval-nslcFile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Line-based text file of form NET.STA.LOC.CHA defining available
stream IDs. Depending on the archive type, size and storage
media used this file may offer a significant performance
improvement compared to collecting the available streams on each
startup. Filters defined under <cite>filter.nslc</cite> still apply.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.*</strong>
<em>Parameters of this section limit the data processing to either</em>
**
<em>reduce the scan time of larger archives or to</em>
**
<em>prevent deletion of availability information even though parts</em>
<em>of the archive have been deleted or moved to a different</em>
<em>location.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.time.*</strong>
<em>Limit the processing by record time.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.time.start">
<span class="sig-name descname"><span class="pre">filter.time.start</span></span><a class="headerlink" href="#confval-filter.time.start" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Start of data availability check given as date string or
as number of days before now.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.time.end">
<span class="sig-name descname"><span class="pre">filter.time.end</span></span><a class="headerlink" href="#confval-filter.time.end" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>End of data availability check given as date string or
as number of days before now.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.nslc.*</strong>
<em>Limit the processing by stream IDs.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.nslc.include">
<span class="sig-name descname"><span class="pre">filter.nslc.include</span></span><a class="headerlink" href="#confval-filter.nslc.include" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Comma-separated list of stream IDs to process. If
empty all streams are accepted unless an exclude filter
is defined. The following wildcards are supported: *
and ?.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.nslc.exclude">
<span class="sig-name descname"><span class="pre">filter.nslc.exclude</span></span><a class="headerlink" href="#confval-filter.nslc.exclude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Comma-separated list of stream IDs to exclude from
processing. Excludes take precedence over includes. The
following wildcards are supported: * and ?.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>mtime.*</strong>
<em>Parameters of this section control the rescan of data chunks.</em>
<em>By default the last update time of the extent is compared with</em>
<em>the record file modification time to read only files modified</em>
<em>since the list run.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mtime.ignore">
<span class="sig-name descname"><span class="pre">mtime.ignore</span></span><a class="headerlink" href="#confval-mtime.ignore" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If set to true all data chunks are read independent of their
mtime.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mtime.start">
<span class="sig-name descname"><span class="pre">mtime.start</span></span><a class="headerlink" href="#confval-mtime.start" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Only read chunks modified after specific date given as date
string or as number of days before now.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mtime.end">
<span class="sig-name descname"><span class="pre">mtime.end</span></span><a class="headerlink" href="#confval-mtime.end" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Only read chunks modified before specific date given as date
string or as number of days before now.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scardac [OPTION]...</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-h">
<span id="cmdoption-scardac-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-V">
<span id="cmdoption-scardac-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-v">
<span id="cmdoption-scardac-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-q">
<span id="cmdoption-scardac-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-s">
<span id="cmdoption-scardac-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-l">
<span id="cmdoption-scardac-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="collector">
<h3>Collector<a class="headerlink" href="#collector" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-a">
<span id="cmdoption-scardac-archive"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--archive</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-a" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="slarchive.html#confval-archive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">archive</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-threads">
<span class="sig-name descname"><span class="pre">--threads</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-threads" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-threads"><code class="xref std std-confval docutils literal notranslate"><span class="pre">threads</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-j">
<span id="cmdoption-scardac-jitter"></span><span class="sig-name descname"><span class="pre">-j</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--jitter</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-j" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-jitter"><code class="xref std std-confval docutils literal notranslate"><span class="pre">jitter</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-nslc">
<span class="sig-name descname"><span class="pre">--nslc</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-nslc" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-nslcFile"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nslcFile</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-start">
<span class="sig-name descname"><span class="pre">--start</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-start" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-filter.time.start"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.time.start</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-end">
<span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-end" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-filter.time.end"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.time.end</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-include">
<span class="sig-name descname"><span class="pre">--include</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-include" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-filter.nslc.include"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.nslc.include</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-exclude">
<span class="sig-name descname"><span class="pre">--exclude</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-exclude" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-filter.nslc.exclude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter.nslc.exclude</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-deep-scan">
<span class="sig-name descname"><span class="pre">--deep-scan</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scardac-deep-scan" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-mtime.ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mtime.ignore</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-modified-since">
<span class="sig-name descname"><span class="pre">--modified-since</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-modified-since" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-mtime.start"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mtime.start</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-modified-until">
<span class="sig-name descname"><span class="pre">--modified-until</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-modified-until" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-mtime.end"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mtime.end</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scardac-generate-test-data">
<span class="sig-name descname"><span class="pre">--generate-test-data</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scardac-generate-test-data" title="Permalink to this definition"></a></dt>
<dd><p>Do not scan the archive but generate test data for each
stream in the inventory. Format:
days,gaps,gapslen,overlaps,overlaplen. E.g., the following
parameter list would generate test data for 100 days
(starting from now()-100) which includes 150 gaps with a
length of 2.5s followed by 50 overlaps with an overlap of
5s: --generate-test-data=100,150,2.5,50,5</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scardac</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#non-sds-archives">Non-SDS archives</a></li>
<li><a class="reference internal" href="#definitions">Definitions</a></li>
<li><a class="reference internal" href="#workflow">Workflow</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#collector">Collector</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="msrtsimul.html"
title="previous chapter">msrtsimul</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scwfas.html"
title="next chapter">scwfas</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scardac.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,532 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scart &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scbulletin" href="scbulletin.html" />
<link rel="prev" title="scalert" href="scalert.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">6.9.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="scbulletin.html" title="scbulletin"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scalert.html" title="scalert"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scart">
<span id="id1"></span><h1>scart<a class="headerlink" href="#scart" title="Permalink to this heading"></a></h1>
<p><strong>Import/export MiniSEED data to/from SDS archives.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The archive tool scart reads and writes <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archives and files
in miniSEED format and checks miniSEED archives or prints stream information.</p>
<ul class="simple">
<li><p><strong>Dump mode:</strong> Create miniSEED files (multiplexed), e.g. for playbacks, from
<a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> structured data (e.g. created by slarchive).</p></li>
<li><p><strong>Dump mode:</strong> Play back records directly out of an SDS structure.</p></li>
<li><p><strong>Import mode:</strong> Import multiplexed miniSEED files into a local SDS waveform
archive.</p></li>
<li><p><strong>Import mode:</strong> Import data using the <a class="reference internal" href="global_recordstream.html#global-recordstream"><span class="std std-ref">RecordStream</span></a> interface
into a local SDS waveform archive.</p></li>
<li><p><strong>Import mode:</strong> Read data from any <a class="reference internal" href="global_recordstream.html#global-recordstream"><span class="std std-ref">RecordStream</span></a> interface
and dump it to file.</p></li>
<li><p><strong>Check mode:</strong> Check an archive of miniSEED files for out-of-order records in
files.</p></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<ul class="simple">
<li><p>When creating <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archives, scart simply appends the new records to
existing ones. Multiple imports of the same data result in duplication.</p></li>
<li><p>Out-of-order imports of waveforms into a SDS archive result in out-of-order
records which may not be processed. Clean your archive using <a class="reference internal" href="scmssort.html#scmssort"><span class="std std-ref">scmssort</span></a>.</p></li>
<li><p><strong>Before importing miniSEED data</strong> into an SDS archive they must be sorted
by time and duplicate records must be removed. Otherwise, the SDS archive
may not be correctly readable by other modules. Therefore, combine scart
with <a class="reference internal" href="scmssort.html#scmssort"><span class="std std-ref">scmssort</span></a> for multiplexing and removal of duplicates.</p></li>
</ul>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>In dump and import mode output streams may be filtered by</p>
<ul class="simple">
<li><p>Time windows (<code class="xref std std-option docutils literal notranslate"><span class="pre">-t</span></code>),</p></li>
<li><p>Network-station-location-channel (NSLC) lists (<code class="xref std std-option docutils literal notranslate"><span class="pre">--nslc</span></code>) created,
e.g., with</p>
<ul>
<li><p><a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a> from inventories,</p></li>
<li><p><a class="reference internal" href="scdumpcfg.html#scdumpcfg"><span class="std std-ref">scdumpcfg</span></a> from bindings configuration,</p></li>
<li><p>scart itself from other miniSEED files or achives.</p></li>
</ul>
</li>
</ul>
<p>In dump mode output streams may also be filtered by</p>
<ul class="simple">
<li><p>Time window - stream lists (<code class="xref std std-option docutils literal notranslate"><span class="pre">--list</span></code>, dump mode) generated by
<a class="reference internal" href="scevtstreams.html#scevtstreams"><span class="std std-ref">scevtstreams</span></a> for particular events.</p></li>
</ul>
<p>Time strings may be given in
* ISO time format, e.g., 2023-03-28T15:48:00
* or the old SeisComP time format with empty character between date and time, e.g.,
2023-03-28 15:48:00.</p>
<p>When omitting seconds, minutes or hours values of zero are implied.</p>
</div>
</section>
<section id="configuration">
<span id="scart-config"></span><h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h2>
<p>scart can make use of <a class="reference internal" href="global_recordstream.html#global-recordstream"><span class="std std-ref">RecordStream</span></a> implementations which are
provided by additional plugins. For loading additional plugins, e.g. the <em>xyz</em>
plugin create and configure <code class="file docutils literal notranslate"><span class="pre">scart.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>xyz
</pre></div>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The usage of wildcards in place of network, station, location or channel code
is allowed in many options (<code class="xref std std-option docutils literal notranslate"><span class="pre">-n</span></code>, <code class="xref std std-option docutils literal notranslate"><span class="pre">-c</span></code>, <code class="xref std std-option docutils literal notranslate"><span class="pre">-l</span></code>,
<code class="xref std std-option docutils literal notranslate"><span class="pre">--list</span></code>, <code class="xref std std-option docutils literal notranslate"><span class="pre">--nslc</span></code>) and follows these rules:</p>
<ul class="simple">
<li><p>Import mode: the wildcards are passed to the <a class="reference internal" href="global_recordstream.html#global-recordstream"><span class="std std-ref">RecordStream</span></a> interface,
that interprets them. Normally both “*” and “?” are supported by RecordStreams.</p></li>
<li><p>Dump mode: the wildcards are interpreted by scart command that supports “*” for
network, station, location codes and “*”, “?”, “(”, “)”, “|” for channel code.</p></li>
</ul>
</div>
<ol class="arabic">
<li><p>Extract data from the default <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive in <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/var/lib/archive</span></code>
or from a local <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive [SDS archive] into a miniSEED file <code class="file docutils literal notranslate"><span class="pre">file.mseed</span></code>
and sort by end time of the records:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span><span class="w"> </span>&gt;<span class="w"> </span><span class="o">[</span>file.mseed<span class="o">]</span>
scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>file.mseed
scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;[NET1],[NET2]&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>file.mseed
scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;[NET]&#39;</span><span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;(E,H)H(1,2,3)&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>file.mseed
scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;[N1.S1.L1.C1],[N2.S2.L2.C2]&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>file.mseed
scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>--nslc<span class="w"> </span>list.file<span class="w"> </span>&gt;<span class="w"> </span>file.mseed
scart<span class="w"> </span>-dsvE<span class="w"> </span>-t<span class="w"> </span>--list<span class="w"> </span>list.file<span class="w"> </span>&gt;<span class="w"> </span>file.mseed
</pre></div>
</div>
<p>It is possible to achieve the same result of the dump mode using a
combination of the input mode and the <a class="reference internal" href="scmssort.html#scmssort"><span class="std std-ref">scmssort</span></a> command, which allows
to read the input data from any supported <a class="reference internal" href="global_recordstream.html#global-recordstream"><span class="std std-ref">RecordStream</span></a>,
not only an SDS archive:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scart<span class="w"> </span>-I<span class="w"> </span><span class="o">[</span>record-stream<span class="o">]</span><span class="w"> </span>--list<span class="w"> </span>list.file<span class="w"> </span>--stdout<span class="w"> </span><span class="p">|</span><span class="w"> </span>scmssort<span class="w"> </span>-u<span class="w"> </span>-E<span class="w"> </span>-v<span class="w"> </span>&gt;<span class="w"> </span>file.mseed
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Sorting data is computational expensive but required for waveform playbacks.</p>
</div>
</li>
<li><p>Push miniSEED data from file <code class="file docutils literal notranslate"><span class="pre">file.mseed</span></code> or standard input
(stdin) into a local <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive or a file. Additionally, you may
check if the records of archived files are correctly ordered, filter by time
and/or with NSLC list and print the output streams:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmssort<span class="w"> </span>-u<span class="w"> </span>-E<span class="w"> </span><span class="o">[</span>file.mseed<span class="o">]</span><span class="w"> </span>&gt;<span class="w"> </span>sorted.mseed
scart<span class="w"> </span>-I<span class="w"> </span>sorted.mseed<span class="w"> </span>--with-filecheck<span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
scart<span class="w"> </span>-I<span class="w"> </span><span class="o">[</span>file.mseed<span class="o">]</span><span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>--print-streams<span class="w"> </span>--nslc<span class="w"> </span>list.file<span class="w"> </span>-o<span class="w"> </span><span class="o">[</span>out.mseed<span class="o">]</span>
cat<span class="w"> </span>sorted.mseed<span class="w"> </span><span class="p">|</span><span class="w"> </span>scart<span class="w"> </span>-I<span class="w"> </span>-<span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
cat<span class="w"> </span>sorted.mseed<span class="w"> </span><span class="p">|</span><span class="w"> </span>scart<span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Collect data using the <a class="reference internal" href="global_recordstream.html#global-recordstream"><span class="std std-ref">RecordStream</span></a> interface (e.g. FDSNWS server)
and write to a miniSEED file or import it into a local <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive. The
data streams and the time spans can be defined in several ways. The data streams
(<code class="xref std std-option docutils literal notranslate"><span class="pre">--list</span></code>) can be automatically generated, e.g., by <a class="reference internal" href="scevtstreams.html#scevtstreams"><span class="std std-ref">scevtstreams</span></a>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scart<span class="w"> </span>-I<span class="w"> </span>fdsnws://<span class="o">[</span>server<span class="o">]</span>:80<span class="w"> </span>--list<span class="w"> </span>list.file<span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
scart<span class="w"> </span>-I<span class="w"> </span>fdsnws://<span class="o">[</span>server<span class="o">]</span>:80<span class="w"> </span>--list<span class="w"> </span>list.file<span class="w"> </span>-o<span class="w"> </span>file.mseed
scart<span class="w"> </span>-I<span class="w"> </span>fdsnws://<span class="o">[</span>server<span class="o">]</span>:80<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>--nslc<span class="w"> </span>list.file<span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
scart<span class="w"> </span>-I<span class="w"> </span>fdsnws://<span class="o">[</span>server<span class="o">]</span>:80<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;[NET1],[NET2]&#39;</span><span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
scart<span class="w"> </span>-I<span class="w"> </span>fdsnws://<span class="o">[</span>server<span class="o">]</span>:80<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;[NET]&#39;</span><span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;EH?&#39;</span><span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
scart<span class="w"> </span>-I<span class="w"> </span>fdsnws://<span class="o">[</span>server<span class="o">]</span>:80<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;[start-time]~[end-time]&#39;</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;[N1.S1.L1.C1],[N2.S2.L2.C2]&#39;</span><span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Check all files of an SDS archive or other directory structure for
miniSEED files with out-of-order records:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scart<span class="w"> </span>--check<span class="w"> </span><span class="o">[</span>archive<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Print stream information from miniSEED files in archives or from
<a class="reference internal" href="../base/glossary.html#term-RecordStream"><span class="xref std std-term">RecordStream</span></a> without actually writing miniSEED data. In dump and
import mode use the <code class="xref std std-option docutils literal notranslate"><span class="pre">--test</span></code> if miniSEED data shall be read but not
written.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scart<span class="w"> </span>--print-streams<span class="w"> </span>-I<span class="w"> </span><span class="o">[</span>miniSEED<span class="w"> </span>file<span class="o">]</span><span class="w"> </span>--test
scart<span class="w"> </span>--print-streams<span class="w"> </span>-d<span class="w"> </span>-t<span class="w"> </span><span class="o">[</span><span class="nb">time</span><span class="w"> </span>span<span class="o">]</span><span class="w"> </span>--test<span class="w"> </span><span class="o">[</span>SDS<span class="w"> </span>archive<span class="o">]</span>
scart<span class="w"> </span>--print-streams<span class="w"> </span>--check<span class="w"> </span><span class="o">[</span>archive<span class="o">]</span>
</pre></div>
</div>
<p>The output looks like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># streamID start end records samples samplingRate</span>
GE.RGN..BHZ<span class="w"> </span><span class="m">2022</span>-12-08T15:34:41.895Z<span class="w"> </span><span class="m">2022</span>-12-08T15:52:19.145Z<span class="w"> </span><span class="m">58</span><span class="w"> </span><span class="m">21145</span><span class="w"> </span><span class="m">20</span>.0
</pre></div>
</div>
<p>where the header and the text body are printed to stderr.</p>
</li>
</ol>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scart [options] {archive-dir}</strong></p>
<p>The last option has to be the archive directory when dump mode is enabled.
When no archive directory is explicitly given,
$SEISCOMP_ROOT/var/lib/archive or the current directory
is used depending on whether $SEISCOMP_ROOT has been set or not.
The default operation mode is import. That means that a multiplexed
MiniSEED file or another record source such as ArcLink is used to import
records into a SDS structure.</p>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-v">
<span id="cmdoption-scart-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-v" title="Permalink to this definition"></a></dt>
<dd><p>Verbose mode.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-h">
<span id="cmdoption-scart-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-h" title="Permalink to this definition"></a></dt>
<dd><p>Display a help message.</p>
</dd></dl>
</section>
<section id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-check">
<span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-check" title="Permalink to this definition"></a></dt>
<dd><p>Check mode. Check all files
in the given directory for erroneous miniSEED records.
All sub-directories are included. If no directory is given,
the default SDS archive is scanned. Checks are only complete
for files containing exactly one stream. More complete checks
are made with scmssort.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-d">
<span id="cmdoption-scart-dump"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dump</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-d" title="Permalink to this definition"></a></dt>
<dd><p>Set export (dump) mode. Records are retrieved from an archive and
written to standard output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-I">
<span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-I" title="Permalink to this definition"></a></dt>
<dd><p>Import mode (default): Specify the recordstream URL to read
the data from for archiving. When using any other
recordstream than file, a stream list file is needed.
Specifying - implies <a class="reference external" href="file://">file://</a>- (stdin). If no mode is
explicitly specified, -I <a class="reference external" href="file://">file://</a>- is assumed.</p>
</dd></dl>
</section>
<section id="processing">
<h3>Processing<a class="headerlink" href="#processing" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-c">
<span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"> <span class="pre">channels</span></span><a class="headerlink" href="#cmdoption-scart-c" title="Permalink to this definition"></a></dt>
<dd><p>Channel filter to be applied to the data streams.
Default for Dump: &quot;(B|E|H|M|S)(D|H|L|N)(E|F|N|Z|1|2|3)&quot;
Default for Import: &quot;*&quot;</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-E">
<span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-E" title="Permalink to this definition"></a></dt>
<dd><p>Dump mode: sort records according to their end time.
Default: start time.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-files">
<span class="sig-name descname"><span class="pre">--files</span></span><span class="sig-prename descclassname"> <span class="pre">count</span></span><a class="headerlink" href="#cmdoption-scart-files" title="Permalink to this definition"></a></dt>
<dd><p>Dump mode: Specify the number of file handles to cache.
Default: 100.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-i">
<span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-i" title="Permalink to this definition"></a></dt>
<dd><p>Ignore records without data samples.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-l">
<span id="cmdoption-scart-list"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--list</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-scart-l" title="Permalink to this definition"></a></dt>
<dd><p>Import, dump mode: Use a stream list file with time windows instead
of defined networks and channels (-n, -c and -t are ignored).
The list can be generated from events by scevtstreams. One
line per stream. Line format: starttime;endtime;streamID
The time format is the same as described in option -t.</p>
<p>Example:</p>
<p>2019-07-17 02:00:00;2019-07-17 02:10:00;GR.CLL..BH?</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-m">
<span id="cmdoption-scart-modify"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--modify</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-m" title="Permalink to this definition"></a></dt>
<dd><p>Dump mode: Modify the record time for real time playback.
The first record time is NOW. The relative time of
successive records to the first one are kept.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-n">
<span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"> <span class="pre">networks</span></span><a class="headerlink" href="#cmdoption-scart-n" title="Permalink to this definition"></a></dt>
<dd><p>Import, dump mode: Data stream selection as a comma separated list
&quot;stream1,stream2,streamX&quot; where each stream can be NET or NET.STA
or NET.STA.LOC or NET.STA.LOC.CHA.
If CHA is omitted, it defaults to the value of -c option.
Default: &quot;*&quot;</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-nslc">
<span class="sig-name descname"><span class="pre">--nslc</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-scart-nslc" title="Permalink to this definition"></a></dt>
<dd><p>Import, dump mode: Stream list file to be used instead of
defined networks and channels (-n and -c are ignored)
for filtering the data by the given streams. Dump mode:
Use in combination with -t! One line per stream, line
format: NET.STA.LOC.CHA</p>
<p>Example:</p>
<p>GR.CLL..BH?</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-rename">
<span class="sig-name descname"><span class="pre">--rename</span></span><span class="sig-prename descclassname"> <span class="pre">rule</span></span><a class="headerlink" href="#cmdoption-scart-rename" title="Permalink to this definition"></a></dt>
<dd><p>Import, dump mode: Rename stream data according to the provided
rule(s). A rule is &quot;[match-stream:]rename-stream&quot; and match-stream
is optional. match-stream and rename-stream are in the
&quot;NET.STA.LOC.CHA&quot; format. match-stream supports special
charactes &quot;?&quot; &quot;*&quot; &quot;|&quot; &quot;(&quot; &quot;)&quot;. rename-stream supports the
special character &quot;-&quot; that can be used in place of NET, STA,
LOC, CHA codes with the meaning of not renaming those.
&quot;-&quot; can also be used as the last character in CHA code.
Multiple rules can be provided as a comma separated list
or by providing multiple --rename options.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-s">
<span id="cmdoption-scart-sort"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sort</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-s" title="Permalink to this definition"></a></dt>
<dd><p>Dump mode: Sort records by [start-]time. To sort records by their
end time use -E.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-speed">
<span class="sig-name descname"><span class="pre">--speed</span></span><span class="sig-prename descclassname"> <span class="pre">value</span></span><a class="headerlink" href="#cmdoption-scart-speed" title="Permalink to this definition"></a></dt>
<dd><p>Dump mode: Specify the speed to dump the records. A value of 0 means
no delay otherwise speed is a multiplier of the real time difference
between the records. When feeding the records directly into the replay
pipe a value of 1 (real time) is recommended.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-t">
<span id="cmdoption-scart-time-window"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-window</span></span><span class="sig-prename descclassname"> <span class="pre">timeWindow</span></span><a class="headerlink" href="#cmdoption-scart-t" title="Permalink to this definition"></a></dt>
<dd><p>Import, dump mode: Specify the time window (as one properly
quoted string) to dump records for. Times are UTC and
separated by a tilde &quot;~&quot;. To dump one hour of
waveform data between 2008/01/01 00:00:00 and 2008/01/01
01:00:00 use
&lt;-t 2008-01-01T00:00:00~2008-01-01T01:00:00&gt;.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-o">
<span id="cmdoption-scart-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-o" title="Permalink to this definition"></a></dt>
<dd><p>Dump, Import mode: Write data to given file instead of creating
a SDS archive. Deactivates --stdout. Deactivated by --test.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-print-streams">
<span class="sig-name descname"><span class="pre">--print-streams</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-print-streams" title="Permalink to this definition"></a></dt>
<dd><p>Print stream information only and exit. Works in import, dump
and check mode. Output: NET.STA.LOC.CHA StartTime EndTime.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-stdout">
<span class="sig-name descname"><span class="pre">--stdout</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-stdout" title="Permalink to this definition"></a></dt>
<dd><p>Import mode: Write to stdout instead of creating a SDS archive.
Deactivated by --test and --output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-test" title="Permalink to this definition"></a></dt>
<dd><p>Test input only, deactivate all miniSEED output. This switch is
useful for debugging and printing stream information with
--print-streams.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-with-filecheck">
<span class="sig-name descname"><span class="pre">--with-filecheck</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-with-filecheck" title="Permalink to this definition"></a></dt>
<dd><p>Import mode: Check all accessed files. Unsorted or unreadable
files are reported to stderr. Checks are only complete
for files containing exactly one stream. More complete
checks are made with scmssort.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scart-with-filename">
<span class="sig-name descname"><span class="pre">--with-filename</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scart-with-filename" title="Permalink to this definition"></a></dt>
<dd><p>Import mode: Print all accessed files to stderr after import.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scart</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#processing">Processing</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scalert.html"
title="previous chapter">scalert</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scbulletin.html"
title="next chapter">scbulletin</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scart.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,543 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scbulletin &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scchkcfg" href="scchkcfg.html" />
<link rel="prev" title="scart" href="scart.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">6.9.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="scchkcfg.html" title="scchkcfg"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scart.html" title="scart"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scbulletin">
<span id="id1"></span><h1>scbulletin<a class="headerlink" href="#scbulletin" title="Permalink to this heading"></a></h1>
<p><strong>Create bulletins from SCML.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scbulletin transforms the parameters of events or origins either to various formats.
Currently supported output formats are:</p>
<ul class="simple">
<li><p>autoloc1,</p></li>
<li><p>autoloc3,</p></li>
<li><p>fdsnws,</p></li>
<li><p>kml.</p></li>
</ul>
</section>
<section id="input-modes">
<h2>Input Modes<a class="headerlink" href="#input-modes" title="Permalink to this heading"></a></h2>
<p>Two modes of parameter input are possible:</p>
<ol class="arabic simple">
<li><p>Dump mode: Fetch all necessary information from database directly. Either
choose one or more event or origin IDs. The database connection must be given
with <code class="xref std std-option docutils literal notranslate"><span class="pre">-o</span></code>.</p></li>
<li><p>Input mode: Provide all event and origin information in XML (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>)
format from file or stdin. You may filter further by event or origin ID.</p></li>
</ol>
<p>If event IDs are given, the preferred origin will be derived and used for printing
information.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Events and origins are referred to by their public IDs. They can be provided
by <a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a> and <a class="reference internal" href="scorgls.html#scorgls"><span class="std std-ref">scorgls</span></a>, respectively, from graphical tools like
<a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or by database queries supported by <a class="reference internal" href="scquery.html#scquery"><span class="std std-ref">scquery</span></a>. XML files
can be generated by <a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a> or from other formats by <a class="reference internal" href="sccnv.html#sccnv"><span class="std std-ref">sccnv</span></a>.</p>
</div>
</section>
<section id="output-modes">
<h2>Output Modes<a class="headerlink" href="#output-modes" title="Permalink to this heading"></a></h2>
<p>The generated content is written to stdout or, with option <code class="xref std std-option docutils literal notranslate"><span class="pre">-o</span></code> to a
file. Different output formats are available by command-line options:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code> for <strong>autoloc1</strong>: Print one bulletin per event.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-3</span></code> for <strong>autoloc3</strong>: Print one bulletin per event.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-3</span> <span class="pre">-x</span></code> for <strong>extended autoloc3</strong>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-4</span></code> or <code class="docutils literal notranslate"><span class="pre">--fdsnws</span></code> for FDSNWS event text: Print one line per event. Useful
for generating event catalogs. This option offers an alternative to generating
event catalogs by <a class="reference internal" href="fdsnws.html#sec-event"><span class="std std-ref">fdsnws-event</span></a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-5</span></code> or <code class="docutils literal notranslate"><span class="pre">--kml</span></code> for KML/GIS file format. The output can be viewed, e.g.,
in <em>Google Earth</em>.</p></li>
</ul>
<p>By default, the output precision of times or coordinates is optimized for events
at teleseismic or regional distances. Use the option <code class="xref std std-option docutils literal notranslate"><span class="pre">-e</span></code> for
<strong>enhanced</strong> output at higher precision: All times and distances are in units
of milliseconds and meters, respectively.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Create a bulletin from one or multiple event(s) in database</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scbulletin<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-E<span class="w"> </span>gfz2012abcd
scbulletin<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-E<span class="w"> </span>gfz2012abcd,gfz2022abcd
</pre></div>
</div>
</li>
<li><p>Convert XML file to bulletin</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scbulletin<span class="w"> </span>-i<span class="w"> </span>gfz2012abcd.xml
</pre></div>
</div>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cat<span class="w"> </span>gfz2012abcd.xml<span class="w"> </span><span class="p">|</span><span class="w"> </span>scbulletin
</pre></div>
</div>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scbulletin<span class="w"> </span>&lt;<span class="w"> </span>gfz2012abcd.xml
</pre></div>
</div>
</li>
<li><p>Convert XML file to bulletin but filter by event ID(s)</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scbulletin<span class="w"> </span>-i<span class="w"> </span>gfz2012abcd.xml<span class="w"> </span>-E<span class="w"> </span>gempa2022abcd
scbulletin<span class="w"> </span>-i<span class="w"> </span>gfz2012abcd.xml<span class="w"> </span>-E<span class="w"> </span>gempa2022abcd,gfz2022abcd
</pre></div>
</div>
</li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When considering a single event XML file containing many events, the
bulletins of all events will be generated unless <code class="docutils literal notranslate"><span class="pre">--first-only</span></code> is used.</p>
</div>
</section>
<section id="module-configuration">
<span id="scbulletin-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scbulletin.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scbulletin.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scbulletin.cfg</span></code></div>
</div>
<p>scbulletin inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scbulletin [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-h">
<span id="cmdoption-scbulletin-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-V">
<span id="cmdoption-scbulletin-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-D">
<span id="cmdoption-scbulletin-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-v">
<span id="cmdoption-scbulletin-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-q">
<span id="cmdoption-scbulletin-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-s">
<span id="cmdoption-scbulletin-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-l">
<span id="cmdoption-scbulletin-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-d">
<span id="cmdoption-scbulletin-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-f">
<span id="cmdoption-scbulletin-format"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--format</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-f" title="Permalink to this definition"></a></dt>
<dd><p>Input format to use (xml [default], zxml (zipped xml), binary).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-i">
<span id="cmdoption-scbulletin-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-i" title="Permalink to this definition"></a></dt>
<dd><p>The input file. Default is stdin.</p>
</dd></dl>
</section>
<section id="dump">
<h3>Dump<a class="headerlink" href="#dump" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-E">
<span id="cmdoption-scbulletin-event"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--event</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-E" title="Permalink to this definition"></a></dt>
<dd><p>ID of event(s) that is read from database and transformed into
a bulletin. Separate multiple IDs by comma.&quot;</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-O">
<span id="cmdoption-scbulletin-origin"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--origin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-O" title="Permalink to this definition"></a></dt>
<dd><p>ID of origin(s) that is read from database and transformed into
a bulletin. Separate multiple IDs by comma.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-event-agency-id">
<span class="sig-name descname"><span class="pre">--event-agency-id</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-event-agency-id" title="Permalink to this definition"></a></dt>
<dd><p>Use the agency ID of the event instead of the preferred origin.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-first-only">
<span class="sig-name descname"><span class="pre">--first-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-first-only" title="Permalink to this definition"></a></dt>
<dd><p>Convert only the first event/origin to bulletin. Otherwise
all events or origins will be converted to single bulletins
which will be concatenated.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-p">
<span id="cmdoption-scbulletin-polarities"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--polarities</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-p" title="Permalink to this definition"></a></dt>
<dd><p>Dump onset polarities.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-w">
<span id="cmdoption-scbulletin-weight"></span><span class="sig-name descname"><span class="pre">-w</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--weight</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scbulletin-w" title="Permalink to this definition"></a></dt>
<dd><p>Weight threshold for printed and counted picks.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-x">
<span id="cmdoption-scbulletin-extra"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--extra</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-x" title="Permalink to this definition"></a></dt>
<dd><p>Use a specially detailed autoloc3 format. This options works only
in combination with the autoloc3-flag.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-1">
<span id="cmdoption-scbulletin-autoloc1"></span><span class="sig-name descname"><span class="pre">-1</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--autoloc1</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-1" title="Permalink to this definition"></a></dt>
<dd><p>Format: Use autoloc1 format for output. This is default.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-3">
<span id="cmdoption-scbulletin-autoloc3"></span><span class="sig-name descname"><span class="pre">-3</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--autoloc3</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-3" title="Permalink to this definition"></a></dt>
<dd><p>Format: Use autoloc3 format for output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-4">
<span id="cmdoption-scbulletin-fdsnws"></span><span class="sig-name descname"><span class="pre">-4</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--fdsnws</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-4" title="Permalink to this definition"></a></dt>
<dd><p>Format: FDSNWS event text, e.g., for generating catalogs.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-5">
<span id="cmdoption-scbulletin-kml"></span><span class="sig-name descname"><span class="pre">-5</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--kml</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-5" title="Permalink to this definition"></a></dt>
<dd><p>Format: KML. GIS file format.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-e">
<span id="cmdoption-scbulletin-enhanced"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--enhanced</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-e" title="Permalink to this definition"></a></dt>
<dd><p>Enhanced output with higher precision. Times: milliseconds,
distances: meter. Use for bulletins of local earthquakes.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-k">
<span id="cmdoption-scbulletin-dist-in-km"></span><span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dist-in-km</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-k" title="Permalink to this definition"></a></dt>
<dd><p>Print distances in km instead of degree.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-o">
<span id="cmdoption-scbulletin-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-o" title="Permalink to this definition"></a></dt>
<dd><p>Name of output file. If not given, all event parameters are
printed to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scbulletin-0">
<span id="cmdoption-scbulletin-2"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--extra</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scbulletin-0" title="Permalink to this definition"></a></dt>
<dd><p>Use a specially detailed autoloc3 format. This options works
only in combination with the autoloc3-flag.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scbulletin</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#input-modes">Input Modes</a></li>
<li><a class="reference internal" href="#output-modes">Output Modes</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#dump">Dump</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scart.html"
title="previous chapter">scart</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scchkcfg.html"
title="next chapter">scchkcfg</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scbulletin.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scchkcfg &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="sccnv" href="sccnv.html" />
<link rel="prev" title="scbulletin" href="scbulletin.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">6.9.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="sccnv.html" title="sccnv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scbulletin.html" title="scbulletin"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scchkcfg">
<span id="id1"></span><h1>scchkcfg<a class="headerlink" href="#scchkcfg" title="Permalink to this heading"></a></h1>
<p><strong>Checks a module configuration.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scchkcfg checks for case-sensitivity issues of parameter names of the module
configuration file for a module. It reads all defined configuration stages
(see <a class="reference internal" href="global.html#global-modules"><span class="std std-ref">Modules</span></a>) and checks for each parameter read if it exists
again with a different spelling.</p>
<p>If <em>standalone</em> is not given, it checks all 6 configurations
files (including <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code>), 3 otherwise.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scchkcfg<span class="w"> </span>scautopick
Read<span class="w"> </span>configuration<span class="w"> </span>files<span class="w"> </span>OK
No<span class="w"> </span>possible<span class="w"> </span>conflict<span class="w"> </span>detected
</pre></div>
</div>
<p>scchkcfg checks only for possible conflicts since it does not know what parameters
a module will read eventually.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scchkcfg<span class="w"> </span>scautopick
Read<span class="w"> </span>configuration<span class="w"> </span>files<span class="w"> </span>OK
Conflict<span class="w"> </span><span class="c1">#1</span>
<span class="w"> </span>connection.server<span class="w"> </span>/home/sysop/seiscomp/etc/global.cfg:8
<span class="w"> </span>connection.Server<span class="w"> </span>/home/sysop/.seiscomp/scautopick.cfg:1
<span class="m">1</span><span class="w"> </span>conflict<span class="w"> </span>detected
</pre></div>
</div>
<p>In this case everything is ok and the conflict needs to be fixed.
<code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.Server</span></code> is not a valid parameter name
(but <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a> is) in
<code class="file docutils literal notranslate"><span class="pre">/home/sysop/.seiscomp/scautopick.cfg</span></code> and thus will not be used.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scchkcfg<span class="w"> </span>scautopick
Read<span class="w"> </span>configuration<span class="w"> </span>files<span class="w"> </span>OK
Conflict<span class="w"> </span><span class="c1">#1</span>
<span class="w"> </span>module.trunk.global.amplitudes.mb.signalEnd<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>/home/sysop/.seiscomp/scautopick.cfg:1
<span class="w"> </span>module.trunk.global.amplitudes.mB.signalEnd<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>/home/sysop/.seiscomp/scautopick.cfg:2
<span class="m">1</span><span class="w"> </span>conflict<span class="w"> </span>detected
</pre></div>
</div>
<p>In this case the configuration is OK and this is an example why the case-sensitivity
has changed from previous versions: mb != mB. scchkcfg detects a possible
conflicts but does not know that this case is well defined. But it helps the user to
decide whether it needs a fix or not.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scchkcfg {mod-name} [standalone]</strong></p>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scchkcfg</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scbulletin.html"
title="previous chapter">scbulletin</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="sccnv.html"
title="next chapter">sccnv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scchkcfg.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,384 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>sccnv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scdb" href="scdb.html" />
<link rel="prev" title="scchkcfg" href="scchkcfg.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">6.9.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="scdb.html" title="scdb"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scchkcfg.html" title="scchkcfg"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="sccnv">
<span id="id1"></span><h1>sccnv<a class="headerlink" href="#sccnv" title="Permalink to this heading"></a></h1>
<p><strong>Converts data in different formats.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>sccnv reads input given in a supported format, converts the content to another
format and writes the output. Use the command-line option <code class="xref std std-confval docutils literal notranslate"><span class="pre">format-list</span></code>
for a list of supported formats.</p>
</section>
<section id="formats">
<h2>Formats<a class="headerlink" href="#formats" title="Permalink to this heading"></a></h2>
<p>Different formats are supported for input and output files.</p>
<table class="docutils align-left">
<colgroup>
<col style="width: 11.1%" />
<col style="width: 66.7%" />
<col style="width: 11.1%" />
<col style="width: 11.1%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Description</p></th>
<th class="head"><p>Input</p></th>
<th class="head"><p>Output</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>arclink</p></td>
<td><p><a class="reference external" href="https://www.seiscomp.de/seiscomp3/doc/applications/arclink-status-xml.html">Arclink XML</a></p></td>
<td><p>X</p></td>
<td><p>X</p></td>
</tr>
<tr class="row-odd"><td><p>bson</p></td>
<td></td>
<td><p>X</p></td>
<td><p>X</p></td>
</tr>
<tr class="row-even"><td><p>bson-json</p></td>
<td></td>
<td></td>
<td><p>X</p></td>
</tr>
<tr class="row-odd"><td><p>csv</p></td>
<td><p>comma-separated values</p></td>
<td></td>
<td><p>X</p></td>
</tr>
<tr class="row-even"><td><p>hyp71sum2k</p></td>
<td><p>Hypo71 format</p></td>
<td></td>
<td><p>X</p></td>
</tr>
<tr class="row-odd"><td><p>ims10</p></td>
<td></td>
<td></td>
<td><p>X</p></td>
</tr>
<tr class="row-even"><td><p>json</p></td>
<td><p><a class="reference external" href="https://www.json.org/">JSON</a> format</p></td>
<td><p>X</p></td>
<td><p>X</p></td>
</tr>
<tr class="row-odd"><td><p>qml1.2</p></td>
<td><p><a class="reference internal" href="../base/glossary.html#term-QuakeML"><span class="xref std std-term">QuakeML</span></a> format</p></td>
<td><p>*</p></td>
<td><p>X</p></td>
</tr>
<tr class="row-even"><td><p>qml1.2rt</p></td>
<td><p><a class="reference internal" href="../base/glossary.html#term-QuakeML"><span class="xref std std-term">QuakeML</span></a> real time (RT) format</p></td>
<td><p>*</p></td>
<td><p>X</p></td>
</tr>
<tr class="row-odd"><td><p>scdm0.51</p></td>
<td></td>
<td><p>X</p></td>
<td><p>X</p></td>
</tr>
<tr class="row-even"><td><p>trunk</p></td>
<td><p>SeisComP XML (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>) - <a class="reference internal" href="../base/api-python.html#api-datamodel-python"><span class="std std-ref">SCML API</span></a></p></td>
<td><p>X</p></td>
<td><p>X</p></td>
</tr>
</tbody>
</table>
<p><strong>*</strong>: The conversion from files in QuakeML format is not supported by sccnv
but can be realized by system tools. Read section <a class="reference internal" href="#sec-sccnv-quakeml"><span class="std std-ref">QuakeML</span></a> for
details and instructions.</p>
<section id="quakeml">
<span id="sec-sccnv-quakeml"></span><h3>QuakeML<a class="headerlink" href="#quakeml" title="Permalink to this heading"></a></h3>
<p><a class="reference internal" href="../base/glossary.html#term-QuakeML"><span class="xref std std-term">QuakeML</span></a> is used in a variety of flavors involving, e.g.,</p>
<ul class="simple">
<li><p>Using non-standard objects,</p></li>
<li><p>PublicID references which are not globally unique,</p></li>
<li><p>Missing references to parent objects,</p></li>
<li><p>Missing creationInfo parameters.</p></li>
</ul>
<p>The ability to convert from QuakeML to <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> is thus limited and it
depends on the parameters provided with the input QuakeML file.</p>
<p>However, XSLT stylesheets are provided for mapping the parameters. The files
are located in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/xml/[version]/</span></code> for different <cite>SeisComP</cite> data schema
versions. The stylesheet files provide information on the mapping and on
limitations as well as examples on their application.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You may find out about the <cite>SeisComP</cite> data schema version using modules along
with the command-line option <cite>-V</cite>, e.g.,</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sccnv<span class="w"> </span>-V
</pre></div>
</div>
</div>
<p>The style sheets can be used along with other stylesheet converter tools provided
by your system, e.g., <strong class="program">xalan</strong> or <strong class="program">xsltproc</strong>. Examples are given
in section <a class="reference internal" href="#sec-sccnv-examples"><span class="std std-ref">Examples</span></a>.</p>
</section>
</section>
<section id="examples">
<span id="sec-sccnv-examples"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Print the list of supported formats:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sccnv<span class="w"> </span>--format-list
</pre></div>
</div>
</li>
<li><p>Convert an event parameter file in <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> format to <a class="reference internal" href="../base/glossary.html#term-QuakeML"><span class="xref std std-term">QuakeML</span></a> and
store the content in a file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sccnv<span class="w"> </span>-i<span class="w"> </span>seiscomp.xml<span class="w"> </span>-o<span class="w"> </span>qml1.2:quakeml.xml
</pre></div>
</div>
</li>
<li><p>Convert an inventory file in Arclink XML format to <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> and store the
content in a file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sccnv<span class="w"> </span>-i<span class="w"> </span>arclink:Package_inventory.xml<span class="w"> </span>-o<span class="w"> </span>inventory.sc.xml
</pre></div>
</div>
</li>
<li><p>Convert an event parameter file in <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> format to ims1.0 and store the
content in a file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sccnv<span class="w"> </span>-i<span class="w"> </span>trunk:event.xml<span class="w"> </span>-o<span class="w"> </span>ims10:event.ims
</pre></div>
</div>
</li>
<li><p>Convert QuakeML in version 1.2 to SCML in data schema version 0.12:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>xsltproc<span class="w"> </span><span class="nv">$SEISCOMP_ROOT</span>/share/xml/0.12/quakeml_1.2__sc3ml_0.12.xsl<span class="w"> </span>file.quakeml<span class="w"> </span>&gt;<span class="w"> </span>file_sc.xml
</pre></div>
</div>
</li>
</ul>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">sccnv -i format:file -o format:file</strong></p>
<p>sccnv reads the input given in a supported format, converts the content
and writes the output in another format. Use the option <cite>format-list</cite>
for a list of supported formats.</p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-h">
<span id="cmdoption-sccnv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sccnv-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-V">
<span id="cmdoption-sccnv-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sccnv-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-v">
<span id="cmdoption-sccnv-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sccnv-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sccnv-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
</section>
<section id="id2">
<h3>Formats<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-format-list">
<span class="sig-name descname"><span class="pre">--format-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sccnv-format-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported formats</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-i">
<span id="cmdoption-sccnv-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sccnv-i" title="Permalink to this definition"></a></dt>
<dd><p>Input stream [format:][file], default: trunk:-</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-o">
<span id="cmdoption-sccnv-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sccnv-o" title="Permalink to this definition"></a></dt>
<dd><p>Output stream [format:][file], default trunk:-</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-f">
<span id="cmdoption-sccnv-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sccnv-f" title="Permalink to this definition"></a></dt>
<dd><p>Use formatted output</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sccnv-indent">
<span class="sig-name descname"><span class="pre">--indent</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sccnv-indent" title="Permalink to this definition"></a></dt>
<dd><p>Formatted line indent. Default: 2</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">sccnv</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#formats">Formats</a><ul>
<li><a class="reference internal" href="#quakeml">QuakeML</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#id2">Formats</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scchkcfg.html"
title="previous chapter">scchkcfg</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scdb.html"
title="next chapter">scdb</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/sccnv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,565 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scconfig &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scesv" href="scesv.html" />
<link rel="prev" title="Graphical User Interfaces" href="../gui.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">6.9.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="scesv.html" title="scesv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../gui.html" title="Graphical User Interfaces"
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scconfig">
<span id="id1"></span><h1>scconfig<a class="headerlink" href="#scconfig" title="Permalink to this heading"></a></h1>
<p><strong>Configuration and system management frontend.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scconfig is a graphical user interface which allows to</p>
<ul class="simple">
<li><p>Retrieve <a class="reference internal" href="#scconfig-information"><span class="std std-ref">information</span></a> about the installed <cite>SeisComP</cite>
system,</p></li>
<li><p><a class="reference internal" href="#scconfig-system"><span class="std std-ref">Control modules</span></a> (start/stop/check/enable/disable) and
access logging file,</p></li>
<li><p><a class="reference internal" href="#scconfig-inventory"><span class="std std-ref">Import, check, synchronize and remove</span></a> station meta
data/inventory,</p></li>
<li><p>Configure the <a class="reference internal" href="#scconfig-modules"><span class="std std-ref">module configuration</span></a> and
<a class="reference internal" href="#scconfig-bindings"><span class="std std-ref">bindings</span></a> all SeisComP modules for which descriptions
are provided,</p></li>
<li><p>Access the <a class="reference internal" href="#scconfig-documentation"><span class="std std-ref">documentation and the changelog</span></a>.</p></li>
</ul>
<p>The modules are usually programs part of the SeisComP system and have two
distinct types of configuration:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#scconfig-modules"><span class="std std-ref">Modules configuration</span></a>, or just program
configuration stored in file like <code class="file docutils literal notranslate"><span class="pre">scautopick.cfg</span></code>.</p></li>
<li><p><a class="reference internal" href="#scconfig-modules"><span class="std std-ref">Bindings</span></a>, that are set of parameters to configure
how the module will treat a certain station. I.e. station-specific
configurations per module. Bindings can be configured using profiles, or
directly per station. A profile is a named set of parameters for a certain
module that can be attributed for more than one station. Using profiles makes
it easiear to maintain large number of station configuration. When two stations
are configured by the same profile, both will have the same parameter set for
a certain module.</p></li>
</ul>
<p>scconfig does not know anything about the SeisComP database, the only thing it
can do is to actually read and write the content of files from <code class="file docutils literal notranslate"><span class="pre">etc/</span></code> and
<code class="file docutils literal notranslate"><span class="pre">~/.seiscomp</span></code> folder. It allows you to manage this information in an
organized and friendly manner. Also, it relies on other applications like the
proper <a class="reference internal" href="seiscomp.html#seiscomp"><span class="std std-ref">seiscomp</span></a> tool to complete the system configuration.</p>
<section id="first-start">
<span id="scconfig-first-start"></span><h3>First start<a class="headerlink" href="#first-start" title="Permalink to this heading"></a></h3>
<p>If scconfig is started for the first time it will ask the user to setup
its new installation.</p>
<figure class="align-center">
<img alt="../_images/first-start.png" src="../_images/first-start.png" />
</figure>
<p>If done already with the <a class="reference internal" href="../base/getting-started.html#getting-started"><span class="std std-ref">command line interface</span></a>,
this step can be skipped. If the setup has been run already, is indicated by
the presence of the file <code class="file docutils literal notranslate"><span class="pre">var/run/seiscomp.init</span></code>.</p>
<p>If pressing yes, the setup wizard will be started and will configure exactly
the same parameters as described in <a class="reference internal" href="../base/getting-started.html#getting-started"><span class="std std-ref">Getting Started with SeisComP</span></a>.</p>
<figure class="align-center">
<img alt="../_images/wizard-start.png" src="../_images/wizard-start.png" />
</figure>
<figure class="align-center">
<img alt="../_images/wizard-finish.png" src="../_images/wizard-finish.png" />
</figure>
<p>Pressing Finish will run the setup and report the progress.</p>
<figure class="align-center">
<img alt="../_images/wizard-done.png" src="../_images/wizard-done.png" />
</figure>
<p>Pressing Close will launch the main configuration window.</p>
</section>
<section id="main-window">
<span id="scconfig-mainwindow"></span><h3>Main Window<a class="headerlink" href="#main-window" title="Permalink to this heading"></a></h3>
<p>The layout of the main window is always the same regardless of what panel
is selected.</p>
<figure class="align-center" id="id6">
<span id="fig-scconfig-mainwindow"></span><a class="reference internal image-reference" href="../_images/mainwindow.png"><img alt="../_images/mainwindow.png" src="../_images/mainwindow.png" style="width: 18cm;" /></a>
<figcaption>
<p><span class="caption-text">Main window of scconfig: mode switch (red), panel selection (yellow),
panel title and description (green),
panel content (blue)</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>It is divided into 4 areas:</p>
<ul class="simple">
<li><p>red: the mode switch (user vs. system)</p></li>
<li><p>yellow: panel switch</p></li>
<li><p>green: title and description of current panel</p></li>
<li><p>blue: the content and interactive screen of the current panel</p></li>
</ul>
<p>The Main menu contains two entries: <span class="guilabel">File</span> and <span class="guilabel">Edit</span>.</p>
<p>The file menu allows to run the setup wizard (<span class="guilabel">Wizard</span>), to reload
the configuration (<span class="guilabel">Reload</span>), to save the
configuration (<span class="guilabel">Save</span>) and to close the configuration (<span class="guilabel">Quit</span>).</p>
<p>The Edit menu allows to switch the current configuration mode. Pressing the
switch button in the upper left corner (red box) is a shortcut for this operation.</p>
</section>
<section id="information-panel">
<span id="scconfig-information"></span><h3>Information panel<a class="headerlink" href="#information-panel" title="Permalink to this heading"></a></h3>
<p>This panel shows information about the <cite>SeisComP</cite> environment
(see figure <a class="reference internal" href="#fig-scconfig-mainwindow"><span class="std std-ref">main window</span></a>). All variables
(except PATH) can be used as placeholders in most of the configuration
parameters which define directories or files, e.g.:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>autoloc.grid<span class="w"> </span><span class="o">=</span><span class="w"> </span>@CONFIGDIR@/autoloc/local.grid
</pre></div>
</div>
</section>
<section id="system-panel">
<span id="scconfig-system"></span><h3>System panel<a class="headerlink" href="#system-panel" title="Permalink to this heading"></a></h3>
<p>The system panel is a graphical frontend for the <a class="reference internal" href="../base/management.html#system-management"><span class="std std-ref">seiscomp</span></a> script.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/system-overview.png"><img alt="../_images/system-overview.png" src="../_images/system-overview.png" style="width: 18cm;" /></a>
</figure>
<p>It is divided into 3 parts: the toolbar on the top (red), the module list (green)
and the log window (blue).
The log window shows the output of all external programs called such as <strong class="program">seiscomp</strong>.
The standard output is colored black and standard error is colored brown.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to the buffering of the GUI it can happen that standard output and
standard error logs are not in perfect order.</p>
</div>
<p>The toolbar gives access to the available operations. All operations
will affect the currently selected modules (rows). If no row is selected, all
modules are affected and the corresponding call to <strong class="program">seiscomp &lt;arg&gt;</strong> is done
without any module.</p>
<dl class="simple">
<dt><em>Update</em></dt><dd><p>Updates the current module state by calling <strong class="program">seiscomp --csv status</strong>.</p>
</dd>
<dt><em>Start</em></dt><dd><p>Calls <strong class="program">seiscomp start</strong>.</p>
</dd>
<dt><em>Stop</em></dt><dd><p>Calls <strong class="program">seiscomp stop</strong>.</p>
</dd>
<dt><em>Restart</em></dt><dd><p>Calls <strong class="program">seiscomp restart</strong>.</p>
</dd>
<dt><em>Check</em></dt><dd><p>Calls <strong class="program">seiscomp check</strong>.</p>
</dd>
<dt><em>Enable module(s)</em></dt><dd><p>Enables all selected modules for autostart.
At least one module must be selected.</p>
</dd>
<dt><em>Disable module(s)</em></dt><dd><p>Disables all selected modules for autostart.
At least one module must be selected.</p>
</dd>
<dt><em>Update configuration</em></dt><dd><p>Calls <strong class="program">seiscomp update-config</strong>. This is important after the
module configuration or bindings have changed and before restarting the
affected modules.</p>
</dd>
</dl>
<p>For applying an action to all modules deselect any modules selection pressing
<kbd class="kbd docutils literal notranslate">ESC</kbd> and press the corresponding action button. When one ore multiple
modules are selected, the action is only applied to those.</p>
<p>To open the most recent log files of modules right click on the module name and
select the available log.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/system-start.png"><img alt="../_images/system-start.png" src="../_images/system-start.png" style="width: 18cm;" /></a>
</figure>
</section>
<section id="inventory-panel">
<span id="scconfig-inventory"></span><h3>Inventory panel<a class="headerlink" href="#inventory-panel" title="Permalink to this heading"></a></h3>
<p>The inventory panel allows to import, check and synchronize inventory files as
well as to inspect the content or to rename or remove the files. The panel shows
a list of inventory XML files located in folder <code class="file docutils literal notranslate"><span class="pre">etc/inventory</span></code>. Only
<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> files can be used as source for inventory data but various importers
exist to integrate inventory data from other formats. After the first start
the list is empty and contains only a README file.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/inventory-empty.png"><img alt="../_images/inventory-empty.png" src="../_images/inventory-empty.png" style="width: 18cm;" /></a>
</figure>
<p>Importing station meta data is outlined in the
<a class="reference internal" href="../base/tutorials/addstation.html#tutorials-addstation"><span class="std std-ref">tutorial on adding a station</span></a>.</p>
<p>One source of importing inventory information is ArcLink as run at
<a class="reference external" href="http://www.webdc.eu">http://www.webdc.eu</a>. After downloading the inventory XML file from ArcLink it
can be imported into SeisComP by pressing the Import button in the toolbar
on the top.</p>
<p>It will open a popup which allows to select for input format.</p>
<figure class="align-center">
<img alt="../_images/inventory-import-format.png" src="../_images/inventory-import-format.png" />
</figure>
<p>If ArcLink is selected, the source location should then point to the ArcLink
XML file downloaded before.</p>
<figure class="align-center">
<img alt="../_images/inventory-import-source.png" src="../_images/inventory-import-source.png" />
</figure>
<p>If successfully imported a window will popup with the execution result and
the import output.</p>
<figure class="align-center">
<img alt="../_images/inventory-import-finished.png" src="../_images/inventory-import-finished.png" />
</figure>
<p>After closing the popup the imported inventory file will show up in the list of
files. Selecting a files by right-clicking allows:</p>
<ul class="simple">
<li><p>Renaming,</p></li>
<li><p>Deleting,</p></li>
<li><p>Inspecting the content of</p></li>
</ul>
<p>the file.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/inventory-arclink.png"><img alt="../_images/inventory-arclink.png" src="../_images/inventory-arclink.png" style="width: 18cm;" /></a>
</figure>
<p>The toolbar support 4 additional actions:</p>
<dl>
<dt><em>Check inventory</em></dt><dd><p>The inventory is checked for issues including inconsistencies wich are reported.
The tests are based on <a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a> and listed in the documentation of this
module. Adjust sensitivity by configuring <a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>.</p>
</dd>
<dt><em>Sync keys</em></dt><dd><p>This action is part of sync but can be called also standalone. It merges all
inventory XML files and creates key files in <code class="file docutils literal notranslate"><span class="pre">etc/key/station_*</span></code> if a
key file does not yet exist. Existing key files are not touched unless the
station is not part of the inventory anymore.</p>
<p>As a result, all stations in inventory will have a corresponding key file and
each key file will have a corresponding station in inventory.</p>
</dd>
<dt><em>Test sync</em></dt><dd><p>The inventory XML files are not used directly with SeisComP. They need to
be synchronized with the database first (see <a class="reference internal" href="global.html#global-stations"><span class="std std-ref">Station meta data</span></a>).
Synchronization needs to merge all existing XML files and create differences
against the existing database tables. While merging conflicts can occur such
as duplicate stations with different content (e.g. different description).
This action is a dry-run of the actual synchronisation. It performs merging
and creates differences but does not send any update. This actions is useful
to test all your existing inventory files before actually modifying the
database.</p>
<figure class="align-center">
<img alt="../_images/inventory-sync-test-passed.png" src="../_images/inventory-sync-test-passed.png" />
</figure>
</dd>
<dt><em>Sync</em></dt><dd><p>Almost identical to <em>Test sync</em> but it does send updates to the database and
additionally synchronizes key files and resource files.</p>
</dd>
</dl>
<p><em>Sync</em> and <em>Sync keys</em> will cause a reload of the configuration to refresh the
current binding tree (see <a class="reference internal" href="#scconfig-bindings"><span class="std std-ref">Bindings panel</span></a>).</p>
</section>
<section id="modules-panel">
<span id="scconfig-modules"></span><h3>Modules panel<a class="headerlink" href="#modules-panel" title="Permalink to this heading"></a></h3>
<p>The modules panel allows configuration of all registered modules.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/modules-overview.png"><img alt="../_images/modules-overview.png" src="../_images/modules-overview.png" style="width: 18cm;" /></a>
</figure>
<p>The left/green part shows the list of available modules grouped by defined
categories and the right/blue part shows the current active module configuration.
The active configuration corresponds to the selected item in the list. See
section <a class="reference internal" href="#scconfig-editing"><span class="std std-ref">Editing parameters</span></a> for further information about the content panel.</p>
</section>
<section id="bindings-panel">
<span id="scconfig-bindings"></span><h3>Bindings panel<a class="headerlink" href="#bindings-panel" title="Permalink to this heading"></a></h3>
<p>The binding panel configures a station for a module providing station-specific
configuration such as data acquisition or processing. You may configure station
bindings or binding profiles. The profiles are typically applied to a set of
station. Any change in the profile parameters apply to all stations bound to it.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Working with <a class="reference internal" href="#scconfig-bindings-profile"><span class="std std-ref">bindings profiles</span></a> allows to
maintain a single set of binding parameters for one or multiple stations.
<a class="reference internal" href="#scconfig-bindings-station"><span class="std std-ref">Station bindings</span></a> are useful if a set of
binding parameters are applied only to a single station. Otherwise configure
<a class="reference internal" href="#scconfig-bindings-profile"><span class="std std-ref">binding profiles</span></a>.
<a class="reference internal" href="#scconfig-bindings-profile"><span class="std std-ref">Profiles</span></a> are therefore preferred over
<a class="reference internal" href="#scconfig-bindings-station"><span class="std std-ref">station bindings</span></a> unless only one single
station shall be configured.</p>
</div>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/modules-binding.png"><img alt="../_images/modules-binding.png" src="../_images/modules-binding.png" style="width: 18cm;" /></a>
</figure>
<p>The binding panel is separated into 3 main areas:</p>
<ul class="simple">
<li><p>the station tree (red + orange),</p></li>
<li><p>the binding content (green),</p></li>
<li><p>the module tree (blue + magenta).</p></li>
</ul>
<p>The station tree (red) shows a tree of all available networks and their
stations. Each stations contains nodes of its configured bindings. The lower
view (orange) represents the content of the currently selected item in the
station tree.</p>
<p>The binding content shows the content of a binding and is similar to the
module configuration content. See section <a class="reference internal" href="#scconfig-editing"><span class="std std-ref">Editing parameters</span></a> for further
information about this panel.</p>
<p>The module tree contains all modules which can be used along with bindings.
The upper/blue window contains the modules and all available binding profiles
for each module and the lower/magenta part shows all binding profiles of the
currently selected module. This view is used to add new profiles and delete
existing profiles.</p>
<section id="profiles">
<span id="scconfig-bindings-profile"></span><h4>Profiles<a class="headerlink" href="#profiles" title="Permalink to this heading"></a></h4>
<section id="create-a-profile">
<h5>Create a profile<a class="headerlink" href="#create-a-profile" title="Permalink to this heading"></a></h5>
<p>For creating a binding profile select a module in the module tree (blue area)
and right-click on the module or select the “add” button in the lower (magenta)
panel. Provide a descriptive name. Clicking on the name of the profile opens the
profile allowing to adjust the parameters.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/modules-profiles.png"><img alt="../_images/modules-profiles.png" src="../_images/modules-profiles.png" style="width: 18cm;" /></a>
</figure>
</section>
<section id="create-bindings">
<h5>Create bindings<a class="headerlink" href="#create-bindings" title="Permalink to this heading"></a></h5>
<p>Assigning a binding profile to one or more stations creates one or more bindings.
To assign a binding profile to a single station, a single network including all
stations or all networks drag a profile from the right part (blue or magenta)
to the target in the left part (red or orange).</p>
<p>For assigning to a set of stations/networks, select the target first by mouse
click and then drag to profile onto the selection.</p>
<p>It is also possible to drag and drop multiple profiles with one action.</p>
</section>
</section>
<section id="station-bindings">
<span id="scconfig-bindings-station"></span><h4>Station bindings<a class="headerlink" href="#station-bindings" title="Permalink to this heading"></a></h4>
<p>To create an exclusive station binding for a module, it must be opened in the
binding view (orange box) by either selecting a station in the station tree
(red) or opening/clicking that station in the binding view (orange). The
binding view will then contain all currently configured bindings.</p>
<figure class="align-center">
<img alt="../_images/modules-bindings-station.png" src="../_images/modules-bindings-station.png" />
</figure>
<p>Clicking with the right mouse button into the free area will open a menu which
allows to add a binding for a module which has not yet been added. Adding
a binding will activate it and bring its content into the content panel.</p>
<p>To convert an existing profile into a station binding, right click on the
binding icon and select <span class="menuselection">Change profile ‣ None</span>. The existing
profile will be converted into a station binding and activated for editing.</p>
<figure class="align-center">
<img alt="../_images/modules-bindings-convert.png" src="../_images/modules-bindings-convert.png" />
</figure>
</section>
<section id="applying-bindings">
<h4>Applying bindings<a class="headerlink" href="#applying-bindings" title="Permalink to this heading"></a></h4>
<p>The bindings parameters must be additionally written to the database or as for a
<a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> converted to the specific module configuration by
updating the configuration. You may update configuration for all modules or just
the specific one. To this end, change to the
<a class="reference internal" href="#scconfig-system"><span class="std std-ref">System panel</span></a> select the specific module or none and
press the button “<em>Update configuration</em>”.</p>
<p>Alternatively, execute the <a class="reference internal" href="seiscomp.html#seiscomp"><span class="std std-ref">seiscomp</span></a> script on the command line or all or
the specific module:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config
seiscomp<span class="w"> </span>update-config<span class="w"> </span>module
</pre></div>
</div>
</section>
</section>
<section id="editing-parameters">
<span id="scconfig-editing"></span><h3>Editing parameters<a class="headerlink" href="#editing-parameters" title="Permalink to this heading"></a></h3>
<p>The content panel of a configuration is organized as a tree. Each module/binding
name is a toplevel item and all namespace are titles of collapsible sections.
Namespaces are separated by dot in the configuration file, e.g.
:file:<a href="#id2"><span class="problematic" id="id3">`</span></a>scautopick.cfg which also reads :file:<a href="#id4"><span class="problematic" id="id5">`</span></a>global.cfg would end up in a tree
like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>+<span class="w"> </span>global
<span class="p">|</span><span class="w"> </span><span class="p">|</span>
<span class="p">|</span><span class="w"> </span>+--<span class="w"> </span>connection
<span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span>
<span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>+--<span class="w"> </span>server<span class="w"> </span><span class="o">(</span>global.cfg:<span class="w"> </span>connection.server<span class="o">)</span>
<span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span>
<span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>+--<span class="w"> </span>username<span class="w"> </span><span class="o">(</span>global.cfg:<span class="w"> </span>connection.username<span class="o">)</span>
<span class="p">|</span><span class="w"> </span><span class="p">|</span>
<span class="p">|</span><span class="w"> </span>+--<span class="w"> </span>database<span class="w"> </span><span class="o">(</span>global.cfg:<span class="w"> </span>database<span class="o">)</span>
<span class="p">|</span>
+<span class="w"> </span>scautopick
<span class="w"> </span><span class="p">|</span>
<span class="w"> </span>+--<span class="w"> </span>connection
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span>+--<span class="w"> </span>server<span class="w"> </span><span class="o">(</span>scautopick.cfg:<span class="w"> </span>connection.server<span class="o">)</span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span>+--<span class="w"> </span>username<span class="w"> </span><span class="o">(</span>scautopick.cfg:<span class="w"> </span>connection.username<span class="o">)</span>
<span class="w"> </span><span class="p">|</span>
<span class="w"> </span>+--<span class="w"> </span>database<span class="w"> </span><span class="o">(</span>scautopick.cfg:<span class="w"> </span>database<span class="o">)</span>
</pre></div>
</div>
<p>Figure <a class="reference internal" href="#fig-scconfig-modules-global"><span class="std std-ref">Content panel layout</span></a> describes each item in the content
panel.</p>
<figure class="align-center" id="id7">
<span id="fig-scconfig-modules-global"></span><a class="reference internal image-reference" href="../_images/modules-global.png"><img alt="../_images/modules-global.png" src="../_images/modules-global.png" style="width: 18cm;" /></a>
<figcaption>
<p><span class="caption-text">Content panel layout</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<figure class="align-right">
<img alt="../_images/config-typing.png" src="../_images/config-typing.png" />
</figure>
<p>The content of the input widget (except for boolean types which are mapped
to a simple checkbox) is the raw content of the configuration file without parsing.
While typing a box pops up which contains the parsed and interpreted content as
read by an application. It shows the number of parsed list items, possible
errors and the content of each list item.</p>
<p>Each parameter has a lock icon. If the parameter is locked it is not written
to the configuration file. If it is unlocked, it is written to the configuration
file and editable. Locking is similar to remove the line with a text
editor.</p>
<p>The configuration content that is displayed depends on the current mode. In system
mode <code class="file docutils literal notranslate"><span class="pre">etc/&lt;module&gt;.cfg</span></code> is configured while in user mode it is
<code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/&lt;module&gt;.cfg</span></code>.</p>
<p>It may happen that a configuration parameter is editable but will not have any
affect on the module configuration. This is caused by the different configuration
stages. If the system configuration is active but a parameter has set in the
user configuration it cannot be overriden in the system configuration. The user
configuration is always of higher priority. scconfig will detect such problems
and will color the input widget red in such situations.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/config-warning.png"><img alt="../_images/config-warning.png" src="../_images/config-warning.png" style="width: 18cm;" /></a>
</figure>
<p>The value in the edit widget will show the currently configured value in the
active configuration file but the tooltip will show the evaluated value, the
location of the definition and a warning.</p>
</section>
<section id="documentation-and-changelog">
<span id="scconfig-documentation"></span><h3>Documentation and changelog<a class="headerlink" href="#documentation-and-changelog" title="Permalink to this heading"></a></h3>
<p>Access the documentation and the changelog of any installad package from the
Docs panel.</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/documentation.png"><img alt="../_images/documentation.png" src="../_images/documentation.png" style="width: 18cm;" /></a>
</figure>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scconfig</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#first-start">First start</a></li>
<li><a class="reference internal" href="#main-window">Main Window</a></li>
<li><a class="reference internal" href="#information-panel">Information panel</a></li>
<li><a class="reference internal" href="#system-panel">System panel</a></li>
<li><a class="reference internal" href="#inventory-panel">Inventory panel</a></li>
<li><a class="reference internal" href="#modules-panel">Modules panel</a></li>
<li><a class="reference internal" href="#bindings-panel">Bindings panel</a><ul>
<li><a class="reference internal" href="#profiles">Profiles</a><ul>
<li><a class="reference internal" href="#create-a-profile">Create a profile</a></li>
<li><a class="reference internal" href="#create-bindings">Create bindings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#station-bindings">Station bindings</a></li>
<li><a class="reference internal" href="#applying-bindings">Applying bindings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#editing-parameters">Editing parameters</a></li>
<li><a class="reference internal" href="#documentation-and-changelog">Documentation and changelog</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../gui.html"
title="previous chapter">Graphical User Interfaces</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scesv.html"
title="next chapter">scesv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scconfig.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,531 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scdb &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scdbstrip" href="scdbstrip.html" />
<link rel="prev" title="sccnv" href="sccnv.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">6.9.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="scdbstrip.html" title="scdbstrip"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="sccnv.html" title="sccnv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scdb">
<span id="id1"></span><h1>scdb<a class="headerlink" href="#scdb" title="Permalink to this heading"></a></h1>
<p><strong>Populate a SQL database from XML files or messages.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>A major component of the SeisComP system is the database. Almost all
applications have only read access to the database, but all the processing
results and objects have to be written into the database. This was the task of
scdb. In very first versions of SeisComP scdb was the only component that had
write access to the database. Its task is to connect to <a class="reference internal" href="scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> and populate
the database with all received notifier messages. Although it worked it
introduced race conditions caused by the latency of the database backend since
all other clients received the message at the same time. Accessing the database
immediately at this point in time did not guarantee that the object was
written already.</p>
<p>In consequence, the scmaster itself gained write access to the database and
forwards messages to all clients after they are written to database.</p>
<p><a class="reference internal" href="#scdb"><span class="std std-ref">scdb</span></a> by definition does not check existing objects in the database. It only
generates INSERT/UPDATE/DELETE statements based on the data used and sends
these statements to the database. E.g. if <a class="reference internal" href="#scdb"><span class="std std-ref">scdb</span></a> receives a message to
insert a new object into the database and this object exists already, the
database will raise an error because <a class="reference internal" href="#scdb"><span class="std std-ref">scdb</span></a> hasnt checked it.</p>
<section id="online-mode">
<h3>Online mode<a class="headerlink" href="#online-mode" title="Permalink to this heading"></a></h3>
<p>Now scdb can be used to maintain a backup or archive the database that is not
part of the real time processing. When running scdb as database write daemon it
can inform a client about the database connection to use. A client sends a
DatabaseRequest message and scdb sends back a DatabaseResponse message containing
the database connection parameters.</p>
<p>For that it connects to a messaging server and writes all received messages to a
configured database, e.g. a backup database.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The database connection received from the messaging server during the
handshake is reported to clients requesting a database address. To overwrite
the read-only database, just override the applications database address
(with the -d option)</p>
</div>
</section>
<section id="offline-mode">
<h3>Offline mode<a class="headerlink" href="#offline-mode" title="Permalink to this heading"></a></h3>
<p>Another important task of <a class="reference internal" href="#scdb"><span class="std std-ref">scdb</span></a> is to populate the database with any SeisComP
data model content. In combination with <a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a> it can be used to copy events
from one database to another.</p>
<p>For that it does not connect to a messaging server but reads data from XML
files and writes it to the database. Offline mode will be used if the
input/-i option is provided. Multiple input files can be specified by
providing this option multiple times with separate filenames.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>When reading XML files the output database address is not passed
with -o but -d. The applications database address is used.</p>
</div>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Connect to a messaging server and write all messages to the output database
<cite>seiscomp</cite> running on the host <cite>db-server</cite>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdb<span class="w"> </span>-H<span class="w"> </span><span class="o">[</span>server<span class="o">]</span><span class="w"> </span>-o<span class="w"> </span>mysql://sysop:sysop@db-server/seiscomp
</pre></div>
</div>
</li>
<li><p>As above, but with the read-only database connection using the user <cite>sysop</cite>
and the output database connection using the user <cite>writer</cite>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdb<span class="w"> </span>-H<span class="w"> </span><span class="o">[</span>server<span class="o">]</span><span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@db-server/seiscomp<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-o<span class="w"> </span>mysql://writer:12345@db-server/seiscomp
</pre></div>
</div>
</li>
<li><p>Import data from the file <code class="file docutils literal notranslate"><span class="pre">data.xml</span></code> and write it to the database
<cite>seiscomp</cite> on the host <cite>db-server</cite>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdb<span class="w"> </span>-i<span class="w"> </span>data.xml<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@db-server/seiscomp
</pre></div>
</div>
</li>
<li><p>Import data from three files at once:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdb<span class="w"> </span>-i<span class="w"> </span>data1.xml<span class="w"> </span>-i<span class="w"> </span>data2.xml<span class="w"> </span>-i<span class="w"> </span>data3.xml<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@db-server/seiscomp
</pre></div>
</div>
</li>
</ol>
</section>
</section>
<section id="module-configuration">
<span id="scdb-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scdb.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scdb.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scdb.cfg</span></code></div>
</div>
<p>scdb inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-connection.requestGroup">
<span class="sig-name descname"><span class="pre">connection.requestGroup</span></span><a class="headerlink" href="#confval-connection.requestGroup" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Define the group on scmaster to subscribe for database
requests.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-connection.provideGroup">
<span class="sig-name descname"><span class="pre">connection.provideGroup</span></span><a class="headerlink" href="#confval-connection.provideGroup" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Define the group on scmaster to send database response
messages to.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.type">
<span class="sig-name descname"><span class="pre">output.type</span></span><a class="headerlink" href="#confval-output.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Define the output database connection type.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.parameters">
<span class="sig-name descname"><span class="pre">output.parameters</span></span><a class="headerlink" href="#confval-output.parameters" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Define the output database connection parameters.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scdb [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-h">
<span id="cmdoption-scdb-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-V">
<span id="cmdoption-scdb-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-D">
<span id="cmdoption-scdb-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-v">
<span id="cmdoption-scdb-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-q">
<span id="cmdoption-scdb-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-s">
<span id="cmdoption-scdb-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-l">
<span id="cmdoption-scdb-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-u">
<span id="cmdoption-scdb-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-H">
<span id="cmdoption-scdb-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-t">
<span id="cmdoption-scdb-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-g">
<span id="cmdoption-scdb-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-S">
<span id="cmdoption-scdb-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-m">
<span id="cmdoption-scdb-mode"></span><span class="sig-name descname"><span class="pre">--m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--mode</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-m" title="Permalink to this definition"></a></dt>
<dd><p>scdb can either process a XML file and write it to the
database or collect messages from scmaster.
If connected to scmaster, the mode defines what objects
are handled: none (no objects at all), notifier (notifier
only) or all (all objects whereas non-notifier objects
are INSERTED into the database).</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdb-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-d">
<span id="cmdoption-scdb-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-config-db">
<span class="sig-name descname"><span class="pre">--config-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-config-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the configuration from the given database or file,
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-o">
<span id="cmdoption-scdb-output"></span><span class="sig-name descname"><span class="pre">--o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-o" title="Permalink to this definition"></a></dt>
<dd><p>If connected to scmaster, this flag defines the database
connection to use for writing. The configured application
database connection (as received from scmaster) is reported
to clients as part of a database response messages.</p>
</dd></dl>
</section>
<section id="import">
<h3>Import<a class="headerlink" href="#import" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdb-i">
<span id="cmdoption-scdb-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdb-i" title="Permalink to this definition"></a></dt>
<dd><p>Define the import XML file to be written to database.
Can be provided multiple times to import multiple files.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scdb</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#online-mode">Online mode</a></li>
<li><a class="reference internal" href="#offline-mode">Offline mode</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#import">Import</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="sccnv.html"
title="previous chapter">sccnv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scdbstrip.html"
title="next chapter">scdbstrip</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scdb.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,577 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scdbstrip &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scdispatch" href="scdispatch.html" />
<link rel="prev" title="scdb" href="scdb.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">6.9.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="scdispatch.html" title="scdispatch"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scdb.html" title="scdb"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scdbstrip">
<span id="id1"></span><h1>scdbstrip<a class="headerlink" href="#scdbstrip" title="Permalink to this heading"></a></h1>
<p><strong>Clean up a database from event and waveform quality parameters.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><cite>SeisComP</cite>s <a class="reference internal" href="scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> is continuously writing to the database. This causes
the database to grow and to occupy much space on the harddisc. scdbstrip taggles
this problem and removes processed objects from the database older than a
configurable time span. The time comparison considers the object time, not the
time of their creation.</p>
<p>The parameters which scdbstrip removes are</p>
<ul class="simple">
<li><p>Event parameters including events, origins, magnitudes, amplitudes, arrivals, picks,
focal mechanisms, moment tensors</p></li>
<li><p>Waveform quality control (QC) parameters.</p></li>
</ul>
<p>scdbstrip will remove all events with an origin time and QC parameters older or
younger than specified. Default is older. It will also remove all associated
objects such as picks, origins, arrivals, amplitudes and so on.</p>
<p>scdbstrip does not run as a daemon. To remove old objects continuously scdbstrip
should be added to the list of cronjobs running every e.g. 30 minutes. The more
often it runs the less objects it has to remove and the faster it will unlock
the database again. The timing and the parameters to be removed is controlled
by module configuration or command-line options.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<ul class="simple">
<li><p>For removing specific parameters and not all in a time range, use
<a class="reference internal" href="scdispatch.html#scdispatch"><span class="std std-ref">scdispatch</span></a> along with XML files created by <a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a> and
<a class="reference internal" href="scqueryqc.html#scqueryqc"><span class="std std-ref">scqueryqc</span></a> for event parameters and waveform QC parameters,
respectively.</p></li>
<li><p>For removing data availability parameters use <a class="reference internal" href="scardac.html#scardac"><span class="std std-ref">scardac</span></a>.</p></li>
</ul>
</div>
</section>
<section id="known-issues">
<h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this heading"></a></h2>
<p>When running scdbstrip for the first time on a large database it can happen
that it aborts in case of MYSQL with the following error message:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">[</span><span class="w"> </span><span class="m">3</span>%<span class="o">]</span><span class="w"> </span>Delete<span class="w"> </span>origin<span class="w"> </span>references<span class="w"> </span>of<span class="w"> </span>old<span class="w"> </span>events...08:48:22<span class="w"> </span><span class="o">[</span>error<span class="o">]</span>
execute<span class="o">(</span><span class="s2">&quot;delete Object from Object, OriginReference, old_events where</span>
<span class="s2">Object._oid=OriginReference._oid and</span>
<span class="s2">OriginReference._parent_oid=old_events._oid&quot;</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1206</span><span class="w"> </span><span class="o">(</span>The<span class="w"> </span>total<span class="w"> </span>number
of<span class="w"> </span>locks<span class="w"> </span>exceeds<span class="w"> </span>the<span class="w"> </span>lock<span class="w"> </span>table<span class="w"> </span>size<span class="o">)</span>
Exception:<span class="w"> </span>ERROR:<span class="w"> </span><span class="nb">command</span><span class="w"> </span><span class="s1">&#39;delete Object from Object, OriginReference,</span>
<span class="s1">old_events where Object._oid=OriginReference._oid and</span>
<span class="s1">OriginReference._parent_oid=old_events._oid&#39;</span><span class="w"> </span>failed
</pre></div>
</div>
<p>That means your MYSQL server cannot hold enough data required for deletion.
There are two solutions to this:</p>
<ol class="arabic">
<li><p>Increase the memory pool used by MYSQL by changing the configuration. The
minimum is 64 MBytes but modern system typically have a larger default:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">innodb_buffer_pool_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>64M
</pre></div>
</div>
<p>The size of the new buffer depends on the size of the database that should
be cleaned up. Read also the section <a class="reference internal" href="../base/installation.html#database-configuration"><span class="std std-ref">Database Server Configuration</span></a>. It
provides more options for optimizing your database server.</p>
</li>
<li><p>Run scdbstrip on smaller batches for the first time:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">1000</span>
$<span class="w"> </span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">900</span>
...
$<span class="w"> </span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">100</span>
</pre></div>
</div>
</li>
</ol>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>In the examples, database connection parameters correspond to default values.
You may thus replace <code class="docutils literal notranslate"><span class="pre">-d</span> <span class="pre">mysql://sysop:sysop&#64;localhost/seiscomp</span></code> by
<code class="docutils literal notranslate"><span class="pre">-d</span> <span class="pre">localhost</span></code> or <code class="docutils literal notranslate"><span class="pre">-d</span> <span class="pre">mysql://</span></code>.</p>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Remove event and waveform quality parameters older than 30 days</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span>
</pre></div>
</div>
</li>
<li><p>Remove event and waveform quality parameters newer than 30 days</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span><span class="w"> </span>-i
</pre></div>
</div>
</li>
<li><p>Only remove waveform QC parameters older than 30 days but no others</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span><span class="w"> </span>--qc-only
</pre></div>
</div>
</li>
<li><p>Remove event and waveform quality parameters before 2000-01-01 12:00:00</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--datetime<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00
</pre></div>
</div>
</li>
<li><p>Remove event and waveform quality parameters after 2000-01-01 12:00:00</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--datetime<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00<span class="w"> </span>-i
</pre></div>
</div>
</li>
<li><p>Remove event and waveform quality parameters between 2000-01-01 12:00:00 ~ 2000-01-01 14:00:00</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--time-window<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00~2000-01-01T14:00:00
</pre></div>
</div>
</li>
<li><p>Remove event and waveform quality parameters before 2000-01-01 12:00:00 and after 2000-01-01 14:00:00</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--time-window<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00~2000-01-01T14:00:00<span class="w"> </span>-i
</pre></div>
</div>
</li>
</ul>
</section>
<section id="module-configuration">
<span id="scdbstrip-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scdbstrip.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scdbstrip.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scdbstrip.cfg</span></code></div>
</div>
<p>scdbstrip inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-database.cleanup.invertMode">
<span class="sig-name descname"><span class="pre">database.cleanup.invertMode</span></span><a class="headerlink" href="#confval-database.cleanup.invertMode" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Invert the selection of the specified time period, that is
delete all parameters after the specified time period,
not before. When a date range is specified, then delete all
parameters before and after the time range, not in between.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-database.cleanup.eventParameters">
<span class="sig-name descname"><span class="pre">database.cleanup.eventParameters</span></span><a class="headerlink" href="#confval-database.cleanup.eventParameters" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Strip all event parameters including events, origins,
magnitudes, amplitudes, arrivals, picks, focal mechanisms.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-database.cleanup.qualityControl">
<span class="sig-name descname"><span class="pre">database.cleanup.qualityControl</span></span><a class="headerlink" href="#confval-database.cleanup.qualityControl" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Strip waveform quality control (QC) parameters.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>database.cleanup.keep.*</strong>
<em>Parameters controlling the time to keep objects in the database.</em>
<em>The time comparison considers the object time, not the time of</em>
<em>their creation.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-database.cleanup.keep.days">
<span class="sig-name descname"><span class="pre">database.cleanup.keep.days</span></span><a class="headerlink" href="#confval-database.cleanup.keep.days" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
<p>Type: <em>int</em></p>
<p>The number of days to preserve in the database. This
value is added to the whole timespan. Hours
and minutes are configured separately.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-database.cleanup.keep.hours">
<span class="sig-name descname"><span class="pre">database.cleanup.keep.hours</span></span><a class="headerlink" href="#confval-database.cleanup.keep.hours" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>int</em></p>
<p>The number of hours to preserve in the database. This
value is added to the whole timespan. Days
and minutes are configured separately.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-database.cleanup.keep.minutes">
<span class="sig-name descname"><span class="pre">database.cleanup.keep.minutes</span></span><a class="headerlink" href="#confval-database.cleanup.keep.minutes" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>int</em></p>
<p>The number of minutes to preserve in the database. This
value is added to the whole timespan. Days
and hours are configured separately.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scdbstrip [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-h">
<span id="cmdoption-scdbstrip-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-V">
<span id="cmdoption-scdbstrip-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-first-new">
<span class="sig-name descname"><span class="pre">--first-new</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-first-new" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-firstNew"><code class="xref std std-confval docutils literal notranslate"><span class="pre">firstNew</span></code></a>.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-v">
<span id="cmdoption-scdbstrip-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-q">
<span id="cmdoption-scdbstrip-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-s">
<span id="cmdoption-scdbstrip-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-l">
<span id="cmdoption-scdbstrip-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-d">
<span id="cmdoption-scdbstrip-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-check">
<span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-check" title="Permalink to this definition"></a></dt>
<dd><p>Checks if unreachable objects exist.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-clean-unused">
<span class="sig-name descname"><span class="pre">--clean-unused</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-clean-unused" title="Permalink to this definition"></a></dt>
<dd><p>Remove all unreachable objects when in checkmode. Default:
off.</p>
</dd></dl>
</section>
<section id="objects">
<h3>Objects<a class="headerlink" href="#objects" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-E">
<span id="cmdoption-scdbstrip-ep-only"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ep-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-E" title="Permalink to this definition"></a></dt>
<dd><p>Strip only event parameters. Other parameters, like QC, are
are ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-Q">
<span id="cmdoption-scdbstrip-qc-only"></span><span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--qc-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-Q" title="Permalink to this definition"></a></dt>
<dd><p>Strip only waveform quality control (QC) parameters. Other
parameters, like event parameters, are are ignored.
Overrides eq-only.</p>
</dd></dl>
</section>
<section id="timespan">
<h3>Timespan<a class="headerlink" href="#timespan" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-days">
<span class="sig-name descname"><span class="pre">--days</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-days" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.keep.days"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.keep.days</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-hours">
<span class="sig-name descname"><span class="pre">--hours</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-hours" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.keep.hours"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.keep.hours</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-minutes">
<span class="sig-name descname"><span class="pre">--minutes</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-minutes" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.keep.minutes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.keep.minutes</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-datetime">
<span class="sig-name descname"><span class="pre">--datetime</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-datetime" title="Permalink to this definition"></a></dt>
<dd><p>Replaces the days:hours:minutes timespan definition by an
arbitrary absolute timestamp in UTC. Format:
%Y-%m-%dT%H:%M:%S.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-t">
<span id="cmdoption-scdbstrip-time-window"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-window</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-t" title="Permalink to this definition"></a></dt>
<dd><p>Delete objects in the specified time window.
Replaces the days:hours:minutes timespan definition by an
arbitrary absolute time range in UTC. Format:
startTime~endTime that is %Y-%m-%dT%H:%M:%S~%Y-%m-%dT%H:%M:%S</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-i">
<span id="cmdoption-scdbstrip-invert"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--invert</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-i" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.invertMode"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.invertMode</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdbstrip-keep-events">
<span class="sig-name descname"><span class="pre">--keep-events</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-keep-events" title="Permalink to this definition"></a></dt>
<dd><p>IDs of events to keep in the database separated with comma.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scdbstrip</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#known-issues">Known Issues</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#objects">Objects</a></li>
<li><a class="reference internal" href="#timespan">Timespan</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scdb.html"
title="previous chapter">scdb</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scdispatch.html"
title="next chapter">scdispatch</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scdbstrip.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,612 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scdispatch &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scdumpcfg" href="scdumpcfg.html" />
<link rel="prev" title="scdbstrip" href="scdbstrip.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">6.9.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="scdumpcfg.html" title="scdumpcfg"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scdbstrip.html" title="scdbstrip"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scdispatch">
<span id="id1"></span><h1>scdispatch<a class="headerlink" href="#scdispatch" title="Permalink to this heading"></a></h1>
<p><strong>Read objects (event, origin, etc) from a SCML file and sends the objects
to the messaging system.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scdispatch reads an <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> file and creates notifier objects for them that
are sent to the <a class="reference internal" href="../base/concepts/messaging.html#concepts-messaging"><span class="std std-ref">messaging</span></a> and the corresponding
messaging groups (see <code class="xref std std-option docutils literal notranslate"><span class="pre">--routingtable</span></code>). In contrast to <a class="reference internal" href="scdb.html#scdb"><span class="std std-ref">scdb</span></a>
which writes SCML files directly into the <a class="reference internal" href="../base/concepts/database.html#concepts-database"><span class="std std-ref">database</span></a>
scdispatch uses the messaging bus. If <a class="reference internal" href="scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> is configured with the
database plugin, messages will end up in the database as well.</p>
<section id="modes">
<h3>Modes<a class="headerlink" href="#modes" title="Permalink to this heading"></a></h3>
<p>scdispatch can work in two modes applying different
<a class="reference internal" href="#scdispatch-operations"><span class="std std-ref">operations</span></a>:</p>
<ul class="simple">
<li><p><em>Without database check:</em> One of the <a class="reference internal" href="#scdispatch-operations"><span class="std std-ref">operations</span></a>
<em>add</em>, <em>update</em> or <em>remove</em> is selected along with the option <code class="xref std std-option docutils literal notranslate"><span class="pre">-O</span></code>. In
that case all objects in the <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> are encapsulated in a notifier with
that specific operation and sent to the messaging. No check is performed if
the object is already in the database or not.</p></li>
<li><p><em>With database check:</em> The option <code class="xref std std-option docutils literal notranslate"><span class="pre">-O</span></code> is not given or the
option is used along with one of the <a class="reference internal" href="#scdispatch-operations"><span class="std std-ref">operations</span></a>
<em>merge</em> or <em>merge-without-remove</em>. scdispatch first tries to load the corresponding
objects from the database and calculates differences. It will then create the
corresponding notifiers with operations <em>add</em>, <em>update</em> or <em>remove</em> and sends
them to the messaging. That mode is quite close to a sync operation with the
exception that top level objects (such as origin or event) that are not part
of the input SCML are left untouched in the database. It can be used to
synchronize event information from one system with another.</p></li>
</ul>
</section>
<section id="operations">
<span id="scdispatch-operations"></span><h3>Operations<a class="headerlink" href="#operations" title="Permalink to this heading"></a></h3>
<p>Different operations can be chosen along with the option <code class="xref std std-option docutils literal notranslate"><span class="pre">-O</span></code>.
If <code class="xref std std-option docutils literal notranslate"><span class="pre">-O</span></code> is not given, <em>merge</em> is assumed by default.</p>
<ul class="simple">
<li><p><em>Add</em>: All objects are sent trying to be added to the database. If they
already exist in the database, they will be rejected and not spread through
the messaging. Modules connected to the messaging will not receive rejected
objects.</p></li>
<li><p><em>Remove</em>: All sent objects with all their attributes and child objects are
removed from the database. Modules connected to the messaging will not receive
any sent object.</p></li>
<li><p><em>Update</em>: All objects are sent trying to be updated to the database along with
all of their child objects and attributes. Sent objects not existing in the
database will be ignored and not received by any module connected to the
messaging. Child objects and attributes existing in the database but not
included in the sent object will be removed as well.</p></li>
<li><p><em>Merge</em> (default): Applies <em>Add</em> and <em>Update</em> and requires a database
connection.</p></li>
<li><p><em>Merge-without-remove</em>: Applies <em>Add</em> and <em>Update</em> and requires a database
connection. However, no objects are removed from the database.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>All <cite>SeisComP</cite> objects along are listed and described along with their child
objects and attributes in the <a class="reference internal" href="../base/api-python.html#api-datamodel-python"><span class="std std-ref">API documentation</span></a>.</p>
</div>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Send different objects from a <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> file for merging (adding or
updating). The option <code class="xref std std-option docutils literal notranslate"><span class="pre">-O</span></code> can be ommitted because the default
behavior is to merge:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>merge
scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml
</pre></div>
</div>
</li>
<li><p>Send all objects by ignoring events. When <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> receives origins it
will create new events or associate the origins to existing ones. The ignored
events may be already existing with different IDs. Hence, event duplication
is avoided by ignoring them.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-e
</pre></div>
</div>
</li>
<li><p>Send new objects to be added:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>add
</pre></div>
</div>
</li>
<li><p>Send an update of objects:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>update
</pre></div>
</div>
</li>
<li><p>Send objects to be removed:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>remove
</pre></div>
</div>
</li>
<li><p>Compare new objects with the database content and send the difference (optionally without removing objects):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>merge
scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>merge-without-remove
</pre></div>
</div>
</li>
<li><p>Offline mode: all operations can be performed without the messaging system using xml files:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>operation<span class="w"> </span>--create-notifier<span class="w"> </span>&gt;<span class="w"> </span>notifier.xml
</pre></div>
</div>
<p>then:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdb<span class="w"> </span>-i<span class="w"> </span>notifier.xml
</pre></div>
</div>
</li>
<li><p>Subsets of SCML Objects</p>
<p>It can be useful to import a subset of QuakeML objects, e.g. Origins from other
agencies and then allow <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> to associate them to existing
events (and possibly prefer them based on the rules in scevent) or create new
events for the origins. If the event objects from a SCML file are not required
to be sent to the messaging then either they should be removed (e.g. using XSLT)
and all the remaining objects in the file added:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>add
</pre></div>
</div>
<p>or the <strong>event objects</strong> can be left out of the routing table, e.g.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-i<span class="w"> </span>test.xml<span class="w"> </span>-O<span class="w"> </span>add<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--routingtable<span class="w"> </span>Pick:PICK,<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>Amplitude:AMPLITUDE,<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>Origin:LOCATION,StationMagnitude:MAGNITUDE,<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>Magnitude:MAGNITUDE
</pre></div>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The option <code class="xref std std-option docutils literal notranslate"><span class="pre">--no-event</span></code> is a wrapper for removing Event:EVENT from
the routing table. With this option no event objects will be sent which may
be useful if just the origins with magnitudes, amplitudes, arrivals, picks, etc.
shall be integrated, e.g. after XML-based playbacks.</p>
</div>
</li>
<li><p>Testing</p>
<p>For testing it is useful to watch the results of dispatch with <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or
<a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a>. It is also useful to clean the database and logs to remove
objects from persistent storage to allow repeated reloading of a file.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The following will clear all events from the database and any other
other object persistence. Modify the mysql command to suit your db setup.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mysql<span class="w"> </span>-u<span class="w"> </span>root<span class="w"> </span>--password<span class="o">=</span><span class="s1">&#39;my$q1&#39;</span><span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;DROP DATABASE IF EXISTS seiscomp; \</span>
<span class="s2"> CREATE DATABASE seiscomp CHARACTER SET utf8 COLLATE utf8_bin; \</span>
<span class="s2"> GRANT ALL ON seiscomp.* TO &#39;sysop&#39;@&#39;localhost&#39; IDENTIFIED BY &#39;sysop&#39;; \</span>
<span class="s2"> USE seiscomp;source seiscomp/trunk/share/db/mysql.sql;&quot;</span>
seiscomp<span class="w"> </span>start
</pre></div>
</div>
</div>
</li>
</ol>
</section>
</section>
<section id="module-configuration">
<span id="scdispatch-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scdispatch.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scdispatch.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scdispatch.cfg</span></code></div>
</div>
<p>scdispatch inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scdispatch [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-h">
<span id="cmdoption-scdispatch-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-V">
<span id="cmdoption-scdispatch-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-D">
<span id="cmdoption-scdispatch-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-v">
<span id="cmdoption-scdispatch-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-q">
<span id="cmdoption-scdispatch-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-s">
<span id="cmdoption-scdispatch-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-l">
<span id="cmdoption-scdispatch-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-u">
<span id="cmdoption-scdispatch-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-H">
<span id="cmdoption-scdispatch-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-t">
<span id="cmdoption-scdispatch-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-g">
<span id="cmdoption-scdispatch-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-S">
<span id="cmdoption-scdispatch-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-d">
<span id="cmdoption-scdispatch-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="dispatch">
<h3>Dispatch<a class="headerlink" href="#dispatch" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-e">
<span id="cmdoption-scdispatch-no-events"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-events</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-e" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any event object which are ignored when reading
event parameters.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-i">
<span id="cmdoption-scdispatch-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-i" title="Permalink to this definition"></a></dt>
<dd><p>File from which the content is dispatched to the messaging.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-O">
<span id="cmdoption-scdispatch-operation"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--operation</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-O" title="Permalink to this definition"></a></dt>
<dd><p>Merge and merge-without-remove require a database
connection. Both will read the object corresponding to the
sent object from the database and calculate the differences.
Merge-without-remove behaves like merge with the exception
that remove operations will be filtered out and no objects
in the database will be removed.</p>
<p>If add, update or remove is specified, then all objects in
XML are sent with the given operation regardless of their
existence in the database.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-print-objects">
<span class="sig-name descname"><span class="pre">--print-objects</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-print-objects" title="Permalink to this definition"></a></dt>
<dd><p>Print names of routable objects.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-print-routingtable">
<span class="sig-name descname"><span class="pre">--print-routingtable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-print-routingtable" title="Permalink to this definition"></a></dt>
<dd><p>Print routing table.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-routingtable">
<span class="sig-name descname"><span class="pre">--routingtable</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdispatch-routingtable" title="Permalink to this definition"></a></dt>
<dd><p>Specify routing table as comma separated list of object:group
pairs, e.g. &quot;Origin:LOCATION,Event:EVENT&quot;. When an
object should be routed to a group and no table entry for
that particular class type is available, all parent objects
are checked for valid routing entries and the first found is
used. E.g. if only &quot;Origin:LOCATION&quot; is specified
but the input file contains also Arrivals which are child
objects of Origin then the routing entry of Origin is used
because of the parent-child relationship between Origin and
Arrival.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-test" title="Permalink to this definition"></a></dt>
<dd><p>Test mode. Does not send any object.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdispatch-create-notifier">
<span class="sig-name descname"><span class="pre">--create-notifier</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdispatch-create-notifier" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any object. All notifiers will be written to
standard output in XML format.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scdispatch</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#modes">Modes</a></li>
<li><a class="reference internal" href="#operations">Operations</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#dispatch">Dispatch</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scdbstrip.html"
title="previous chapter">scdbstrip</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scdumpcfg.html"
title="next chapter">scdumpcfg</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scdispatch.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,433 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scdumpcfg &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scevtlog" href="scevtlog.html" />
<link rel="prev" title="scdispatch" href="scdispatch.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">6.9.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="scevtlog.html" title="scevtlog"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scdispatch.html" title="scdispatch"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scdumpcfg">
<span id="id1"></span><h1>scdumpcfg<a class="headerlink" href="#scdumpcfg" title="Permalink to this heading"></a></h1>
<p><strong>Dump bindings or module configurations used by a specific module or global
for particular stations.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scdumpcfg reads and prints the
<a class="reference internal" href="../base/concepts/configuration.html#concepts-configuration"><span class="std std-ref">module or bindings configuration</span></a>
for a specific module or for global. It even prints the global bindings for modules
which do not have module bindings, such as <a class="reference internal" href="scmv.html#scmv"><span class="std std-ref">scmv</span></a>.</p>
<p>This command-line utility is therefore useful for debugging configuration parameters.</p>
<p>Instead of printing parameters and values for stations, the option <code class="xref std std-option docutils literal notranslate"><span class="pre">--nlsc</span></code>
allows printing a list of the channel considering bindings. The output may be
used, e.g., for</p>
<ul class="simple">
<li><p>filtering inventory by <a class="reference internal" href="invextr.html#invextr"><span class="std std-ref">invextr</span></a></p></li>
<li><p>miniSEED records by <a class="reference internal" href="scart.html#scart"><span class="std std-ref">scart</span></a> or <a class="reference internal" href="scmssort.html#scmssort"><span class="std std-ref">scmssort</span></a></p></li>
<li><p>event information by <a class="reference internal" href="scevtstreams.html#scevtstreams"><span class="std std-ref">scevtstreams</span></a>.</p></li>
</ul>
<p>Related to <strong class="program">scdumpcfg</strong> is <a class="reference internal" href="bindings2cfg.html#bindings2cfg"><span class="std std-ref">bindings2cfg</span></a> which dumps the bindings
configuration to <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Dump the global bindings configuration for all stations which have global bindings:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdumpcfg<span class="w"> </span>global<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-B
</pre></div>
</div>
</li>
<li><p>Dump the bindings configuration for all stations which have bindings to a
<a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> profile. Additionally use <em>-G</em> as <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> inherits global
bindings:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdumpcfg<span class="w"> </span>scautopick<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-GB
</pre></div>
</div>
</li>
<li><p>Dump the module global module configuration specifcally searching for the map
zoom sensitivity and output the result in the format of the <cite>SeisComP</cite> module
configuration:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdumpcfg<span class="w"> </span>global<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--cfg<span class="w"> </span>-P<span class="w"> </span>map.zoom.sensitivity
</pre></div>
</div>
</li>
<li><p>Dump the module configuration of scautopick and output in the format of the
<cite>SeisComP</cite> module configuration:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdumpcfg<span class="w"> </span>scautopick<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--cfg
</pre></div>
</div>
</li>
<li><p>Dump global bindings configuration considerd by scmv:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdumpcfg<span class="w"> </span>scmv<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-BG
</pre></div>
</div>
</li>
<li><p>Dump the channel codes defined by scautopick binding as a list of NET.STA.LOC.CHA:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdumpcfg<span class="w"> </span>scautopick<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-B<span class="w"> </span>--nslc
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="scdumpcfg-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scdumpcfg.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scdumpcfg.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scdumpcfg.cfg</span></code></div>
</div>
<p>scdumpcfg inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scdumpcfg [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-h">
<span id="cmdoption-scdumpcfg-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-V">
<span id="cmdoption-scdumpcfg-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-D">
<span id="cmdoption-scdumpcfg-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-v">
<span id="cmdoption-scdumpcfg-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-q">
<span id="cmdoption-scdumpcfg-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-s">
<span id="cmdoption-scdumpcfg-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-l">
<span id="cmdoption-scdumpcfg-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-d">
<span id="cmdoption-scdumpcfg-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-config-db">
<span class="sig-name descname"><span class="pre">--config-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-config-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the configuration from the given database or file,
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
</section>
<section id="dump">
<h3>Dump<a class="headerlink" href="#dump" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-B">
<span id="cmdoption-scdumpcfg-bindings"></span><span class="sig-name descname"><span class="pre">-B</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--bindings</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-B" title="Permalink to this definition"></a></dt>
<dd><p>Dump bindings instead of module configuration.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-G">
<span id="cmdoption-scdumpcfg-allow-global"></span><span class="sig-name descname"><span class="pre">-G</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--allow-global</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-G" title="Permalink to this definition"></a></dt>
<dd><p>Print global bindings if no module binding is available.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-P">
<span id="cmdoption-scdumpcfg-param"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--param</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdumpcfg-P" title="Permalink to this definition"></a></dt>
<dd><p>Specify the parameter name(s) to filter for. Use comma
separation of multiple parameters.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-cfg">
<span class="sig-name descname"><span class="pre">--cfg</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-cfg" title="Permalink to this definition"></a></dt>
<dd><p>Print output in .cfg format. Does not work along with -B.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scdumpcfg-nslc">
<span class="sig-name descname"><span class="pre">--nslc</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdumpcfg-nslc" title="Permalink to this definition"></a></dt>
<dd><p>Print the list of channels which have bindings of the given
module. Requires to set -B. Can be used by other modules,
e.g., invextr, scart, scmssort, scevtstreams.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scdumpcfg</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#dump">Dump</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scdispatch.html"
title="previous chapter">scdispatch</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scevtlog.html"
title="next chapter">scevtlog</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scdumpcfg.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,884 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scesv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scheli" href="scheli.html" />
<link rel="prev" title="scconfig" href="scconfig.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">6.9.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="scheli.html" title="scheli"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scconfig.html" title="scconfig"
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scesv">
<span id="id1"></span><h1>scesv<a class="headerlink" href="#scesv" title="Permalink to this heading"></a></h1>
<p><strong>Event summary view.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scesv is the summary display of the event parameters. It shows the primary information
about the current event including location, time, strength, type and processing status.
Additional to the current event older events can also be chosen from the eventlist in the
events tab.</p>
<p>The two tabs of scesv are</p>
<ul class="simple">
<li><p>Events tab showing the list of loaded events, compare Fig. <a class="reference internal" href="#fig-events"><span class="std std-ref">Eventlist tab</span></a></p></li>
<li><p>Summary tab with the details of the selected event, see Fig. <a class="reference internal" href="#fig-summary"><span class="std std-ref">Summary tab</span></a>.</p></li>
</ul>
</section>
<section id="events-tab">
<span id="scesv-events-tab"></span><h2>Events Tab<a class="headerlink" href="#events-tab" title="Permalink to this heading"></a></h2>
<p>The Events tab shows the eventlist of the time span defined on the bottom side of
the window. A the Events tab is also available for other GUIs, such as <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>
it can be configured in the global module configuration.
The <a class="reference internal" href="scolv.html#scolv-events-tab"><span class="std std-ref">description of the Events tab in scolv</span></a> provides more
details.</p>
<figure class="align-center" id="id2">
<span id="fig-events"></span><a class="reference internal image-reference" href="../_images/scesv-events.png"><img alt="../_images/scesv-events.png" src="../_images/scesv-events.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Eventlist tab</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
<div class="legend">
<p>Tab1-2: Summary/Events tab, EventList: list of the last events with summarized information,
List options: Show fake events, Reading 1: spinbox to limit timespan of displayed events (in days),
Reading 2: spinboxes to limit timespan of displayed events (specified dates), Status: connection status</p>
</div>
</figcaption>
</figure>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As for <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> filtering of the event list and custom information can be
added to the event list by configuration. Read the scolv documentation on
<a class="reference internal" href="scolv.html#scolv-events-filtering"><span class="std std-ref">event filtering</span></a> and <a class="reference internal" href="scolv.html#scolv-custom-actions"><span class="std std-ref">custom action</span></a>
for the details.</p>
</div>
</section>
<section id="summary-tab">
<span id="scesv-summary-tab"></span><h2>Summary Tab<a class="headerlink" href="#summary-tab" title="Permalink to this heading"></a></h2>
<p>The most recent (default) or the event selected from the event list is shown in
the Summary tab, see Fig. <a class="reference internal" href="#fig-summary"><span class="std std-ref">Summary tab</span></a>.
Here the information are highlighted in four sections:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>section</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Time</p></td>
<td><p>Orign time in UTC and relative to now</p></td>
</tr>
<tr class="row-odd"><td><p>Region</p></td>
<td><p>A map of the region and location with the event and stations</p></td>
</tr>
<tr class="row-even"><td><p>Magnitude</p></td>
<td><p>Different magnitude types, the values and counts</p></td>
</tr>
<tr class="row-odd"><td><p>Hypocenter</p></td>
<td><p>Origin information with location, depth, azimuthal gap etc.</p></td>
</tr>
</tbody>
</table>
<figure class="align-center" id="id3">
<span id="fig-summary"></span><a class="reference internal image-reference" href="../_images/scesv-summary.png"><img alt="../_images/scesv-summary.png" src="../_images/scesv-summary.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Summary tab</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
<div class="legend">
<p>Tab1-2: Summary/Events tab, Origin Time: origin time in UTC and relative to now, Map: map with region
and location and stations, Magnitude: different magnitude types with values and counts,
Origin Info: hypocenter information with position, phase count and azimuthal gap,
Event: earthquake location, Station: station with ray-path, Details: “Show Details” button to open
detailed information in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>, Event Type: event type combo box to set event type, Status: connection status</p>
</div>
</figcaption>
</figure>
</section>
<section id="hotkeys">
<h2>Hotkeys<a class="headerlink" href="#hotkeys" title="Permalink to this heading"></a></h2>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Hotkey</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F1</kbd></p></td>
<td><p>Open <cite>SeisComP</cite> documentation</p></td>
</tr>
<tr class="row-odd"><td><p>Shift + <kbd class="kbd docutils literal notranslate">F1</kbd></p></td>
<td><p>Open scesv documentation</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F2</kbd></p></td>
<td><p>Setup connection dialog</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F6</kbd></p></td>
<td><p>Show propagation of P and S wave</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F7</kbd></p></td>
<td><p>Show focal mechanism by beach ball</p></td>
</tr>
<tr class="row-odd"><td><p>Shift + <kbd class="kbd docutils literal notranslate">F7</kbd></p></td>
<td><p>Show focal mechanism by beach ball</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F8</kbd></p></td>
<td><p>Toggle auto update</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F9</kbd></p></td>
<td><p>Show raypaths and associated stations</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F10</kbd></p></td>
<td><p>Toggle tabs</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F11</kbd></p></td>
<td><p>Toggle fullscreen</p></td>
</tr>
<tr class="row-even"><td><p>Mouse wheel</p></td>
<td><p>Zoom map in/out</p></td>
</tr>
<tr class="row-odd"><td><p>Double click</p></td>
<td><p>Center map</p></td>
</tr>
</tbody>
</table>
</section>
<section id="module-configuration">
<span id="scesv-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scesv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scesv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scesv.cfg</span></code></div>
</div>
<p>scesv inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-loadEventDB">
<span class="sig-name descname"><span class="pre">loadEventDB</span></span><a class="headerlink" href="#confval-loadEventDB" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>days</em></p>
<p>Number of days to preload if scesv is started.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-showLastAutomaticSolution">
<span class="sig-name descname"><span class="pre">showLastAutomaticSolution</span></span><a class="headerlink" href="#confval-showLastAutomaticSolution" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the last automatic solution is displayed next to the
current solution in the summary panel. If the last automatic
solution differs from the current solution it is displayed
in red. If both solutions match it is displayed in gray.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-showOnlyMostRecentEvent">
<span class="sig-name descname"><span class="pre">showOnlyMostRecentEvent</span></span><a class="headerlink" href="#confval-showOnlyMostRecentEvent" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, only the most recent event is shown even if an update of
an older event is being received.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-recenterMap">
<span class="sig-name descname"><span class="pre">recenterMap</span></span><a class="headerlink" href="#confval-recenterMap" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the map is centered around the most recent event event.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-enableFixAutomaticSolutions">
<span class="sig-name descname"><span class="pre">enableFixAutomaticSolutions</span></span><a class="headerlink" href="#confval-enableFixAutomaticSolutions" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, an additional button is displayed which allows to
switch back the latest automatic solution. This button triggers
an command for scevent to prioritize automatic solutions until
the next manual solution is available.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-visibleMagnitudes">
<span class="sig-name descname"><span class="pre">visibleMagnitudes</span></span><a class="headerlink" href="#confval-visibleMagnitudes" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">M,MLv,mb,mB,Mw(mB)</span></code></p>
<p>Type: <em>list:string</em></p>
<p>A list of magnitude types to be displayed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-button0">
<span class="sig-name descname"><span class="pre">button0</span></span><a class="headerlink" href="#confval-button0" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Label of button0 which triggers script0.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-button1">
<span class="sig-name descname"><span class="pre">button1</span></span><a class="headerlink" href="#confval-button1" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Label of button1 which triggers script1.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-ignoreOtherEvents">
<span class="sig-name descname"><span class="pre">ignoreOtherEvents</span></span><a class="headerlink" href="#confval-ignoreOtherEvents" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If the event type is either &quot;other&quot; or
&quot;not existing&quot; and this flag is true then the
event will not be shown.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.script0">
<span class="sig-name descname"><span class="pre">scripts.script0</span></span><a class="headerlink" href="#confval-scripts.script0" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Path to a script if button0 is clicked.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.script1">
<span class="sig-name descname"><span class="pre">scripts.script1</span></span><a class="headerlink" href="#confval-scripts.script1" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Path to a script if button1 is clicked.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.script0.exportMap">
<span class="sig-name descname"><span class="pre">scripts.script0.exportMap</span></span><a class="headerlink" href="#confval-scripts.script0.exportMap" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the current map is exported to file.
The filename is appened to the parameter list of script0.
The script has to take ownership of the file.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.script0.oldStyle">
<span class="sig-name descname"><span class="pre">scripts.script0.oldStyle</span></span><a class="headerlink" href="#confval-scripts.script0.oldStyle" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the parameter list of script0 is event ID,
arrival count, magnitude, description.</p>
<p>If disabled, the parameter list of script0 is event ID,
preferredOriginID, preferredMagnitudeID,
preferredFocalMechanismID.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.script1.exportMap">
<span class="sig-name descname"><span class="pre">scripts.script1.exportMap</span></span><a class="headerlink" href="#confval-scripts.script1.exportMap" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the current map is exported to file.
The filename is appened to the parameter list of script1.
The script has to take ownership of the file.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.script1.oldStyle">
<span class="sig-name descname"><span class="pre">scripts.script1.oldStyle</span></span><a class="headerlink" href="#confval-scripts.script1.oldStyle" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the parameter list of script1 is event ID,
arrivalCount, magnitude, description.</p>
<p>If disabled, the parameter list of script1 is event ID,
preferredOriginID, preferredMagnitudeID,
preferredFocalMechanismID.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summary.borders">
<span class="sig-name descname"><span class="pre">summary.borders</span></span><a class="headerlink" href="#confval-summary.borders" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Draw borders in the summary panel.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>display.*</strong>
<em>Adjust content or display custom information in the Summary tab.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.lonmin">
<span class="sig-name descname"><span class="pre">display.lonmin</span></span><a class="headerlink" href="#confval-display.lonmin" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Minimum longitude of initially displayed map region.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.lonmax">
<span class="sig-name descname"><span class="pre">display.lonmax</span></span><a class="headerlink" href="#confval-display.lonmax" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum longitude of initially displayed map region.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.latmin">
<span class="sig-name descname"><span class="pre">display.latmin</span></span><a class="headerlink" href="#confval-display.latmin" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-90</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Minimum latitude of initially displayed map region.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.latmax">
<span class="sig-name descname"><span class="pre">display.latmax</span></span><a class="headerlink" href="#confval-display.latmax" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">90</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum latitude of initially displayed map region.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>display.event.*</strong>
<em>Event information</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.event.comment.id">
<span class="sig-name descname"><span class="pre">display.event.comment.id</span></span><a class="headerlink" href="#confval-display.event.comment.id" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>ID of the event comment to be considered.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.event.comment.default">
<span class="sig-name descname"><span class="pre">display.event.comment.default</span></span><a class="headerlink" href="#confval-display.event.comment.default" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Value to be shown in case no valid event comment is
found.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.event.comment.label">
<span class="sig-name descname"><span class="pre">display.event.comment.label</span></span><a class="headerlink" href="#confval-display.event.comment.label" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Label of the value to be shown.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>display.origin.*</strong>
<em>Origin information</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>display.origin.comment.*</strong>
<em>Display origin comments.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.origin.comment.id">
<span class="sig-name descname"><span class="pre">display.origin.comment.id</span></span><a class="headerlink" href="#confval-display.origin.comment.id" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>ID of the origin comment to be considered.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.origin.comment.default">
<span class="sig-name descname"><span class="pre">display.origin.comment.default</span></span><a class="headerlink" href="#confval-display.origin.comment.default" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Value to be shown in case no valid origin comment is
found.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.origin.comment.label">
<span class="sig-name descname"><span class="pre">display.origin.comment.label</span></span><a class="headerlink" href="#confval-display.origin.comment.label" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Label of the value to be shown.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>poi.*</strong>
<em>Display information related to a point of interest (POI)</em>
<em>read from the cities XML file.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.maxDist">
<span class="sig-name descname"><span class="pre">poi.maxDist</span></span><a class="headerlink" href="#confval-poi.maxDist" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum distance in degrees of a POI to be taken into account.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.minPopulation">
<span class="sig-name descname"><span class="pre">poi.minPopulation</span></span><a class="headerlink" href="#confval-poi.minPopulation" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>The minimum population of a POI to be taken into account.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.message">
<span class="sig-name descname"><span class="pre">poi.message</span></span><a class="headerlink" href="#confval-poi.message" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Message conversion string that converts a POI into the text
displayed under the region label. There are different
placeholders that can be used: &#64;dist&#64;, &#64;dir&#64;, &#64;poi&#64; and &#64;region&#64;.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scesv [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-h">
<span id="cmdoption-scesv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-V">
<span id="cmdoption-scesv-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-v">
<span id="cmdoption-scesv-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-q">
<span id="cmdoption-scesv-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-s">
<span id="cmdoption-scesv-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-l">
<span id="cmdoption-scesv-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-u">
<span id="cmdoption-scesv-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-H">
<span id="cmdoption-scesv-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-t">
<span id="cmdoption-scesv-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-g">
<span id="cmdoption-scesv-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-S">
<span id="cmdoption-scesv-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-d">
<span id="cmdoption-scesv-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-I">
<span id="cmdoption-scesv-record-url"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-city-xml">
<span class="sig-name descname"><span class="pre">--city-xml</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-city-xml" title="Permalink to this definition"></a></dt>
<dd><p>The path to the cities XML file. This overrides the default
paths. Compare with the global parameter &quot;citiesXML&quot;.</p>
</dd></dl>
</section>
<section id="user-interface">
<h3>User interface<a class="headerlink" href="#user-interface" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-F">
<span id="cmdoption-scesv-full-screen"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--full-screen</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-F" title="Permalink to this definition"></a></dt>
<dd><p>Start the application filling the entire screen.
This only works with GUI applications.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-N">
<span id="cmdoption-scesv-non-interactive"></span><span class="sig-name descname"><span class="pre">-N</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--non-interactive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scesv-N" title="Permalink to this definition"></a></dt>
<dd><p>Use non-interactive presentation mode. This only works with
GUI applications.</p>
</dd></dl>
</section>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-script0">
<span class="sig-name descname"><span class="pre">--script0</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-script0" title="Permalink to this definition"></a></dt>
<dd><p>Path to the script called when configurable
button0 is pressed; EventID, arrival count, magnitude and
the additional location information string are passed as
parameters $1, $2, $3 and $4, respectively.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-script1">
<span class="sig-name descname"><span class="pre">--script1</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-script1" title="Permalink to this definition"></a></dt>
<dd><p>Path to the script called when configurable
button1 is pressed; EventID, arrival count, magnitude and
the additional location information string are passed as
parameters $1, $2, $3 and $4, respectively.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scesv-load-event-db">
<span class="sig-name descname"><span class="pre">--load-event-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scesv-load-event-db" title="Permalink to this definition"></a></dt>
<dd><p>Number of days to load from database.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scesv</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#events-tab">Events Tab</a></li>
<li><a class="reference internal" href="#summary-tab">Summary Tab</a></li>
<li><a class="reference internal" href="#hotkeys">Hotkeys</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#cities">Cities</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scconfig.html"
title="previous chapter">scconfig</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scheli.html"
title="next chapter">scheli</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scesv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,228 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>EventType &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="RegionCheck" href="scevent_regioncheck.html" />
<link rel="prev" title="scevent" href="../toc/extensions/scevent.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">6.9.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="scevent_regioncheck.html" title="RegionCheck"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/extensions/scevent.html" title="scevent"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/scevent.html" accesskey="U">scevent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="eventtype">
<span id="scevent-eventtype"></span><h1>EventType<a class="headerlink" href="#eventtype" title="Permalink to this heading"></a></h1>
<p>evtype plugin for scevent</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The <em>evtype</em> pluging sets the type of an event based on comments of picks which
are associated to the preferred origin of this event. The IDs of the comments
from which the comment values are considered must be configured by
<a class="reference internal" href="#confval-eventType.pickCommentIDs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventType.pickCommentIDs</span></code></a> and the name of the plugin, <em>evtype</em>, must
be added to the <a class="reference internal" href="global.html#confval-plugins"><code class="xref std std-confval docutils literal notranslate"><span class="pre">plugins</span></code></a> parameter. The text of the considered
comments must contain a supported event type.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Other criteria for setting the event type may be added later to this plugin.</p>
</div>
<p>Example of a pick comment:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;pick</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;20160914.075944.29-deepc-AB.XYZ..HHZ&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span>...
<span class="w"> </span><span class="nt">&lt;comment&gt;</span>
<span class="w"> </span><span class="nt">&lt;text&gt;</span>earthquake<span class="nt">&lt;/text&gt;</span>
<span class="w"> </span><span class="nt">&lt;id&gt;</span>deepc:eventTypeHint<span class="nt">&lt;/id&gt;</span>
<span class="w"> </span><span class="nt">&lt;/comment&gt;</span>
<span class="w"> </span>...
<span class="nt">&lt;/pick&gt;</span>
</pre></div>
</div>
<p>Example configuration (<code class="file docutils literal notranslate"><span class="pre">scevent.cfg</span></code>):</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">evtype</span>
<span class="na">eventType.setEventType</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span>
<span class="na">eventType.pickCommentIDs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">scrttv:eventTypeHint, deepc:eventTypeHint</span>
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scevent-eventtype-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>eventType.*</strong>
<em>Set the event type based on type comments of picks. Add the</em>
<em>plugin “evtype” to the list of plugins in the order</em>
<em>of priority to make this feature available.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventType.setEventType">
<span class="sig-name descname"><span class="pre">eventType.setEventType</span></span><a class="headerlink" href="#confval-eventType.setEventType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow setting the event type.
The type of events which have manual origins will
not be changed unless configured explicitely by
&quot;overwriteManual&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventType.overwriteEventType">
<span class="sig-name descname"><span class="pre">eventType.overwriteEventType</span></span><a class="headerlink" href="#confval-eventType.overwriteEventType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow overwriting existing event types set by other modules.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventType.overwriteManual">
<span class="sig-name descname"><span class="pre">eventType.overwriteManual</span></span><a class="headerlink" href="#confval-eventType.overwriteManual" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow setting the event type if the mode of the preferred
origin is manual or if the event type was set manually.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventType.pickCommentIDs">
<span class="sig-name descname"><span class="pre">eventType.pickCommentIDs</span></span><a class="headerlink" href="#confval-eventType.pickCommentIDs" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">scrttv:eventTypeHint,deepc:eventTypeHint</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Consider comments of picks which have one of the
given values. An empty list disables setting the type.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">EventType</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/extensions/scevent.html"
title="previous chapter">scevent</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scevent_regioncheck.html"
title="next chapter">RegionCheck</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scevent_eventtype.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,558 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>RegionCheck &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scm" href="../toc/extensions/scm.html" />
<link rel="prev" title="EventType" href="scevent_eventtype.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">6.9.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="../toc/extensions/scm.html" title="scm"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scevent_eventtype.html" title="EventType"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/scevent.html" accesskey="U">scevent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="regioncheck">
<span id="scevent-regioncheck"></span><h1>RegionCheck<a class="headerlink" href="#regioncheck" title="Permalink to this heading"></a></h1>
<p>evrc plugin for scevent</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>evrc</em> (event region check) is a <a class="reference internal" href="../base/glossary.html#term-plugin"><span class="xref std std-term">plugin</span></a> for <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> setting the
event type by comparing the location of the preferred origin with
<a class="reference internal" href="#sec-evrc-regions"><span class="std std-ref">defined regions</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Events for which the mode of the preferred origin is “manual” are by default
not considered.</p>
</div>
<section id="definition-of-regions">
<span id="sec-evrc-regions"></span><h3>Definition of regions<a class="headerlink" href="#definition-of-regions" title="Permalink to this heading"></a></h3>
<p>The regions are defined by closed polygons provided in
<a class="reference internal" href="global_gui.html#sec-gui-layers"><span class="std std-ref">GeoJSON or BNA files</span></a>. Configure <a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a> to
consider a region defined by its region name. The name is given either</p>
<ul class="simple">
<li><p>As a property of the polygon when given in GeoJSON format,</p></li>
<li><p>Or in the header when given in BNA format.</p></li>
</ul>
<p>There exist <strong>positive and negative regions</strong>:</p>
<ul class="simple">
<li><p><strong>Positive region:</strong> All events within the area enclosed by the polygon are
flagged positive, all events not enclosed by the polygon are flagged negative.</p></li>
<li><p><strong>Negative region:</strong> All events within the area enclosed by the polygon are
flagged negative, all events not enclosed by the polygon are flagged positive.</p></li>
</ul>
<p>Regions are negative if the <a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">name</span></code></a> of the enclosing polygon
starts with <strong>!</strong> (exclamation mark. Otherwise the region is positive.</p>
<p>If a list of region names is defined, the last matching region in the list takes
priority when treating events.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>When regions are defined or configured multiple times by polygons or
<a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a>, respectively, the region is not unique and the
region check is entirely inactive.</p></li>
<li><p>When a region is not defined but configured in <a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a>, the
region check remains active but the region is ignored.</p></li>
</ul>
<p>In both cases, error log message are printed.</p>
</div>
</section>
<section id="treatment-of-events">
<h3>Treatment of events<a class="headerlink" href="#treatment-of-events" title="Permalink to this heading"></a></h3>
<p>When the <em>evrc</em> plugin is loaded and configured, the location of the preferred
origin of an events is compared with the defined regions.
Events within a positive and a negative region are flagged positive and
negative, respectively. By default it sets the event type to “outside of network
interest” if the event is flagged negative.</p>
<ol class="arabic simple">
<li><p>When activating <a class="reference internal" href="#confval-rc.readEventTypeFromBNA"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.readEventTypeFromBNA</span></code></a> the type of positive
events is set according to the eventType defined in
<a class="reference internal" href="#sec-evrc-polygon"><span class="std std-ref">polygon</span></a>.
The type of negative events is set according to <a class="reference internal" href="#confval-rc.eventTypeNegative"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypeNegative</span></code></a>.
Prepend accept to the list of polygons to unset the type of negative events.</p></li>
<li><p>When <a class="reference internal" href="#confval-rc.readEventTypeFromBNA"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.readEventTypeFromBNA</span></code></a> is inactive, the event type is set
based on <a class="reference internal" href="#confval-rc.eventTypePositive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypePositive</span></code></a> and <a class="reference internal" href="#confval-rc.eventTypeNegative"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypeNegative</span></code></a>:</p>
<ol class="arabic simple">
<li><p>by default the type of all negative events (events within negative regions)
is set to “outside of network interest”.
Prepend <strong>accept</strong> to <a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a> to unset the event type for
negative events.</p></li>
<li><p><strong>positive:</strong> The event type of positive events is set to
<a class="reference internal" href="#confval-rc.eventTypePositive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypePositive</span></code></a>. For empty <a class="reference internal" href="#confval-rc.eventTypePositive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypePositive</span></code></a>
the type is unset.</p></li>
<li><p><strong>negative:</strong> The event type of negative events is set to
<a class="reference internal" href="#confval-rc.eventTypeNegative"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypeNegative</span></code></a>. The default type for negative events is
“outside of network interest”.</p></li>
</ol>
</li>
</ol>
<p>Evaluation is made based on the order of the regions names defined in
<a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a>. The last matching criteria applies.
In this way disjunct and overlapping regions with different behavior can be
defined. If events ARE NOT within positive regions their type is set to
“outside of network interest”.</p>
<figure class="align-center" id="id2">
<span id="fig-evrc-region"></span><a class="reference internal image-reference" href="../_images/regions.png"><img alt="../_images/regions.png" src="../_images/regions.png" style="width: 10cm;" /></a>
<figcaption>
<p><span class="caption-text">Disjunct and overlapping regions in front of a default.</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="event-types">
<h3>Event types<a class="headerlink" href="#event-types" title="Permalink to this heading"></a></h3>
<p>The event types are either set based the types configured in
<a class="reference internal" href="#confval-rc.eventTypePositive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypePositive</span></code></a> and <a class="reference internal" href="#confval-rc.eventTypeNegative"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.eventTypeNegative</span></code></a>
or based on the type provided in the polygon files if
<a class="reference internal" href="#confval-rc.readEventTypeFromBNA"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.readEventTypeFromBNA</span></code></a> is active.</p>
<section id="type-definition">
<h4>Type definition<a class="headerlink" href="#type-definition" title="Permalink to this heading"></a></h4>
<p>For defining the event type, any value defined in <span id="id1"><em>SeisComP UML diagram</em> [<a class="reference internal" href="../base/references.html#id280" title="SeisComP UML diagram. GEOFON. URL: https://geofon.gfz-potsdam.de/_uml_new/.">23</a>]</span>.
The list of valid values can also be found in the Event tab of <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>: Type.</p>
<p>Examples for valid event types:</p>
<ul class="simple">
<li><p>earthquake</p></li>
<li><p>quarry blast</p></li>
<li><p>nuclear explosion</p></li>
<li><p>not existing</p></li>
<li><p></p></li>
</ul>
<p>Invalid values result in errors or debug messages which are reported depending
on the verbosity level of <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> as given <a class="reference internal" href="global.html#confval-logging.level"><code class="xref std std-confval docutils literal notranslate"><span class="pre">logging.level</span></code></a> or
<code class="xref std std-option docutils literal notranslate"><span class="pre">--verbosity</span></code>/<code class="xref std std-option docutils literal notranslate"><span class="pre">-v</span></code>.</p>
</section>
<section id="event-type-from-polygon">
<span id="sec-evrc-polygon"></span><h4>Event type from polygon<a class="headerlink" href="#event-type-from-polygon" title="Permalink to this heading"></a></h4>
<p>If <a class="reference internal" href="#confval-rc.readEventTypeFromBNA"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.readEventTypeFromBNA</span></code></a> is active, the event type is read from the
polygon defining a region. Use a key-value pair in double quotes to specify the
type where the key is “eventType” and the value is the event type. The
formatting depends on the file format.</p>
<p>The depth of the event can be tested, as well. For events within a region but
with depth outside a depth range the type is not set. The limits of the depth
range can be added to the polygons using the key words <em>minDepth</em> and
<em>maxDepth</em>. For considering a polygon, the depth <em>d</em> of the preferred
<a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a> of an <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">event</span></a> must be within the range</p>
<div class="math">
<p><img src="../_images/math/f2e87dd314fde8db19e6eb5a5f937278f85efe08.png" alt="minDepth \le d \le maxDepth"/></p>
</div><p>The origin depth is only tested if minDepth or maxDepth or both are set and if
<a class="reference internal" href="#confval-rc.readEventTypeFromBNA"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.readEventTypeFromBNA</span></code></a> is active.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<ul class="simple">
<li><p>The names of polygons, e.g. coal, are case sensitive and must not contain
commas.</p></li>
<li><p>A hierarchy applies to the reading of GeoJSON/BNA files. Read the section
<a class="reference internal" href="global_gui.html#sec-gui-layers-vector"><span class="std std-ref">Vector layers</span></a> for the details.</p></li>
</ul>
</div>
<p><strong>Example polygon in BNA format:</strong></p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">&quot;coal&quot;,&quot;rank</span><span class="w"> </span><span class="s">1&quot;,&quot;eventType: mining explosion, minDepth: -5, maxDepth: 10&quot;,6</span>
<span class="na">13.392,50.3002</span>
<span class="na">13.2244,50.4106</span>
<span class="na">13.4744,50.5347</span>
<span class="na">13.6886,50.4945</span>
<span class="na">13.6089,50.358</span>
<span class="na">13.6089,50.358</span>
</pre></div>
</div>
<p>where the name of the polygon / region is “coal” and the considered event type
is “mining explosion”. The name and the rank are mandatory fields. All key-value
pairs for eventType, minDepth and maxDepth are written within one single field
enclosed by double quotes.</p>
<p><strong>Example polygon in GeoJSON format:</strong></p>
<ul>
<li><p>Single Feature</p>
<p>For a single Feature and Poylgon, eventType, minDepth are maxDepth are added as
key-value pair to the properities of the feature:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Feature&quot;,</span>
<span class="w"> </span><span class="na">&quot;geometry&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Polygon&quot;,</span>
<span class="w"> </span><span class="na">&quot;coordinates&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">[</span>
<span class="w"> </span><span class="na">[</span>
<span class="w"> </span><span class="na">[-77.075,</span><span class="w"> </span><span class="s">-37.7108], [-76.2196, -21.2587], [-69.0919, -7.10994]</span>
<span class="w"> </span><span class="na">]</span>
<span class="w"> </span><span class="na">]</span>
<span class="w"> </span><span class="na">},</span>
<span class="w"> </span><span class="na">&quot;properties&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;name&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;mines&quot;,</span>
<span class="w"> </span><span class="na">&quot;rank&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">1,</span>
<span class="w"> </span><span class="na">&quot;eventType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;mining explosion&quot;,</span>
<span class="w"> </span><span class="na">&quot;minDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">-5,</span>
<span class="w"> </span><span class="na">&quot;maxDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">10</span>
<span class="w"> </span><span class="na">}</span>
<span class="na">}</span>
</pre></div>
</div>
</li>
<li><p>Single Feature and MultiPoylgon</p>
<p>For a single Feature and a MultiPoylgon, eventType, minDepth are maxDepth are
added as key-value pair to the properities of the MultiPoylgon:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Feature&quot;</span>
<span class="w"> </span><span class="na">&quot;properties&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;name&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;mines&quot;,</span>
<span class="w"> </span><span class="na">&quot;rank&quot;</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s">1,</span>
<span class="w"> </span><span class="na">&quot;eventType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;mining explosion&quot;,</span>
<span class="w"> </span><span class="na">&quot;minDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">-5,</span>
<span class="w"> </span><span class="na">&quot;maxDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">10</span>
<span class="w"> </span><span class="na">},</span>
<span class="w"> </span><span class="na">&quot;geometry&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;MultiPolygon&quot;,</span>
<span class="w"> </span><span class="na">&quot;coordinates&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">[</span>
<span class="w"> </span><span class="na">[</span>
<span class="w"> </span><span class="na">[</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">10.0, -25.0 ],</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">13.0, -25.0 ],</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">13.0, -22.0 ],</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">10.0, -25.0 ]</span>
<span class="w"> </span><span class="na">]</span>
<span class="w"> </span><span class="na">],</span><span class="w"> </span><span class="s">[</span>
<span class="w"> </span><span class="na">[</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">20.0, -25.0 ],</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">23.0, -25.0 ],</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">23.0, -22.0 ],</span>
<span class="w"> </span><span class="na">[</span><span class="w"> </span><span class="s">20.0, -25.0 ]</span>
<span class="w"> </span><span class="na">]</span>
<span class="w"> </span><span class="na">]</span>
<span class="w"> </span><span class="na">]</span>
<span class="w"> </span><span class="na">}</span>
<span class="na">}</span>
</pre></div>
</div>
</li>
<li><p>FeatureCollection</p>
<p>For a FeatureCollection, the key-value pairs may be added to the properties of
each individual feature:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;FeatureCollection&quot;,</span>
<span class="w"> </span><span class="na">&quot;features&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">[</span>
<span class="w"> </span><span class="na">{</span><span class="w"> </span><span class="s">&quot;type&quot;: &quot;Feature&quot;,</span>
<span class="w"> </span><span class="na">&quot;properties&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;name&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Krakatau&quot;,</span>
<span class="w"> </span><span class="na">&quot;rank&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">1,</span>
<span class="w"> </span><span class="na">&quot;eventType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;mining explosion&quot;,</span>
<span class="w"> </span><span class="na">&quot;minDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">-5,</span>
<span class="w"> </span><span class="na">&quot;maxDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">10</span>
<span class="w"> </span><span class="na">},</span>
<span class="w"> </span><span class="na">&quot;geometry&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Polygon&quot;,</span>
<span class="w"> </span><span class="na">&quot;coordinates&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">[ ... ]</span>
<span class="w"> </span><span class="na">}</span>
<span class="w"> </span><span class="na">},</span>
<span class="w"> </span><span class="na">{</span><span class="w"> </span><span class="s">&quot;type&quot;: &quot;Feature&quot;,</span>
<span class="w"> </span><span class="na">&quot;properties&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;name&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Batu Tara&quot;,</span>
<span class="w"> </span><span class="na">&quot;rank&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">1,</span>
<span class="w"> </span><span class="na">&quot;eventType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;mining explosion&quot;,</span>
<span class="w"> </span><span class="na">&quot;minDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">-5,</span>
<span class="w"> </span><span class="na">&quot;maxDepth&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">10</span>
<span class="w"> </span><span class="na">},</span>
<span class="w"> </span><span class="na">&quot;geometry&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">{</span>
<span class="w"> </span><span class="na">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">&quot;Polygon&quot;,</span>
<span class="w"> </span><span class="na">&quot;coordinates&quot;</span><span class="o">:</span><span class="w"> </span><span class="s">[ ... ]</span>
<span class="w"> </span><span class="na">}</span>
<span class="w"> </span><span class="na">},</span>
<span class="w"> </span><span class="na">}</span>
<span class="na">}</span>
</pre></div>
</div>
</li>
</ul>
</section>
</section>
</section>
<section id="setting-up-the-plugin">
<h2>Setting up the Plugin<a class="headerlink" href="#setting-up-the-plugin" title="Permalink to this heading"></a></h2>
<p>Load the <em>evrc</em> plugin: Add to the global configuration or to the
global configuration of <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> in the order of priority:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,evrc
</pre></div>
</div>
<p>Add BNA polygons by defining <a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a>.
Use the region name to define positive and negative regions. Names with
leading <em>!</em> define negative regions.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rc.regions<span class="w"> </span><span class="o">=</span><span class="w"> </span>accept,area
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> stops
if the <em>evrc</em> plugin is loaded but <a class="reference internal" href="#confval-rc.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.regions</span></code></a> is not defined.</p>
</div>
<p>Activate <a class="reference internal" href="#confval-rc.readEventTypeFromBNA"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rc.readEventTypeFromBNA</span></code></a> and add the eventType key-value pair
to the <a class="reference internal" href="#sec-evrc-polygon"><span class="std std-ref">polygons</span></a> if the event type
shall be read from GeoJSON or BNA polygon.</p>
<p><strong>Examples:</strong></p>
<p>Set type of events within the positive polygon <strong>germany</strong> but do not change the
type outside:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rc.regions<span class="w"> </span><span class="o">=</span><span class="w"> </span>accept,germany
</pre></div>
</div>
<p>Accept all events without setting the type but set the type for all events within
the positive polygon <strong>germany</strong> but consider negative within the polygon
<strong>quarries</strong>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rc.regions<span class="w"> </span><span class="o">=</span><span class="w"> </span>accept,germany,!quarries
</pre></div>
</div>
<p>Accept all events without setting the type but consider events within the
negative polygon <strong>germany</strong> and events within the positive polygon <strong>saxony</strong>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rc.regions<span class="w"> </span><span class="o">=</span><span class="w"> </span>accept,!germany,saxony
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scevent-regioncheck-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>rc.*</strong>
<em>Test if events lie within or outside geographic regions defined</em>
<em>by polygons.</em>
<em>Events within a region are flagged as positive, outside as negative.</em>
<em>The event type is set accordingly. Add the</em>
<em>plugin “evrc” to the plugins parameter in the</em>
<em>order of priority to make this feature available. Read the</em>
<em>documentation of the RegionCheck for more details.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.setEventType">
<span class="sig-name descname"><span class="pre">rc.setEventType</span></span><a class="headerlink" href="#confval-rc.setEventType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow setting the event type.
The type of events which have manual origins will
not be changed unless configured explicitely by
&quot;overwriteManual&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.overwriteEventType">
<span class="sig-name descname"><span class="pre">rc.overwriteEventType</span></span><a class="headerlink" href="#confval-rc.overwriteEventType" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow overwriting existing event types. Disabling does not
allow accounting for changes in source region.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.overwriteManual">
<span class="sig-name descname"><span class="pre">rc.overwriteManual</span></span><a class="headerlink" href="#confval-rc.overwriteManual" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow setting the event type if the mode of the preferred
origin is manual or if the event type was set manually.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.regions">
<span class="sig-name descname"><span class="pre">rc.regions</span></span><a class="headerlink" href="#confval-rc.regions" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">!reject</span></code></p>
<p>Type: <em>list:string</em></p>
<p>The list of closed polygon names defining regions for
flagging event as positive or negative.
A polygon name defines a positive region but names with
prefix ! (exclamation mark) define negative regions.
Evaluation is done in the order of the polygons. The last
matching criteria applies and the event type is set
accordingly.</p>
<p>Default: If events are not positive or are negative regions
the event type is set to &quot;outside of network
interest&quot;. Default:
&quot;!reject&quot;, use &quot;accecpt&quot; to overwrite
the default.</p>
<p>Examples:</p>
<p>Events are flagged positive within the polygon
&quot;germany&quot;:</p>
<p>germany</p>
<p>All events are flagged positive but events within the
polygon &quot;quarries&quot; are negative:</p>
<p>accept,!quarries</p>
<p>Events within the polygon &quot;germany&quot; are flagged
positive but all other events and events within the polygon
&quot;quarries&quot; are negaitve:</p>
<p>germany,!quarries</p>
<p>All events are flagged positive but events within the
polygon &quot;germany&quot; are negative and all events
within the polygon &quot;saxony&quot; are positive:</p>
<p>accept,!germany,saxony</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.readEventTypeFromBNA">
<span class="sig-name descname"><span class="pre">rc.readEventTypeFromBNA</span></span><a class="headerlink" href="#confval-rc.readEventTypeFromBNA" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Consider the event type, minDepth and maxDepth values from
the polygons defined by GeoJSON or BNA files. Read the
documentation of the RegionCheck plugin for the details.</p>
<p>When eventType is defined in the polygons, the value
supersedes values of eventTypePositive and
eventTypeNegative.
If not set, eventTypePositive and eventTypeNegative are
considered.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.eventTypePositive">
<span class="sig-name descname"><span class="pre">rc.eventTypePositive</span></span><a class="headerlink" href="#confval-rc.eventTypePositive" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>New type of an event which is flagged positive. Ignored
if readEventTypeFromBNA is active and the polygons
define eventType.</p>
<p>Empty: Do not set type.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-rc.eventTypeNegative">
<span class="sig-name descname"><span class="pre">rc.eventTypeNegative</span></span><a class="headerlink" href="#confval-rc.eventTypeNegative" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&quot;outside</span> <span class="pre">of</span> <span class="pre">network</span> <span class="pre">interest&quot;</span></code></p>
<p>Type: <em>string</em></p>
<p>New type of an event which is flagged negative. Ignored
if readEventTypeFromBNA is active and the polygons
define eventType.</p>
<p>Empty means default: &quot;outside of network interest&quot;</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">RegionCheck</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#definition-of-regions">Definition of regions</a></li>
<li><a class="reference internal" href="#treatment-of-events">Treatment of events</a></li>
<li><a class="reference internal" href="#event-types">Event types</a><ul>
<li><a class="reference internal" href="#type-definition">Type definition</a></li>
<li><a class="reference internal" href="#event-type-from-polygon">Event type from polygon</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#setting-up-the-plugin">Setting up the Plugin</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scevent_eventtype.html"
title="previous chapter">EventType</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../toc/extensions/scm.html"
title="next chapter">scm</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scevent_regioncheck.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,441 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scevtlog &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scevtls" href="scevtls.html" />
<link rel="prev" title="scdumpcfg" href="scdumpcfg.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">6.9.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="scevtls.html" title="scevtls"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scdumpcfg.html" title="scdumpcfg"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scevtlog">
<span id="id1"></span><h1>scevtlog<a class="headerlink" href="#scevtlog" title="Permalink to this heading"></a></h1>
<p><strong>Event log preserving the history of updates.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Running SeisComP causes many database accesses for writing. Anytime a new
event has been created a new row will be inserted in the database table.
When the same event is updated the row in the database table is going to be
changed as well. The information about the history of the event is lost because
the database contains only the current event attributes. scevtlog saves the
event history into files. While scevtlog is running it keeps the track of all
event updates and stores this information in a directory that can be analyzed
at anytime. The stored information is written as plain text in an easily
readable format. Additionally scevtlog maintains an event summary file for an
overview of the event history.</p>
</section>
<section id="module-configuration">
<span id="scevtlog-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scevtlog.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scevtlog.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scevtlog.cfg</span></code></div>
</div>
<p>scevtlog inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-directory">
<span class="sig-name descname"><span class="pre">directory</span></span><a class="headerlink" href="#confval-directory" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;/events</span></code></p>
<p>Type: <em>string</em></p>
<p>Specify the output directory. Within this directory the logging
directory structure and the event files are stored.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-format">
<span class="sig-name descname"><span class="pre">format</span></span><a class="headerlink" href="#confval-format" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">xml</span></code></p>
<p>Type: <em>string</em></p>
<p>Specify output event format (default is autoloc3). For completeness
it is recommended to switch to xml as storage format. The autoloc3
format can be easily reconstructed with scbulletin but not the other
way around.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-gzip">
<span class="sig-name descname"><span class="pre">gzip</span></span><a class="headerlink" href="#confval-gzip" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If format is xml then all XML files will be compressed with gzip
and stored with file extension &quot;.xml.gz&quot;. They are also
valid gzip files and can be used as input to e.g. zgrep.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scevtlog [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-h">
<span id="cmdoption-scevtlog-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-V">
<span id="cmdoption-scevtlog-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-D">
<span id="cmdoption-scevtlog-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-v">
<span id="cmdoption-scevtlog-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-q">
<span id="cmdoption-scevtlog-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-s">
<span id="cmdoption-scevtlog-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-l">
<span id="cmdoption-scevtlog-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-u">
<span id="cmdoption-scevtlog-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-H">
<span id="cmdoption-scevtlog-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-t">
<span id="cmdoption-scevtlog-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-g">
<span id="cmdoption-scevtlog-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-S">
<span id="cmdoption-scevtlog-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-d">
<span id="cmdoption-scevtlog-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtlog-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="storage">
<h3>Storage<a class="headerlink" href="#storage" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-o">
<span id="cmdoption-scevtlog-directory"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--directory</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-o" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-directory"><code class="xref std std-confval docutils literal notranslate"><span class="pre">directory</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtlog-f">
<span id="cmdoption-scevtlog-format"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--format</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtlog-f" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-format"><code class="xref std std-confval docutils literal notranslate"><span class="pre">format</span></code></a>.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scevtlog</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#storage">Storage</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scdumpcfg.html"
title="previous chapter">scdumpcfg</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scevtls.html"
title="next chapter">scevtls</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scevtlog.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,401 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scevtls &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scevtstreams" href="scevtstreams.html" />
<link rel="prev" title="scevtlog" href="scevtlog.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">6.9.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="scevtstreams.html" title="scevtstreams"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scevtlog.html" title="scevtlog"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scevtls">
<span id="id1"></span><h1>scevtls<a class="headerlink" href="#scevtls" title="Permalink to this heading"></a></h1>
<p><strong>List event IDs from database.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>scevtls</em> lists the event IDs of all events available in a database or
<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> file within a given time span. The list may be filtered by
event type. The IDs are printed to stdout.</p>
<p>Similarly, use <a class="reference internal" href="scorgls.html#scorgls"><span class="std std-ref">scorgls</span></a> for listing all origin IDs. In extension to
<em>scevtls</em> and <a class="reference internal" href="scorgls.html#scorgls"><span class="std std-ref">scorgls</span></a>, <a class="reference internal" href="scquery.html#scquery"><span class="std std-ref">scquery</span></a> can search for parameters based on
complex custom queries.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Print all event IDs for the complete year 2012:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtls<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--begin<span class="w"> </span><span class="s2">&quot;2012-01-01 00:00:00&quot;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--end<span class="w"> </span><span class="s2">&quot;2013-01-01 00:00:00&quot;</span>
</pre></div>
</div>
</li>
<li><p>Print all event IDs with event type <em>quarry blast</em>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtls<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--event-type<span class="w"> </span><span class="s2">&quot;quarry blast&quot;</span>
</pre></div>
</div>
</li>
<li><p>Print the IDs of all events provided with the XML file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtls<span class="w"> </span>-i<span class="w"> </span>events.xml
</pre></div>
</div>
</li>
<li><p>Print all event IDs along with the ID of the preferred origin:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtls<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-p
</pre></div>
</div>
</li>
</ul>
</section>
<section id="module-configuration">
<span id="scevtls-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scevtls.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scevtls.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scevtls.cfg</span></code></div>
</div>
<p>scevtls inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scevtls [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-h">
<span id="cmdoption-scevtls-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-V">
<span id="cmdoption-scevtls-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-v">
<span id="cmdoption-scevtls-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-q">
<span id="cmdoption-scevtls-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-s">
<span id="cmdoption-scevtls-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-l">
<span id="cmdoption-scevtls-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-d">
<span id="cmdoption-scevtls-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-i">
<span id="cmdoption-scevtls-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-i" title="Permalink to this definition"></a></dt>
<dd><p>Name of input XML file. Read from stdin if - is given.
Deactivates reading events from database.</p>
</dd></dl>
</section>
<section id="events">
<h3>Events<a class="headerlink" href="#events" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-begin">
<span class="sig-name descname"><span class="pre">--begin</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scevtls-begin" title="Permalink to this definition"></a></dt>
<dd><p>Specify the lower bound of the time interval. Format:
2012-01-01T00:00:00.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-end">
<span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scevtls-end" title="Permalink to this definition"></a></dt>
<dd><p>Specify the upper bound of the time interval. Format:
2012-01-01T00:00:00.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-hours">
<span class="sig-name descname"><span class="pre">--hours</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-hours" title="Permalink to this definition"></a></dt>
<dd><p>Start searching given hours before now. If set, --begin and
--end are ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-modified-after">
<span class="sig-name descname"><span class="pre">--modified-after</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scevtls-modified-after" title="Permalink to this definition"></a></dt>
<dd><p>Print IDs of events modified after the specified time.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-event-type">
<span class="sig-name descname"><span class="pre">--event-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtls-event-type" title="Permalink to this definition"></a></dt>
<dd><p>The event type for filtering events.
Use quotes for types with more than one word.
Example: &quot;mining explosion&quot;.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-D">
<span id="cmdoption-scevtls-delimiter"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--delimiter</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-scevtls-D" title="Permalink to this definition"></a></dt>
<dd><p>Specify the delimiter of the resulting event IDs.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtls-p">
<span id="cmdoption-scevtls-preferred-origin"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--preferred-origin</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtls-p" title="Permalink to this definition"></a></dt>
<dd><p>Print the ID of the preferred origin along with the event
ID.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scevtls</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#events">Events</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scevtlog.html"
title="previous chapter">scevtlog</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scevtstreams.html"
title="next chapter">scevtstreams</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scevtls.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,510 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scevtstreams &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scimex" href="scimex.html" />
<link rel="prev" title="scevtls" href="scevtls.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">6.9.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="scimex.html" title="scimex"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scevtls.html" title="scevtls"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scevtstreams">
<span id="id1"></span><h1>scevtstreams<a class="headerlink" href="#scevtstreams" title="Permalink to this heading"></a></h1>
<p><strong>Extract stream information with time windows from picks of an event.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scevtstreams reads all picks of an event and determines the time window between
the first pick and the last pick. In addition a symmetric or an asymmetric time
margin is added to this
time window. It writes the streams that are picked including the determined
time window for the event to stdout. This tool gives appropriate input
information for <a class="reference internal" href="scart.html#scart"><span class="std std-ref">scart</span></a>, <a class="reference internal" href="fdsnws.html#fdsnws"><span class="std std-ref">fdsnws</span></a> and <span id="id2"><em>capstool</em> [<a class="reference internal" href="../base/references.html#id94" title="capstool. gempa plugin. URL: https://docs.gempa.de/caps/current/apps/capstool.html.">27</a>]</span> for
<span id="id3"><em>CAPS</em> [<a class="reference internal" href="../base/references.html#id91" title="CAPS. gempa module. URL: https://docs.gempa.de/caps/current/index.html.">3</a>]</span> server (Common Acquisition Protocol Server by gempa GmbH) to dump
waveforms from archives based on event data.</p>
</section>
<section id="output-format">
<h2>Output Format<a class="headerlink" href="#output-format" title="Permalink to this heading"></a></h2>
<p>The generated list contains start and end time as well as stream information.</p>
<p>Generic:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">starttime;endtime;stream</span>
</pre></div>
</div>
<p>Example:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">2019-07-17</span><span class="w"> </span><span class="s">02:00:00;2019-07-17 02:10:00;GR.CLL..BHZ</span>
</pre></div>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Get the time windows for an event in the database:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtstreams<span class="w"> </span>-E<span class="w"> </span>gfz2012abcd<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
</li>
<li><p>Get the asymmetric time windows for an event in an XML file. The time window
starts 120 s before the first pick and ends 500 s after the last pick:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtstreams<span class="w"> </span>-E<span class="w"> </span>gfz2012abcd<span class="w"> </span>-i<span class="w"> </span>event.xml<span class="w"> </span>-m<span class="w"> </span><span class="m">120</span>,500
</pre></div>
</div>
</li>
<li><p>Create a playback of an event with a time window of 5 minutes data and
sort the records by end time:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtstreams<span class="w"> </span>-E<span class="w"> </span>gfz2012abcd<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-m<span class="w"> </span><span class="m">300</span><span class="w"> </span><span class="p">|</span><span class="se">\</span>
scart<span class="w"> </span>-dsvE<span class="w"> </span>--list<span class="w"> </span>-<span class="w"> </span>~/seiscomp/acquisition/archive<span class="w"> </span>&gt;<span class="w"> </span>gfz2012abcd-sorted.mseed
</pre></div>
</div>
</li>
<li><p>Download waveforms from Arclink and import into local archive. Include
all stations from the contributing networks:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtstreams<span class="w"> </span>-E<span class="w"> </span>gfz2012abcd<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-m<span class="w"> </span><span class="m">300</span><span class="w"> </span>-R<span class="w"> </span>--all-stations<span class="w"> </span><span class="p">|</span><span class="se">\</span>
scart<span class="w"> </span>--list<span class="w"> </span>-<span class="w"> </span>./my-archive
</pre></div>
</div>
</li>
<li><p>Create lists compatible with <a class="reference internal" href="fdsnws.html#fdsnws"><span class="std std-ref">fdsnws</span></a> or <a class="reference external" href="https://docs.gempa.de/caps/current/apps/capstool.html">caps</a>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scevtstreams -E gfz2012abcd -i event.xml -m 120,500 --fdsnws
scevtstreams -E gfz2012abcd -i event.xml -m 120,500 --caps
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="scevtstreams-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scevtstreams.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scevtstreams.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scevtstreams.cfg</span></code></div>
</div>
<p>scevtstreams inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scevtstreams [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-h">
<span id="cmdoption-scevtstreams-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-V">
<span id="cmdoption-scevtstreams-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-D">
<span id="cmdoption-scevtstreams-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-v">
<span id="cmdoption-scevtstreams-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-q">
<span id="cmdoption-scevtstreams-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-s">
<span id="cmdoption-scevtstreams-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-l">
<span id="cmdoption-scevtstreams-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-d">
<span id="cmdoption-scevtstreams-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-i">
<span id="cmdoption-scevtstreams-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-i" title="Permalink to this definition"></a></dt>
<dd><p>Input XML file name. Reads event from the XML file instead of
database. Use - to read from stdin.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-f">
<span id="cmdoption-scevtstreams-format"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--format</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-f" title="Permalink to this definition"></a></dt>
<dd><p>Input format to use (xml [default], zxml (zipped xml),
binary). Only relevant with -i.</p>
</dd></dl>
</section>
<section id="dump">
<h3>Dump<a class="headerlink" href="#dump" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-E">
<span id="cmdoption-scevtstreams-event"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--event</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-E" title="Permalink to this definition"></a></dt>
<dd><p>The ID of the event to consider.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-net-sta">
<span class="sig-name descname"><span class="pre">--net-sta</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-net-sta" title="Permalink to this definition"></a></dt>
<dd><p>Filter read picks by network code or network and station
code. Format: NET or NET.STA</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-nslc">
<span class="sig-name descname"><span class="pre">--nslc</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-nslc" title="Permalink to this definition"></a></dt>
<dd><p>Stream list file to be used for filtering read picks by
stream code. --net-sta will be ignored. One line per
stream. Line format: NET.STA.LOC.CHA.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-m">
<span id="cmdoption-scevtstreams-margin"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--margin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-m" title="Permalink to this definition"></a></dt>
<dd><p>Time margin around the picked time window, default is 300.
Added before the first and after the last pick,
respectively. Use 2 comma-separted values (before,after)
for asymmetric margins. Example: 120,300.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-S">
<span id="cmdoption-scevtstreams-streams"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--streams</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-S" title="Permalink to this definition"></a></dt>
<dd><p>Comma separated list of streams per station to add.
Example: BH,SH,HH.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-C">
<span id="cmdoption-scevtstreams-all-components"></span><span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--all-components</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-C" title="Permalink to this definition"></a></dt>
<dd><p>Specify whether to use all components (1) or just the
picked ones (0). Default: 1.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-L">
<span id="cmdoption-scevtstreams-all-locations"></span><span class="sig-name descname"><span class="pre">-L</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--all-locations</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scevtstreams-L" title="Permalink to this definition"></a></dt>
<dd><p>Specify whether to use all location codes (1) or just
the picked ones (0). Default: 1.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-all-stations">
<span class="sig-name descname"><span class="pre">--all-stations</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-all-stations" title="Permalink to this definition"></a></dt>
<dd><p>Dump all stations from the same network. If unused, just
stations with picks are dumped.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-all-networks">
<span class="sig-name descname"><span class="pre">--all-networks</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-all-networks" title="Permalink to this definition"></a></dt>
<dd><p>Dump all networks. If unused, just networks with picks are
dumped. This option implies --all-stations, --all-locations,
--all-streams, --all-components and will only provide the
time window.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-R">
<span id="cmdoption-scevtstreams-resolve-wildcards"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--resolve-wildcards</span></span><span class="sig-prename descclassname"> <span class="pre">flag</span></span><a class="headerlink" href="#cmdoption-scevtstreams-R" title="Permalink to this definition"></a></dt>
<dd><p>If all components are used, use inventory to resolve stream
components instead of using ? (important when Arclink
should be used).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-caps">
<span class="sig-name descname"><span class="pre">--caps</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevtstreams-caps" title="Permalink to this definition"></a></dt>
<dd><p>Dump in capstool format (Common Acquisition Protocol Server
by gempa GmbH).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scevtstreams-fdsnws">
<span class="sig-name descname"><span class="pre">--fdsnws</span></span><span class="sig-prename descclassname"> <span class="pre">flag</span></span><a class="headerlink" href="#cmdoption-scevtstreams-fdsnws" title="Permalink to this definition"></a></dt>
<dd><p>Dump in FDSN dataselect webservice POST format.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scevtstreams</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#output-format">Output Format</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#dump">Dump</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scevtls.html"
title="previous chapter">scevtls</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scimex.html"
title="next chapter">scimex</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scevtstreams.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,867 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scheli &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scmm" href="scmm.html" />
<link rel="prev" title="scesv" href="scesv.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">6.9.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="scmm.html" title="scmm"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scesv.html" title="scesv"
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scheli">
<span id="id1"></span><h1>scheli<a class="headerlink" href="#scheli" title="Permalink to this heading"></a></h1>
<p><strong>Real-time helicorder view for one stream.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><strong class="program">scheli</strong> visualizes waveforms from a single stream or multiple stations
mimicking a drum-recorder plot (see <a class="reference internal" href="#fig-scheli"><span class="std std-ref">scheli in GUI mode</span></a>):</p>
<ul class="simple">
<li><p><strong class="program">scheli</strong> plots one configurable trace in helicorder style in the
<a class="reference internal" href="../base/glossary.html#term-GUI"><span class="xref std std-term">GUI</span></a> (<a class="reference internal" href="#scheli-show"><span class="std std-ref">GUI mode</span></a>).</p></li>
<li><p>Configurable GUI: trace colors, visualized time spans, number of rows, data filtering,
amplitude ranges and much more.</p></li>
<li><p>Automatic image capturing: Capture helicorder images at configurable time intervals
of one trace in <a class="reference internal" href="#scheli-show"><span class="std std-ref">GUI mode</span></a> or a set of multiple channels in
<a class="reference internal" href="#scheli-capture"><span class="std std-ref">capture mode</span></a>.
The images can be used, e.g. for showing data images on web sites.</p></li>
</ul>
<figure class="align-center" id="id2">
<span id="fig-scheli"></span><a class="reference internal image-reference" href="../_images/scheli.png"><img alt="../_images/scheli.png" src="../_images/scheli.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">scheli in GUI mode</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic" id="scheli-show">
<li><p><strong>GUI mode - Simple helicorder window:</strong></p>
<ul>
<li><p>Learn about the plenty command-line options for <strong class="program">scheli</strong>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli -h
</pre></div>
</div>
</li>
<li><p>Start <strong class="program">scheli</strong> with the configured values and informative debug output:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli --debug
</pre></div>
</div>
</li>
<li><p>Let <strong class="program">scheli</strong> show data from the CX station PB01 for the previous 5 hours
overriding configuration by command-line paramaters:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scheli<span class="w"> </span>--stream<span class="w"> </span>CX.PB01..HHZ<span class="w"> </span>--rows<span class="w"> </span><span class="m">10</span>
</pre></div>
</div>
</li>
<li><p>Define the data request window by end time and duration; scale traces to the
maximum amplitude per row:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli --stream IU.TSUM.00.BHZ --end-time &quot;2021-04-22 14:00:00&quot; --time-span 600 --amp-scaling row
</pre></div>
</div>
</li>
</ul>
</li>
</ol>
<ol class="arabic" id="scheli-capture" start="2">
<li><p><strong>Capture mode - Image capturing:</strong></p>
<p>Capture the helicorder plot for 3 stations in intervals of 10 seconds.
The data is retrieved using seedlink and the plots are stored as PNG images.
The image files are named according to network, station, stream and location codes
of the requested stations. Command-line parameters override the module configuration.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scheli<span class="w"> </span>capture<span class="w"> </span>--stream<span class="w"> </span>CX.PB01..HHZ<span class="w"> </span>--stream<span class="w"> </span>CX.PB02..HHZ<span class="w"> </span>--stream<span class="w"> </span>CX.PB04..HHZ<span class="w"> </span>--interval<span class="w"> </span><span class="m">10</span><span class="w"> </span>-o<span class="w"> </span><span class="s2">&quot;/tmp/heli_%N_%S_%L_%C.png&quot;</span><span class="w"> </span>-H<span class="w"> </span>localhost<span class="w"> </span>-I<span class="w"> </span>slink://localhost
</pre></div>
</div>
<p>The output file names will be generated based on network code (%N), station code (%S),
location code (%L) and stream code (%C):</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/tmp/CX.PB01..HHZ.png
/tmp/CX.PB02..HHZ.png
/tmp/CX.PB04..HHZ.png
</pre></div>
</div>
</li>
</ol>
</section>
<section id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading"></a></h2>
<p>Specifc <strong class="program">scheli</strong> parameters are adjusted in the <a class="reference internal" href="#scheli-configuration"><span class="std std-ref">module configuration</span></a>.
Colors of traces etc. can be adjusted by setting the <em>scheme</em> parameters in
the global configuration of scheli. For alternating colors between the traces
set the parameters scheme.colors.records.foreground and
scheme.colors.records.alternateForeground in <code class="file docutils literal notranslate"><span class="pre">scheli.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># The general color of records/traces.</span>
scheme.colors.records.foreground<span class="w"> </span><span class="o">=</span><span class="w"> </span>4286F4
<span class="c1"># A general trace color of the alternate trace (eg scheli).</span>
scheme.colors.records.alternateForeground<span class="w"> </span><span class="o">=</span><span class="w"> </span>B72D0E
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scheli-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scheli.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scheli.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scheli.cfg</span></code></div>
</div>
<p>scheli inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.streams">
<span class="sig-name descname"><span class="pre">heli.streams</span></span><a class="headerlink" href="#confval-heli.streams" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of stream codes to be plotted (net.sta.loc.cha).
If not in capture mode only the first stream is shown.
When using a list, the first entry is considered.
Use commas for separating streams.</p>
<p>Example: GR.MOX..BHZ</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.filter">
<span class="sig-name descname"><span class="pre">heli.filter</span></span><a class="headerlink" href="#confval-heli.filter" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Filter to be applied on the data.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.numberOfRows">
<span class="sig-name descname"><span class="pre">heli.numberOfRows</span></span><a class="headerlink" href="#confval-heli.numberOfRows" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">48</span></code></p>
<p>Type: <em>integer</em></p>
<p>Filter to be applied on the data.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.rowTimeSpan">
<span class="sig-name descname"><span class="pre">heli.rowTimeSpan</span></span><a class="headerlink" href="#confval-heli.rowTimeSpan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1800</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Length of data per trace.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.timeFormat">
<span class="sig-name descname"><span class="pre">heli.timeFormat</span></span><a class="headerlink" href="#confval-heli.timeFormat" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">%F</span></code></p>
<p>Type: <em>string</em></p>
<p>The time format used to print the start and end time of the
whole plot (upper right corner). The format specification is
the one used in the strftime function (man strftime).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.recordTime">
<span class="sig-name descname"><span class="pre">heli.recordTime</span></span><a class="headerlink" href="#confval-heli.recordTime" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Set current time to last data sample.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.lineWidth">
<span class="sig-name descname"><span class="pre">heli.lineWidth</span></span><a class="headerlink" href="#confval-heli.lineWidth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>px</em></p>
<p>Line width of traces.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.colors">
<span class="sig-name descname"><span class="pre">heli.colors</span></span><a class="headerlink" href="#confval-heli.colors" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">FF0000,</span> <span class="pre">0000FF</span></code></p>
<p>Type: <em>list:string</em></p>
<p>A list of alternating row colors cycled through for painting
traces.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.antialiasing">
<span class="sig-name descname"><span class="pre">heli.antialiasing</span></span><a class="headerlink" href="#confval-heli.antialiasing" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use anti aliasing to plot the traces. The default uses the
settings from scheme.records.antiAliasing</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.stream.description">
<span class="sig-name descname"><span class="pre">heli.stream.description</span></span><a class="headerlink" href="#confval-heli.stream.description" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Add stream description to traces.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>heli.amplitudeRange.*</strong>
<em>Gain-corrected amplitudes given in units of the sensor.</em>
<em>For example: m/s.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.amplitudeRange.scaling">
<span class="sig-name descname"><span class="pre">heli.amplitudeRange.scaling</span></span><a class="headerlink" href="#confval-heli.amplitudeRange.scaling" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">minmax</span></code></p>
<p>Type: <em>string</em></p>
<p>Define the method to scale traces within rows. Possible
values are:</p>
<p>minmax: Scale all rows to configured minimum and maximum
amplitudes configured by amplitudeRange.min and
amplitudeRange.max</p>
<p>row: Scale each row to the maximum within this row.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.amplitudeRange.min">
<span class="sig-name descname"><span class="pre">heli.amplitudeRange.min</span></span><a class="headerlink" href="#confval-heli.amplitudeRange.min" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-0.00001</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>unit of input data</em></p>
<p>Minimum amplitude to show in trace. Requires
amplitudeRange.scale = &quot;minmax&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.amplitudeRange.max">
<span class="sig-name descname"><span class="pre">heli.amplitudeRange.max</span></span><a class="headerlink" href="#confval-heli.amplitudeRange.max" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.00001</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>unit of input data</em></p>
<p>Minimum amplitude to show in trace. Requires
amplitudeRange.scale = &quot;minmax&quot;.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>heli.dump.*</strong>
<em>Control dumping of PNG images.</em>
<em>Execute “scheli capture” for image generation in</em>
<em>the background without the graphics.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.dump.interval">
<span class="sig-name descname"><span class="pre">heli.dump.interval</span></span><a class="headerlink" href="#confval-heli.dump.interval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>s</em></p>
<p>Image creation interval. Negative values disable image
dumping.
If enabled, images are generated at the configured
interval.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.dump.outputFile">
<span class="sig-name descname"><span class="pre">heli.dump.outputFile</span></span><a class="headerlink" href="#confval-heli.dump.outputFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/tmp/heli_%N_%S_%L_%C.png</span></code></p>
<p>Type: <em>string</em></p>
<p>Name of output file.
The filename can contain placeholders
that are replaced by the corresponding streamID parts:</p>
<p>%N : network code</p>
<p>%S : station code</p>
<p>%L : location code</p>
<p>%C : channel code</p>
<p>Placeholders are important if more than one stream
is given and capture mode is active.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.dump.dpi">
<span class="sig-name descname"><span class="pre">heli.dump.dpi</span></span><a class="headerlink" href="#confval-heli.dump.dpi" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>dpi</em></p>
<p>Image resolution.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.dump.xres">
<span class="sig-name descname"><span class="pre">heli.dump.xres</span></span><a class="headerlink" href="#confval-heli.dump.xres" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1024</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>px</em></p>
<p>Number of pixels horizontally.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-heli.dump.yres">
<span class="sig-name descname"><span class="pre">heli.dump.yres</span></span><a class="headerlink" href="#confval-heli.dump.yres" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">768</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>px</em></p>
<p>Number of pixels vertically.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.postprocessing">
<span class="sig-name descname"><span class="pre">scripts.postprocessing</span></span><a class="headerlink" href="#confval-scripts.postprocessing" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
<p>Define the path to a script that is called whenever an image
has been captured and written to disc. The only parameter is
the path to the generated image.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scheli [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-h">
<span id="cmdoption-scheli-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-V">
<span id="cmdoption-scheli-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-D">
<span id="cmdoption-scheli-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-v">
<span id="cmdoption-scheli-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-q">
<span id="cmdoption-scheli-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-s">
<span id="cmdoption-scheli-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-l">
<span id="cmdoption-scheli-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-u">
<span id="cmdoption-scheli-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-H">
<span id="cmdoption-scheli-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-t">
<span id="cmdoption-scheli-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-g">
<span id="cmdoption-scheli-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-S">
<span id="cmdoption-scheli-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-d">
<span id="cmdoption-scheli-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-config-db">
<span class="sig-name descname"><span class="pre">--config-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-config-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the configuration from the given database or file,
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
</section>
<section id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-I">
<span id="cmdoption-scheli-record-url"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="user-interface">
<h3>User interface<a class="headerlink" href="#user-interface" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-F">
<span id="cmdoption-scheli-full-screen"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--full-screen</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-F" title="Permalink to this definition"></a></dt>
<dd><p>Start the application filling the entire screen.
This only works with GUI applications.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-N">
<span id="cmdoption-scheli-non-interactive"></span><span class="sig-name descname"><span class="pre">-N</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--non-interactive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-N" title="Permalink to this definition"></a></dt>
<dd><p>Use non-interactive presentation mode. This only works with
GUI applications.</p>
</dd></dl>
</section>
<section id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-offline">
<span class="sig-name descname"><span class="pre">--offline</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-offline" title="Permalink to this definition"></a></dt>
<dd><p>Do not connect to a messaging server and do not use the
database.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-end-time">
<span class="sig-name descname"><span class="pre">--end-time</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-end-time" title="Permalink to this definition"></a></dt>
<dd><p>Set the acquisition end time, e.g. 2017-09-08 13:30:00,
default: gmt</p>
</dd></dl>
</section>
<section id="data">
<h3>Data<a class="headerlink" href="#data" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-stream">
<span class="sig-name descname"><span class="pre">--stream</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-stream" title="Permalink to this definition"></a></dt>
<dd><p>The record stream that should be displayed. Can be used
multiple times for multiple streams.</p>
<p>Example: GR.MOX..BHZ (net.sta.loc.cha)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-filter">
<span class="sig-name descname"><span class="pre">--filter</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-filter" title="Permalink to this definition"></a></dt>
<dd><p>The filter to apply</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-gain">
<span class="sig-name descname"><span class="pre">--gain</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-gain" title="Permalink to this definition"></a></dt>
<dd><p>Gain applied to the data before plotting</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-amp-scaling">
<span class="sig-name descname"><span class="pre">--amp-scaling</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-scaling" title="Permalink to this definition"></a></dt>
<dd><p>Lower bound of amplitude range per row. Possible values:</p>
<p>minmax: Scale all rows to configured minimum and maximum
amplitudes.</p>
<p>row: Scale each row to the maximum within this row.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-amp-range-min">
<span class="sig-name descname"><span class="pre">--amp-range-min</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-range-min" title="Permalink to this definition"></a></dt>
<dd><p>Lower bound of amplitude range per row</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-amp-range-max">
<span class="sig-name descname"><span class="pre">--amp-range-max</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-range-max" title="Permalink to this definition"></a></dt>
<dd><p>Upper bound of amplitude range per row</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-amp-range">
<span class="sig-name descname"><span class="pre">--amp-range</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-range" title="Permalink to this definition"></a></dt>
<dd><p>Arround zero bound of amplitude range per row</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-record-time">
<span class="sig-name descname"><span class="pre">--record-time</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-record-time" title="Permalink to this definition"></a></dt>
<dd><p>Do the last row always contain the last record received</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-desc">
<span class="sig-name descname"><span class="pre">--desc</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-desc" title="Permalink to this definition"></a></dt>
<dd><p>Enable/disable the display of a station description</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-rows">
<span class="sig-name descname"><span class="pre">--rows</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-rows" title="Permalink to this definition"></a></dt>
<dd><p>Configure the number of rows to display</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-time-span">
<span class="sig-name descname"><span class="pre">--time-span</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-time-span" title="Permalink to this definition"></a></dt>
<dd><p>Configure the time-span (in secs) per row. Unit: seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-aa">
<span class="sig-name descname"><span class="pre">--aa</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-aa" title="Permalink to this definition"></a></dt>
<dd><p>Set antialiasing for rendering the traces</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-xres">
<span class="sig-name descname"><span class="pre">--xres</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-xres" title="Permalink to this definition"></a></dt>
<dd><p>Output x resolution when generating images. Unit: dpi.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-yres">
<span class="sig-name descname"><span class="pre">--yres</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-yres" title="Permalink to this definition"></a></dt>
<dd><p>Output y resolution when generating images. Unit: dpi.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-dpi">
<span class="sig-name descname"><span class="pre">--dpi</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-dpi" title="Permalink to this definition"></a></dt>
<dd><p>Output dpi when generating postscript. Unit:dpi.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-o">
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-o" title="Permalink to this definition"></a></dt>
<dd><p>Output filename. Placeholders are %N,%S,%L,%C for network
code, station code, location code, channel code.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scheli-interval">
<span class="sig-name descname"><span class="pre">--interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-interval" title="Permalink to this definition"></a></dt>
<dd><p>Snapshot interval (less than 0 disables timed snapshots).
Unit: seconds.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scheli</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#data">Data</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scesv.html"
title="previous chapter">scesv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scmm.html"
title="next chapter">scmm</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scheli.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,616 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scimex &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scimport" href="scimport.html" />
<link rel="prev" title="scevtstreams" href="scevtstreams.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">6.9.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="scimport.html" title="scimport"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scevtstreams.html" title="scevtstreams"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scimex">
<span id="id1"></span><h1>scimex<a class="headerlink" href="#scimex" title="Permalink to this heading"></a></h1>
<p><strong>SeisComP event exchange between two systems.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scimex manages the <cite>SeisComP</cite> object exchange between two or more different SeisComP systems in
real time. scimex may import or export the data to one or several systems. In
contrary to <a class="reference internal" href="scimport.html#scimport"><span class="std std-ref">scimport</span></a> the exchange of the <cite>SeisComP</cite> objects is event based.
This means no messages will be exchanged until the exporting system has produced
an event.</p>
<p>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: <em>import</em> and <em>export</em>. In export mode scimex collects all objects
relevant for an event (e.g. picks, amplitudes, origins, magnitudes) from
scmasters 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.</p>
<p>At the receiving <cite>SeisComP</cite> 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:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>scimex_import<span class="w"> </span>scimex
</pre></div>
</div>
<p>and for export:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>scimex_export<span class="w"> </span>scimex
</pre></div>
</div>
<p>Then the configuration can be split into scimex_import.cfg and
scimex_export.cfg.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>For a push-type configuration, in which the exporting server must be able to
connect to the messaging server on the receiving host. On the receiving host:</p>
<p>scimex_import.cfg</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>connection.username<span class="w"> </span><span class="o">=</span><span class="w"> </span>scimexIm
connection.server<span class="w"> </span><span class="o">=</span><span class="w"> </span>localhost
<span class="nv">mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>IMPORT
<span class="nv">cleanupinterval</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">86400</span>
<span class="nv">importHosts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>import1
criteria.world.longitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>-180:180
criteria.world.latitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>-90:90
criteria.world.magnitude<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>:9
criteria.world.agencyID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;&quot;</span>
criteria.world.arrivalcount<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">15</span>
hosts.import1.address<span class="w"> </span><span class="o">=</span><span class="w"> </span>localhost
<span class="c1"># The criterion &quot;world&quot; has been defined above</span>
hosts.import1.criteria<span class="w"> </span><span class="o">=</span><span class="w"> </span>world
<span class="c1"># optional and true per default</span>
hosts.import1.filter<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span>
<span class="c1"># optional and true per default</span>
hosts.import1.useDefinedRoutingTable<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span>
hosts.import1.routingtable<span class="w"> </span><span class="o">=</span><span class="w"> </span>Pick:IMPORT,StationAmplitude:IMPORT,
<span class="w"> </span>Origin:LOCATION,Arrival:LOCATION,
<span class="w"> </span>StationMagnitude:MAGNITUDE,
<span class="w"> </span>Magnitude:MAGNITUDE,
<span class="w"> </span>StationMagnitudeContribution:MAGNITUDE,
<span class="w"> </span>OriginReference:EVENT,Event:EVENT
</pre></div>
</div>
<p>In this example, Pick and StationAmplitude objects are sent to the
receiving systems IMPORT group to avoid interfering with the receiving systems
picking.</p>
<p>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</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>connection.username<span class="o">=</span><span class="s2">&quot;scimexEx&quot;</span>
connection.server<span class="w"> </span><span class="o">=</span><span class="w"> </span>localhost
<span class="nv">mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>EXPORT
<span class="nv">cleanupinterval</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">7200</span>
<span class="nv">exportHosts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>exp1,<span class="w"> </span>exp2
<span class="c1"># Match everything with magnitude above or equal 5</span>
<span class="c1"># and with more than 25 phases which comes from</span>
<span class="c1"># agency GFZ.</span>
criteria.globalM5.latitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>-90:90
criteria.globalM5.longitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>-180:180
criteria.globalM5.magnitude<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">5</span>:10
criteria.globalM5.arrivalcount<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">25</span>
criteria.globalM5.agencyID<span class="w"> </span><span class="o">=</span><span class="w"> </span>GFZ
<span class="c1"># Export to a system which still runs a very old version. The</span>
<span class="c1"># messages need to be converted.</span>
hosts.exp1.address<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">192</span>.168.0.3
hosts.exp1.criteria<span class="w"> </span><span class="o">=</span><span class="w"> </span>globalM5
hosts.exp1.conversion<span class="w"> </span><span class="o">=</span><span class="w"> </span>imexscdm0.51
hosts.exp2.address<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">192</span>.168.0.4
hosts.exp2.criteria<span class="w"> </span><span class="o">=</span><span class="w"> </span>globalM5
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scimex-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scimex.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scimex.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scimex.cfg</span></code></div>
</div>
<p>scimex inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mode">
<span class="sig-name descname"><span class="pre">mode</span></span><a class="headerlink" href="#confval-mode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Mode of operation. Options are IMPORT or EXPORT.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-cleanupinterval">
<span class="sig-name descname"><span class="pre">cleanupinterval</span></span><a class="headerlink" href="#confval-cleanupinterval" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Cache lifetime for objects.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-subscriptions">
<span class="sig-name descname"><span class="pre">subscriptions</span></span><a class="headerlink" href="#confval-subscriptions" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Only used in export mode. A list of message groups to subscribe.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-conversion">
<span class="sig-name descname"><span class="pre">conversion</span></span><a class="headerlink" href="#confval-conversion" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Used only in import mode. It defines the source format of the
messages that need to be converted. Currently the import of
SeisComP datamodel version 0.51 (imexscdm0.51)
is supported which was used in release Barcelona (2008).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-exportHosts">
<span class="sig-name descname"><span class="pre">exportHosts</span></span><a class="headerlink" href="#confval-exportHosts" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>A list of hosts profiles to be considered for exporting.
These are used in hosts.$name directives
(see below) to define addresses, filter criteria, etc.
applicable to each recipient.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-importHosts">
<span class="sig-name descname"><span class="pre">importHosts</span></span><a class="headerlink" href="#confval-importHosts" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>A list of hosts profiles to be considered for importing.
These are used with hosts.$name directives similarly to
exportHosts.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>criteria.$name.*</strong>
<em>A definition of an event filter.</em>
$name is a placeholder for the name to be used.</p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-criteria.-name.latitude">
<span class="sig-name descname"><span class="pre">criteria.$name.latitude</span></span><a class="headerlink" href="#confval-criteria.-name.latitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>tuple:double</em></p>
<p>Pair of doubles that defines the latitude range.
Example: -90:90.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-criteria.-name.longitude">
<span class="sig-name descname"><span class="pre">criteria.$name.longitude</span></span><a class="headerlink" href="#confval-criteria.-name.longitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>tuple:double</em></p>
<p>Pair of doubles that defines the longitude range.
Example: -180:180.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-criteria.-name.magnitude">
<span class="sig-name descname"><span class="pre">criteria.$name.magnitude</span></span><a class="headerlink" href="#confval-criteria.-name.magnitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>tuple:double</em></p>
<p>Pair of doubles that defines the magnitude range.
Example: 3:10.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-criteria.-name.arrivalcount">
<span class="sig-name descname"><span class="pre">criteria.$name.arrivalcount</span></span><a class="headerlink" href="#confval-criteria.-name.arrivalcount" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>int</em></p>
<p>Number of minimum arrivals.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-criteria.-name.agencyID">
<span class="sig-name descname"><span class="pre">criteria.$name.agencyID</span></span><a class="headerlink" href="#confval-criteria.-name.agencyID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>White list of AgencyIDs (the agency identifier which
appears in the objects sent over the export-import link).</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>hosts.$name.*</strong>
<em>A sink definition used for either import or export.</em>
$name is a placeholder for the name to be used.</p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts.-name.address">
<span class="sig-name descname"><span class="pre">hosts.$name.address</span></span><a class="headerlink" href="#confval-hosts.-name.address" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>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</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts.-name.criteria">
<span class="sig-name descname"><span class="pre">hosts.$name.criteria</span></span><a class="headerlink" href="#confval-hosts.-name.criteria" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Defining filter criteria name for sink, e.g. criteria =
world-xxl. The criteria must be defined in the criteria.
* configuration lines.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts.-name.filter">
<span class="sig-name descname"><span class="pre">hosts.$name.filter</span></span><a class="headerlink" href="#confval-hosts.-name.filter" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enable/disable filtering based on defined criteria.
If set to false, all events will pass, even if one
or more criteria are defined.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts.-name.conversion">
<span class="sig-name descname"><span class="pre">hosts.$name.conversion</span></span><a class="headerlink" href="#confval-hosts.-name.conversion" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Optional target format for export.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts.-name.useDefinedRoutingTable">
<span class="sig-name descname"><span class="pre">hosts.$name.useDefinedRoutingTable</span></span><a class="headerlink" href="#confval-hosts.-name.useDefinedRoutingTable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enable/disable defined routing tables.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-hosts.-name.routingTable">
<span class="sig-name descname"><span class="pre">hosts.$name.routingTable</span></span><a class="headerlink" href="#confval-hosts.-name.routingTable" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defining routing tables in the meaning of mapping
objects to message groups. Example: 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.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scimex [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-h">
<span id="cmdoption-scimex-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-V">
<span id="cmdoption-scimex-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-D">
<span id="cmdoption-scimex-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-v">
<span id="cmdoption-scimex-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-q">
<span id="cmdoption-scimex-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-s">
<span id="cmdoption-scimex-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-l">
<span id="cmdoption-scimex-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-u">
<span id="cmdoption-scimex-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-H">
<span id="cmdoption-scimex-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-t">
<span id="cmdoption-scimex-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-g">
<span id="cmdoption-scimex-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-S">
<span id="cmdoption-scimex-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimex-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="id2">
<h3>SCIMEX<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimex-print-default-routingtable">
<span class="sig-name descname"><span class="pre">--print-default-routingtable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimex-print-default-routingtable" title="Permalink to this definition"></a></dt>
<dd><p>Print the default object routing table.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scimex</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#id2">SCIMEX</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scevtstreams.html"
title="previous chapter">scevtstreams</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scimport.html"
title="next chapter">scimport</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scimex.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,721 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scimport &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scm" href="scm.html" />
<link rel="prev" title="scimex" href="scimex.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">6.9.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="scm.html" title="scm"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scimex.html" title="scimex"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scimport">
<span id="id1"></span><h1>scimport<a class="headerlink" href="#scimport" title="Permalink to this heading"></a></h1>
<p><strong>Forward messages across two SeisComP systems.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scimport is responsible to forward messages from one system to another. The
difference to <a class="reference internal" href="scimex.html#scimex"><span class="std std-ref">scimex</span></a> is that scimport does not handle the messages
event based. scimport supports two different modes. The relay mode does a
simple mapping from GROUP:SYSTEM_A to GROUP:SYSTEM_B. This mode is default.</p>
<p>In case GROUP is not defined in the second system the message is forwarded to
IMPORT_GROUP. The import mode supports custom mapping and filter functionality.
It is possible to forward GROUP1:SYSTEM_A to GROUP2:SYSTEM_B. In addition the
forwarded objects can be filtered by:</p>
<dl class="simple">
<dt>Pick</dt><dd><ul class="simple">
<li><p>Status</p></li>
<li><p>Mode</p></li>
<li><p>Phase</p></li>
<li><p>AgencyID</p></li>
</ul>
</dd>
<dt>Amplitude</dt><dd><ul class="simple">
<li><p>Amplitude</p></li>
</ul>
</dd>
<dt>Origin</dt><dd><ul class="simple">
<li><p>Location</p></li>
<li><p>Depth</p></li>
<li><p>AgencyID</p></li>
<li><p>Status</p></li>
<li><p>Mode</p></li>
</ul>
</dd>
<dt>Event</dt><dd><ul class="simple">
<li><p>Type</p></li>
</ul>
</dd>
<dt>StationMagnitude</dt><dd><ul class="simple">
<li><p>Type</p></li>
</ul>
</dd>
<dt>Magnitude</dt><dd><ul class="simple">
<li><p>Type</p></li>
</ul>
</dd>
</dl>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>Example scimport.cfg</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># The address of the importing system</span>
<span class="nv">sink</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>sinkAddress
<span class="c1"># This option has to be set if the application runs in import mode.</span>
<span class="c1"># The routing table has to be defined in the form of source_group:sink_group</span>
<span class="nv">routingtable</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>PICK:PICK
<span class="c1"># List of sink groups to subscribe to. If this option is not set the message</span>
<span class="c1"># groups will be determined automatically. If this option is set but not</span>
<span class="c1"># needed for a setup it can be ignored with the option --ignore-groups</span>
<span class="nv">msggroups</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>GROUP_ONE,<span class="w"> </span>GROUP_TWO
<span class="c1"># Available filter options</span>
filter.pick.mode<span class="w"> </span><span class="o">=</span><span class="w"> </span>manual
filter.pick.status<span class="w"> </span><span class="o">=</span><span class="w"> </span>confirmed
filter.pick.phase<span class="w"> </span><span class="o">=</span><span class="w"> </span>P
filter.pick.agencyID<span class="w"> </span><span class="o">=</span><span class="w"> </span>GFZ
<span class="c1"># Values: eq (==), lt (&lt;=) ,gt (&gt;=), *</span>
filter.amplitude.operator<span class="w"> </span><span class="o">=</span><span class="w"> </span>gt
filter.amplitude.amplitude<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">100</span>
<span class="c1"># Values: lat0:lat1 (range)</span>
filter.origin.latitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>-90:90
<span class="c1"># Values: lon0:lon1 (range)</span>
filter.origin.longitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>-180:180
filter.origin.depth<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>:100
filter.origin.agencyID<span class="w"> </span><span class="o">=</span><span class="w"> </span>GFZ
<span class="c1"># Values: automatic, manual</span>
filter.origin.mode<span class="w"> </span><span class="o">=</span><span class="w"> </span>manual
filter.origin.status<span class="w"> </span><span class="o">=</span><span class="w"> </span>confirmed
<span class="c1"># Values: earthquake, explosion, quarry blast, chemical explosion,</span>
<span class="c1"># nuclear explosion, landslide, debris avalanche, rockslide,</span>
<span class="c1"># mine collapse, volcanic eruption, meteor impact, plane crash,</span>
<span class="c1"># building collapse, sonic boom, other</span>
filter.event.type<span class="w"> </span><span class="o">=</span><span class="w"> </span>earthquake
<span class="c1"># Values: Whatever your magnitudes are named</span>
filter.stationMagnitude.type<span class="w"> </span><span class="o">=</span><span class="w"> </span>MLv
<span class="c1"># Values: Whatever your magnitudes are named</span>
filter.magnitude.type<span class="w"> </span><span class="o">=</span><span class="w"> </span>MLv
<span class="c1"># Values: latency, delay, timing quality, gaps interval, gaps length,</span>
<span class="c1"># spikes interval, spikes amplitude, offset, rms</span>
filter.qc.type<span class="w"> </span><span class="o">=</span><span class="w"> </span>latency
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scimport-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scimport.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scimport.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scimport.cfg</span></code></div>
</div>
<p>scimport inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-sink">
<span class="sig-name descname"><span class="pre">sink</span></span><a class="headerlink" href="#confval-sink" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>URI of receiving host which runs scmaster. The URI contains
the host name with an optional protocol and port.</p>
<p>Format: protocol://host:port</p>
<p>Examples:</p>
<p>- proc</p>
<p>- scmp://proc:18180</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-routingtable">
<span class="sig-name descname"><span class="pre">routingtable</span></span><a class="headerlink" href="#confval-routingtable" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>This option has to be set if the application runs in import mode.
The routing table has to be defined in the form of
source_group:sink_group</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-msggroups">
<span class="sig-name descname"><span class="pre">msggroups</span></span><a class="headerlink" href="#confval-msggroups" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define a list of message groups of the source system
(connection.server). If not specified, the source system is
queried for a list of message groups which are then used to check
each subscription extracted from the routing table.
This parameter allows to override to source query result.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-useFilter">
<span class="sig-name descname"><span class="pre">useFilter</span></span><a class="headerlink" href="#confval-useFilter" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p><em>No description available</em></p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.*</strong>
<em>Define filter criteria before sending.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.pick.*</strong>
<em>Criteria for filtering picks.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.pick.mode">
<span class="sig-name descname"><span class="pre">filter.pick.mode</span></span><a class="headerlink" href="#confval-filter.pick.mode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The mode of picks to filter for. Allowed values:
&quot;automatic&quot; and &quot;manual&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.pick.status">
<span class="sig-name descname"><span class="pre">filter.pick.status</span></span><a class="headerlink" href="#confval-filter.pick.status" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The status of picks to filter for. Allowed values:
&quot;preliminary&quot;, &quot;confirmed&quot;,
&quot;reviewed&quot;, &quot;final&quot;,
&quot;rejected&quot; and &quot;reported&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.pick.phase">
<span class="sig-name descname"><span class="pre">filter.pick.phase</span></span><a class="headerlink" href="#confval-filter.pick.phase" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The pick phase hint to filter for. Allowed values:
all possible phase codes.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.pick.agencyIDs">
<span class="sig-name descname"><span class="pre">filter.pick.agencyIDs</span></span><a class="headerlink" href="#confval-filter.pick.agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The pick agencyIDs to filter for. Allowed values:
all possible agency ids;</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.pick.networkCode">
<span class="sig-name descname"><span class="pre">filter.pick.networkCode</span></span><a class="headerlink" href="#confval-filter.pick.networkCode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The pick network code of the processed waveforms.
Allowed values: all possible network codes.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.amplitude.*</strong>
<em>Criteria for filtering amplitudes</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.amplitude.operator">
<span class="sig-name descname"><span class="pre">filter.amplitude.operator</span></span><a class="headerlink" href="#confval-filter.amplitude.operator" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The amplitude comparison operator. Allowed values:
&quot;eq&quot;, &quot;lt&quot;, &quot;gt&quot; and &quot;*&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.amplitude.amplitude">
<span class="sig-name descname"><span class="pre">filter.amplitude.amplitude</span></span><a class="headerlink" href="#confval-filter.amplitude.amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>double</em></p>
<p>The amplitude threshold to filter for. The operator
configured with &quot;operator&quot; is used to compare this threshold with
the incoming value. If &quot;operator&quot; is &quot;*&quot; then
values will pass.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.amplitude.agencyIDs">
<span class="sig-name descname"><span class="pre">filter.amplitude.agencyIDs</span></span><a class="headerlink" href="#confval-filter.amplitude.agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The amplitude agencyIDs to filter for. Allowed values:
all possible agency ids.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.origin.*</strong>
<em>Criteria for filtering origins</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.latitude">
<span class="sig-name descname"><span class="pre">filter.origin.latitude</span></span><a class="headerlink" href="#confval-filter.origin.latitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The latitude range in format [min]:[max].</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.longitude">
<span class="sig-name descname"><span class="pre">filter.origin.longitude</span></span><a class="headerlink" href="#confval-filter.origin.longitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The longitude range in format [min]:[max].</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.depth">
<span class="sig-name descname"><span class="pre">filter.origin.depth</span></span><a class="headerlink" href="#confval-filter.origin.depth" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The depth range in format [min]:[max].</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.agencyIDs">
<span class="sig-name descname"><span class="pre">filter.origin.agencyIDs</span></span><a class="headerlink" href="#confval-filter.origin.agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The origin agencyIDs to filter for. Allowed values:
all possible agency ids;</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.mode">
<span class="sig-name descname"><span class="pre">filter.origin.mode</span></span><a class="headerlink" href="#confval-filter.origin.mode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The origin evaluation mode to filter for. Allowed values:
&quot;automatic&quot; and &quot;manual&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.status">
<span class="sig-name descname"><span class="pre">filter.origin.status</span></span><a class="headerlink" href="#confval-filter.origin.status" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The origin status to filter for. Allowed values:
&quot;preliminary&quot;, &quot;confirmed&quot;,
&quot;reviewed&quot;, &quot;final&quot;,
&quot;rejected&quot; and &quot;reported&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.origin.arrivalcount">
<span class="sig-name descname"><span class="pre">filter.origin.arrivalcount</span></span><a class="headerlink" href="#confval-filter.origin.arrivalcount" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The minimum number of arrivals of an origin to pass
the filter.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.event.*</strong>
<em>Criteria for filtering events</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.event.type">
<span class="sig-name descname"><span class="pre">filter.event.type</span></span><a class="headerlink" href="#confval-filter.event.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The event type to filter for, e.g. &quot;earthquake&quot;,
&quot;explosion&quot;</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.stationMagnitude.*</strong>
<em>Criteria for filtering station magnitudes</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.stationMagnitude.type">
<span class="sig-name descname"><span class="pre">filter.stationMagnitude.type</span></span><a class="headerlink" href="#confval-filter.stationMagnitude.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The station magnitude type. Allowed values: all possible
magnitude types such as &quot;MLv&quot;.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.magnitude.*</strong>
<em>Criteria for filtering network magnitudes</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.magnitude.type">
<span class="sig-name descname"><span class="pre">filter.magnitude.type</span></span><a class="headerlink" href="#confval-filter.magnitude.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The magnitude type. Allowed values: all possible
magnitude types such as &quot;MLv&quot;.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>filter.qc.*</strong>
<em>Criteria for filtering QC parameters</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filter.qc.type">
<span class="sig-name descname"><span class="pre">filter.qc.type</span></span><a class="headerlink" href="#confval-filter.qc.type" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The QC parameter type. Allowed values: all possible
types such as &quot;latency&quot;, &quot;delay&quot;</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scimport [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-h">
<span id="cmdoption-scimport-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-V">
<span id="cmdoption-scimport-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-D">
<span id="cmdoption-scimport-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-v">
<span id="cmdoption-scimport-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-q">
<span id="cmdoption-scimport-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-s">
<span id="cmdoption-scimport-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-l">
<span id="cmdoption-scimport-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-u">
<span id="cmdoption-scimport-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-H">
<span id="cmdoption-scimport-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-t">
<span id="cmdoption-scimport-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-g">
<span id="cmdoption-scimport-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-S">
<span id="cmdoption-scimport-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scimport-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="import">
<h3>Import<a class="headerlink" href="#import" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-o">
<span id="cmdoption-scimport-sink"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sink</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-o" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-sink"><code class="xref std std-confval docutils literal notranslate"><span class="pre">sink</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-i">
<span id="cmdoption-scimport-import"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--import</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-i" title="Permalink to this definition"></a></dt>
<dd><p>Switch to import mode (default is relay). Im import mode the
routing table has to be specified whereas in relay the
routing table will be calculated automatically.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-no-filter">
<span class="sig-name descname"><span class="pre">--no-filter</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-no-filter" title="Permalink to this definition"></a></dt>
<dd><p>Disable message filtering and ignore all configured filters.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-routeunknowngroup">
<span class="sig-name descname"><span class="pre">--routeunknowngroup</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-routeunknowngroup" title="Permalink to this definition"></a></dt>
<dd><p>Route unknown groups to the default group IMPORT_GROUP.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-ignore-groups">
<span class="sig-name descname"><span class="pre">--ignore-groups</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-ignore-groups" title="Permalink to this definition"></a></dt>
<dd><p>Ignore user specified groups.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scimport-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scimport-test" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any messages.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scimport</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#import">Import</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scimex.html"
title="previous chapter">scimex</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scm.html"
title="next chapter">scm</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scimport.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,594 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scm &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scmapcut" href="scmapcut.html" />
<link rel="prev" title="scimport" href="scimport.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">6.9.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="scmapcut.html" title="scmapcut"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scimport.html" title="scimport"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scm">
<span id="id1"></span><h1>scm<a class="headerlink" href="#scm" title="Permalink to this heading"></a></h1>
<p><strong>Process monitor.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scm monitors client activity. scm connects to a certain master and periodically
processes the status messages sent by the clients.</p>
<p>Each client status if forwarded to the plugins loaded by scm. By default
the <a class="reference internal" href="scm_ncurses.html#scm-ncurses"><span class="std std-ref">mncursesplugin</span></a> is loaded which presents an interface
similar to the gnu program top.</p>
</section>
<section id="filters">
<h2>Filters<a class="headerlink" href="#filters" title="Permalink to this heading"></a></h2>
<p>Plugins might support filtering client status information. To configure filters
each plugin supports a configuration value <code class="xref std std-confval docutils literal notranslate"><span class="pre">$name.filter</span></code>. This filter
is a string which can be constructed from available status info tags and logical
and numerical operators.</p>
<p>List of tags:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">time</span>
privategroup
hostname
clientname
ips
programname
pid
cpuusage
totalmemory
clientmemoryusage
memoryusage
sentmessages
receivedmessages
messagequeuesize
summedmessagequeuesize
averagemessagequeuesize
summedmessagesize
averagemessagesize
objectcount
uptime
responsetime
</pre></div>
</div>
<p>A filter might look like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>memailplugin.filter<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;(cpuusage&gt;100 || totalmemory&gt;1000) &amp;&amp; hostname==proc-machine&quot;</span>
</pre></div>
</div>
<section id="numerical-operators">
<h3>Numerical operators<a class="headerlink" href="#numerical-operators" title="Permalink to this heading"></a></h3>
<p>Numerical operators are applied to a tag name and a constant value.</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Operator</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>==</p></td>
<td><p>equal</p></td>
</tr>
<tr class="row-odd"><td><p>!=</p></td>
<td><p>not equal</p></td>
</tr>
<tr class="row-even"><td><p>&lt;</p></td>
<td><p>less than</p></td>
</tr>
<tr class="row-odd"><td><p>&gt;</p></td>
<td><p>greater than</p></td>
</tr>
<tr class="row-even"><td><p>&lt;=</p></td>
<td><p>less or equal</p></td>
</tr>
<tr class="row-odd"><td><p>&gt;=</p></td>
<td><p>greater or equal</p></td>
</tr>
</tbody>
</table>
</section>
<section id="logical-operators">
<h3>Logical operators<a class="headerlink" href="#logical-operators" title="Permalink to this heading"></a></h3>
<p>Logical operators are applied to a group (might be enclosed in brackets) or
numerical expressions.</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Operator</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>!</p></td>
<td><p>not</p></td>
</tr>
<tr class="row-odd"><td><p>&amp;&amp;</p></td>
<td><p>and</p></td>
</tr>
<tr class="row-even"><td><p>||</p></td>
<td><p>or</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="multiple-instances">
<h2>Multiple instances<a class="headerlink" href="#multiple-instances" title="Permalink to this heading"></a></h2>
<p>To monitor different clients sets with different criteria and different plugins
it is common practice to create aliases of scm and to configure each instance
separately</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>scm_level1<span class="w"> </span>scm
seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>scm_level2<span class="w"> </span>scm
</pre></div>
</div>
<p>where <strong class="program">scm_level1</strong> could monitor all mandatory clients whereas
<strong class="program">scm_level2</strong> monitors all clients which are not crucial for operation.</p>
</section>
<section id="plugins">
<h2>Plugins<a class="headerlink" href="#plugins" title="Permalink to this heading"></a></h2>
<ul>
<li><p><a class="reference internal" href="scm_email.html#scm-email"><span class="std std-ref">email</span></a></p>
<p>Email plugin for scm which sends emails based on client status.</p>
</li>
<li><p><a class="reference internal" href="scm_text.html#scm-text"><span class="std std-ref">text</span></a></p>
<p>Text output plugin for scm.</p>
</li>
<li><p><a class="reference internal" href="scm_ncurses.html#scm-ncurses"><span class="std std-ref">ncurses</span></a></p>
<p>Ncurses output plugin for scm which presents an interactive table of processes.</p>
</li>
</ul>
</section>
<section id="module-configuration">
<span id="scm-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scm.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scm.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scm.cfg</span></code></div>
</div>
<p>scm inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<section id="email-extension">
<span id="scm-email"></span><h3>email extension<a class="headerlink" href="#email-extension" title="Permalink to this heading"></a></h3>
<p>Email plugin for scm which sends emails based on client status.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.recipients">
<span class="sig-name descname"><span class="pre">memailplugin.recipients</span></span><a class="headerlink" href="#confval-memailplugin.recipients" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defines a comma separated list of email addresses to send
notifications to.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.template">
<span class="sig-name descname"><span class="pre">memailplugin.template</span></span><a class="headerlink" href="#confval-memailplugin.template" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Configures a custom message text that is appended to each message
when clients passed the filter.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.filter">
<span class="sig-name descname"><span class="pre">memailplugin.filter</span></span><a class="headerlink" href="#confval-memailplugin.filter" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Defines the filter for each client status. A filter is an expression
that can be constructed with all available status tags (scm --print-tags)
and logical and numerical operators. See scm for more information.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.requiredClients">
<span class="sig-name descname"><span class="pre">memailplugin.requiredClients</span></span><a class="headerlink" href="#confval-memailplugin.requiredClients" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.reportSilentClients">
<span class="sig-name descname"><span class="pre">memailplugin.reportSilentClients</span></span><a class="headerlink" href="#confval-memailplugin.reportSilentClients" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.reportSilentClientsTimeSpan">
<span class="sig-name descname"><span class="pre">memailplugin.reportSilentClientsTimeSpan</span></span><a class="headerlink" href="#confval-memailplugin.reportSilentClientsTimeSpan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>min</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.reportRequiredClients">
<span class="sig-name descname"><span class="pre">memailplugin.reportRequiredClients</span></span><a class="headerlink" href="#confval-memailplugin.reportRequiredClients" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>min</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.filterMeanInterval">
<span class="sig-name descname"><span class="pre">memailplugin.filterMeanInterval</span></span><a class="headerlink" href="#confval-memailplugin.filterMeanInterval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>min</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.sendEmail">
<span class="sig-name descname"><span class="pre">memailplugin.sendEmail</span></span><a class="headerlink" href="#confval-memailplugin.sendEmail" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enables sending of emails using mailx shell command.</p>
</dd></dl>
</section>
<section id="text-extension">
<span id="scm-text"></span><h3>text extension<a class="headerlink" href="#text-extension" title="Permalink to this heading"></a></h3>
<p>Text output plugin for scm.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mtextplugin.outputDir">
<span class="sig-name descname"><span class="pre">mtextplugin.outputDir</span></span><a class="headerlink" href="#confval-mtextplugin.outputDir" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;/scm/</span></code></p>
<p>Type: <em>string</em></p>
<p>Output directory where [client].txt is written to. Additionally
an file description.txt will be created to show the order of
tags used in the client status file.</p>
</dd></dl>
</section>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scm [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-h">
<span id="cmdoption-scm-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-V">
<span id="cmdoption-scm-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-D">
<span id="cmdoption-scm-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-v">
<span id="cmdoption-scm-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-q">
<span id="cmdoption-scm-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-s">
<span id="cmdoption-scm-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-l">
<span id="cmdoption-scm-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-u">
<span id="cmdoption-scm-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-H">
<span id="cmdoption-scm-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-t">
<span id="cmdoption-scm-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-g">
<span id="cmdoption-scm-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-S">
<span id="cmdoption-scm-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scm-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="monitor">
<h3>Monitor<a class="headerlink" href="#monitor" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-c">
<span id="cmdoption-scm-clients"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--clients</span></span><span class="sig-prename descclassname"> <span class="pre">list</span></span><a class="headerlink" href="#cmdoption-scm-c" title="Permalink to this definition"></a></dt>
<dd><p>Comma separated list of clients to monitor.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-print-tags">
<span class="sig-name descname"><span class="pre">--print-tags</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-print-tags" title="Permalink to this definition"></a></dt>
<dd><p>Print available keys for accessing client info data and to
build filter configurations.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scm-no-output-plugins">
<span class="sig-name descname"><span class="pre">--no-output-plugins</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scm-no-output-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Do not use output plugins such as mncursesplugin.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scm</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#filters">Filters</a><ul>
<li><a class="reference internal" href="#numerical-operators">Numerical operators</a></li>
<li><a class="reference internal" href="#logical-operators">Logical operators</a></li>
</ul>
</li>
<li><a class="reference internal" href="#multiple-instances">Multiple instances</a></li>
<li><a class="reference internal" href="#plugins">Plugins</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a><ul>
<li><a class="reference internal" href="#email-extension">email extension</a></li>
<li><a class="reference internal" href="#text-extension">text extension</a></li>
</ul>
</li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#monitor">Monitor</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scimport.html"
title="previous chapter">scimport</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scmapcut.html"
title="next chapter">scmapcut</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scm.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,269 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>email &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="text" href="scm_text.html" />
<link rel="prev" title="scm" href="../toc/extensions/scm.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">6.9.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="scm_text.html" title="text"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/extensions/scm.html" title="scm"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/scm.html" accesskey="U">scm</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="email">
<span id="scm-email"></span><h1>email<a class="headerlink" href="#email" title="Permalink to this heading"></a></h1>
<p>Email plugin for scm which sends emails based on client status.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The email plugin sends emails to configured receipients if a client status
messages passes the configured <a class="reference internal" href="#confval-memailplugin.filter"><code class="xref std std-confval docutils literal notranslate"><span class="pre">filter</span></code></a>.</p>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>The email plugin is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/monitor/memailplugin.so</span></code>.</p>
<p>To add the plugin to <a class="reference internal" href="scm.html#scm"><span class="std std-ref">scm</span></a>, add it to the plugin list:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>memailplugin
</pre></div>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>An example configuration looks like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Send notification is a clients CPU usage exceeds 100 percent</span>
memailplugin.filter<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;cpuusage&gt;100&quot;</span>
<span class="c1"># Send emails, yes</span>
memailplugin.sendEmail<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span>
<span class="c1"># Send emails to this address(es)</span>
memailplugin.recipients<span class="w"> </span><span class="o">=</span><span class="w"> </span>operator@my-agency.org,<span class="w"> </span>operator2@my-agency.org
memailplugin.reportSilentClients<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span>
<span class="c1"># Minutes before report missing clients</span>
memailplugin.reportRequiredClients<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>
<span class="c1"># Interval to calculate mean of the message values for (in minutes)</span>
memailplugin.filterMeanInterval<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>
<span class="c1"># List of clients we definitely require to be operative</span>
memailplugin.requiredClients<span class="w"> </span><span class="o">=</span><span class="w"> </span>scautopick,<span class="w"> </span>scautoloc,<span class="w"> </span>scevent,<span class="w"> </span>scamp,<span class="se">\</span>
<span class="w"> </span>scmag,<span class="w"> </span>scqc,<span class="w"> </span>scevtlog
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scm-email-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.recipients">
<span class="sig-name descname"><span class="pre">memailplugin.recipients</span></span><a class="headerlink" href="#confval-memailplugin.recipients" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Defines a comma separated list of email addresses to send
notifications to.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.template">
<span class="sig-name descname"><span class="pre">memailplugin.template</span></span><a class="headerlink" href="#confval-memailplugin.template" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Configures a custom message text that is appended to each message
when clients passed the filter.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.filter">
<span class="sig-name descname"><span class="pre">memailplugin.filter</span></span><a class="headerlink" href="#confval-memailplugin.filter" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Defines the filter for each client status. A filter is an expression
that can be constructed with all available status tags (scm --print-tags)
and logical and numerical operators. See scm for more information.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.requiredClients">
<span class="sig-name descname"><span class="pre">memailplugin.requiredClients</span></span><a class="headerlink" href="#confval-memailplugin.requiredClients" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.reportSilentClients">
<span class="sig-name descname"><span class="pre">memailplugin.reportSilentClients</span></span><a class="headerlink" href="#confval-memailplugin.reportSilentClients" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.reportSilentClientsTimeSpan">
<span class="sig-name descname"><span class="pre">memailplugin.reportSilentClientsTimeSpan</span></span><a class="headerlink" href="#confval-memailplugin.reportSilentClientsTimeSpan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>min</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.reportRequiredClients">
<span class="sig-name descname"><span class="pre">memailplugin.reportRequiredClients</span></span><a class="headerlink" href="#confval-memailplugin.reportRequiredClients" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>min</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.filterMeanInterval">
<span class="sig-name descname"><span class="pre">memailplugin.filterMeanInterval</span></span><a class="headerlink" href="#confval-memailplugin.filterMeanInterval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>min</em></p>
<p><em>No description available</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-memailplugin.sendEmail">
<span class="sig-name descname"><span class="pre">memailplugin.sendEmail</span></span><a class="headerlink" href="#confval-memailplugin.sendEmail" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enables sending of emails using mailx shell command.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">email</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/extensions/scm.html"
title="previous chapter">scm</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scm_text.html"
title="next chapter">text</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scm_email.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,180 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ncurses &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Filter Grammar" href="../base/filter-grammar.html" />
<link rel="prev" title="text" href="scm_text.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">6.9.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="../base/filter-grammar.html" title="Filter Grammar"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scm_text.html" title="text"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/scm.html" accesskey="U">scm</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ncurses">
<span id="scm-ncurses"></span><h1>ncurses<a class="headerlink" href="#ncurses" title="Permalink to this heading"></a></h1>
<p>Ncurses output plugin for scm which presents an interactive table of
processes.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The output is a table where each row contains the information of a
certain connected client. The rows are sorted in descending order based on the
contents of the name column. Other columns can be interactively selected with
the left and right arrow key. The r key changes the sorting to ascending order.
The displayed parameter are the name of the binary (prog), the name of the
client (name), the name of the host name from which the client is connected
(host), the available memory on the clients host in kb (hmem), the clients
memory usage in kb (cmem), the percentage of the clients memory usage (mem),
the CPU usage (cpu), the amount of queued messages to be processed by the
client (q), the average number of messages in the queue (mq), the connection
time of the client to the master (uptime), the elapsed time since the last
client update (resp).</p>
<figure class="align-default" id="id1">
<img alt="../_images/scm_curses.png" src="../_images/scm_curses.png" />
<figcaption>
<p><span class="caption-text">top like perspective of ncurses plugin</span><a class="headerlink" href="#id1" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>The Ncurses plugin is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/monitor/mncursesplugin.so</span></code>.</p>
<p>To add the plugin to <a class="reference internal" href="scm.html#scm"><span class="std std-ref">scm</span></a>, add it to the plugin list:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>mncursesplugin
</pre></div>
</div>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ncurses</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scm_text.html"
title="previous chapter">text</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../base/filter-grammar.html"
title="next chapter">Filter Grammar</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scm_ncurses.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,178 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>text &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="ncurses" href="scm_ncurses.html" />
<link rel="prev" title="email" href="scm_email.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">6.9.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="scm_ncurses.html" title="ncurses"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scm_email.html" title="email"
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="../toc/extensions.html" >Extensions</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/extensions/scm.html" accesskey="U">scm</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="text">
<span id="scm-text"></span><h1>text<a class="headerlink" href="#text" title="Permalink to this heading"></a></h1>
<p>Text output plugin for scm.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The text plugin writes for each client a status text file to a
<a class="reference internal" href="#confval-mtextplugin.outputDir"><code class="xref std std-confval docutils literal notranslate"><span class="pre">configurable</span></code></a> directory. Each text file
is named after the client with the extension “.txt”.</p>
</section>
<section id="plugin">
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading"></a></h2>
<p>The text plugin is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/monitor/mtextplugin.so</span></code>.</p>
<p>To add the plugin to <a class="reference internal" href="scm.html#scm"><span class="std std-ref">scm</span></a>, add it to the plugin list:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>mtextplugin
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scm-text-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mtextplugin.outputDir">
<span class="sig-name descname"><span class="pre">mtextplugin.outputDir</span></span><a class="headerlink" href="#confval-mtextplugin.outputDir" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;/scm/</span></code></p>
<p>Type: <em>string</em></p>
<p>Output directory where [client].txt is written to. Additionally
an file description.txt will be created to show the order of
tags used in the client status file.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">text</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scm_email.html"
title="previous chapter">email</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scm_ncurses.html"
title="next chapter">ncurses</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scm_text.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,799 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scmag &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scqc" href="scqc.html" />
<link rel="prev" title="scevent" href="scevent.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">6.9.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="scqc.html" title="scqc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scevent.html" title="scevent"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/processing.html" accesskey="U">Processing</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scmag">
<span id="id1"></span><h1>scmag<a class="headerlink" href="#scmag" title="Permalink to this heading"></a></h1>
<p><strong>Calculates magnitudes of different types.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The purpose of scmag is to compute magnitudes from pre-computed amplitudes.
Instead it takes amplitudes and origins as input and produces StationMagnitudes
and (network) Magnitudes as output. It does not access waveforms.
The resulting magnitudes are sent to the “MAGNITUDE” group. scmag doesnt access
any waveforms. It only uses amplitudes previously calculated.</p>
<p>The purpose of scmag is the decoupling of magnitude computation from amplitude
measurements. This allows several modules to generate amplitudes concurrently,
like <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a>. As soon as an origin comes in, the amplitudes related
to the picks are taken either from the memory buffer or the database to compute
the magnitudes.</p>
<section id="relationship-between-amplitudes-and-origins">
<h3>Relationship between amplitudes and origins<a class="headerlink" href="#relationship-between-amplitudes-and-origins" title="Permalink to this heading"></a></h3>
<p>scmag makes use of the fact that origins sent by <a class="reference internal" href="scautoloc.html#scautoloc"><span class="std std-ref">scautoloc</span></a>, <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>
or other modules include
the complete set of arrivals, which reference picks used for origin computation.
The picks in turn are referenced by a number of amplitudes, some of which are
relevant for magnitude computation.</p>
<p>Read the <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> documentation for more details on amplitude measurements.</p>
</section>
<section id="primary-magnitudes">
<span id="scmag-primarym"></span><h3>Primary magnitudes<a class="headerlink" href="#primary-magnitudes" title="Permalink to this heading"></a></h3>
<p>Primary magnitudes are computed from amplitudes and station-event distances.
Currently the following primary magnitude types are implemented.</p>
</section>
<section id="local-distances">
<h3>Local distances<a class="headerlink" href="#local-distances" title="Permalink to this heading"></a></h3>
<dl class="simple">
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-duration-Md"><span class="xref std std-term">Md</span></a></dt><dd><p>Duration magnitude as described in HYPOINVERSE (<span id="id2">Klein [<a class="reference internal" href="../base/references.html#id47" title="F.W. Klein. Users guide to HYPOINVERSE-2000, a Fortran program to solve for earthquake locations and magnitudes. US Geological Survey, 2002-171:, 2002. URL: https://www.usgs.gov/node/279394, doi:10.3133/ofr02171.">50</a>]</span>).</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-JMA-M_JMA"><span class="xref std std-term">Mjma</span></a></dt><dd><p>Mjma is computed on displacement data using body waves of period &lt; 30s.</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-ML"><span class="xref std std-term">ML</span></a></dt><dd><p>Local (Richter) magnitude calculated on the horizontal components using a
correction term to fit with the standard ML (<span id="id3">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>).</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-custom-MLc"><span class="xref std std-term">MLc</span></a></dt><dd><p>Local custom magnitude calculated on the horizontal components according to
Hessian Earthquake Service and <span id="id4">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-horizontal-MLh"><span class="xref std std-term">MLh</span></a></dt><dd><p>Local magnitude calculated on the horizontal components according to SED
specifications.</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-vertical-MLv"><span class="xref std std-term">MLv</span></a></dt><dd><p>Local magnitude calculated on the vertical component using a correction term
to fit with the standard ML.</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-GNS-GEONET-MLr"><span class="xref std std-term">MLr</span></a></dt><dd><p>Local magnitude calculated from MLv amplitudes based on GNS/GEONET specifications
for New Zealand (<span id="id5">Ristau <em>et al.</em> [<a class="reference internal" href="../base/references.html#id64" title="J. Ristau, D. Harte, and J. Salichon. A Revised Local Magnitude (ML) Scale for New Zealand Earthquakes. Bull. Seismol. Soc. Am., 106(2):, 2016. doi:10.1785/0120150293.">58</a>]</span>).</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-Nuttli-MN"><span class="xref std std-term">MN</span></a></dt><dd><p>Nuttli magnitude for Canada and other Cratonic regions (<span id="id6">Nuttli [<a class="reference internal" href="../base/references.html#id58" title="O.W. Nuttli. Seismic wave attenuation and magnitude relations for eastern north america. J. Geophys. Res., 5:876 - 885, 1973. doi:10.1029/JB078i005p00876.">53</a>]</span>).</p>
</dd>
</dl>
</section>
<section id="teleseismic-distances">
<h3>Teleseismic distances<a class="headerlink" href="#teleseismic-distances" title="Permalink to this heading"></a></h3>
<dl class="simple">
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-body-wave-mb"><span class="xref std std-term">mb</span></a></dt><dd><p>Narrow band body wave magnitude measured on a WWSSN-SP filtered trace</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-cumulative-body-wave-mBc"><span class="xref std std-term">mBc</span></a></dt><dd><p>Cumulative body wave magnitude</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-body-wave-mB"><span class="xref std std-term">mB</span></a></dt><dd><p>Broad band body wave magnitude after <span id="id7">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-P-wave-moment-Mwp"><span class="xref std std-term">Mwp</span></a></dt><dd><p>The body wave magnitude of <span id="id8">Tsuboi <em>et al.</em> [<a class="reference internal" href="../base/references.html#id79" title="S. Tsuboi, K. Abe, K. Takano, and Y. Yamanaka. Rapid determination of Mw from broadband P waveforms. Bull. Seismol. Soc. Am., 1995. doi:10.1785/BSSA0850020606.">63</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-surface-wave-Ms_20"><span class="xref std std-term">Ms_20</span></a></dt><dd><p>Surface-wave magnitude at 20 s period</p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-surface-wave-Ms-BB"><span class="xref std std-term">Ms(BB)</span></a></dt><dd><p>Broad band surface-wave magnitude</p>
</dd>
</dl>
</section>
<section id="derived-magnitudes">
<h3>Derived magnitudes<a class="headerlink" href="#derived-magnitudes" title="Permalink to this heading"></a></h3>
<p>Additionally, scmag derives the following magnitudes from primary magnitudes:</p>
<dl>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-derived-mB-Mw-mB"><span class="xref std std-term">Mw(mB)</span></a></dt><dd><p>Estimation of the moment magnitude Mw based on mB using the Mw vs. mB
regression of <span id="id9">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-derived-Mwp-Mw-Mwp"><span class="xref std std-term">Mw(Mwp)</span></a></dt><dd><p>Estimation of the moment magnitude Mw based on Mwp using the Mw vs. Mwp
regression of <span id="id10">Whitmore <em>et al.</em> [<a class="reference internal" href="../base/references.html#id85" title="P.M. Whitmore, S. Tsuboi, B. Hirshorn, and T.J. Sokolowski. Magnitude dependent correction for Mwp. Science of Tsunami Hazards, 20(4):, 2002.">65</a>]</span></p>
</dd>
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-summary-M"><span class="xref std std-term">M</span></a></dt><dd><p>Summary magnitude, which consists of a weighted average of the individual
magnitudes and attempts to be a best possible compromise between all magnitudes.
See below for configuration and also scevent for how to add the summary magnitude
to the list of possible preferred magnitudes or how to make it always preferred.</p>
<p>More details are given in the <a class="reference internal" href="#scmag-summarym"><span class="std std-ref">section Summary magnitude</span></a>.</p>
</dd>
<dt>Mw(avg)</dt><dd><p>Estimation of the moment magnitude Mw based on a weighted average of other
magnitudes, currently MLv, mb and Mw(mB), in future possibly other magnitudes as
well, especially those suitable for very large events. The purpose of Mw(avg) is
to have, at any stage during the processing, a “best possible” estimation of the
magnitude by combining all available magnitudes into a single, weighted average.
Initially the average will consist of only MLv and/or mb measurements, but as soon
as Mw(mB) measurements become available, these (and in future other large-event
magnitudes) become progressively more weight in the average.</p>
</dd>
</dl>
<p>If an amplitude is updated, the corresponding magnitude is updated as well.
This allows the computation of preliminary, real-time magnitudes even before
the full length of the P coda is available.</p>
</section>
</section>
<section id="station-magnitudes">
<span id="scmag-stationm"></span><h2>Station magnitudes<a class="headerlink" href="#station-magnitudes" title="Permalink to this heading"></a></h2>
<p>Station magnitudes of a <a class="reference internal" href="#scmag-primarym"><span class="std std-ref">particular magnitude type</span></a> are
calculated based on measured amplitudes considered by this magnitude type and
the distance between the <a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a> and the station at which the amplitude
was measured. Typically, epicentral distance is used for distance. Magnitudes
may support configurable distance measures, e.g.,
<a class="reference internal" href="../base/glossary.html#term-magnitude-local-custom-MLc"><span class="xref std std-term">MLc</span></a>. The relation between measured
amplitudes, distance and station magnitude is given by a calibration function
which is specific to a magnitude type and configurable for some magnitudes.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Usually station magnitudes use amplitudes of the same type. However, some magnitude
consider amplitudes of another type. E.g. <a class="reference internal" href="../base/glossary.html#term-magnitude-local-GNS-GEONET-MLr"><span class="xref std std-term">MLr</span></a>
uses amplitudes computed for <a class="reference internal" href="../base/glossary.html#term-magnitude-local-vertical-MLv"><span class="xref std std-term">MLv</span></a>.</p>
</div>
<section id="regionalization">
<h3>Regionalization<a class="headerlink" href="#regionalization" title="Permalink to this heading"></a></h3>
<p>Depending on the geographic region in which events, stations or entire ray paths
are located, different calibration functions and constraints may apply. This is
called “magnitude regionalization”. The region is defined by a polygon stored in
a region file. For a particular magnitude, regionalization can be configured by
global parameters, e.g., in <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/global.cfg</span></code>.</p>
<ol class="arabic simple">
<li><p>Add magnitude type profile to the magnitudes parameters. The name of the
profile must be the name of the magnitude type.</p></li>
<li><p>Add the profile-specific parameters.</p></li>
</ol>
<p>Example for MLc in <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/global.cfg</span></code> the polygon with name
<em>test</em> defined in a <a class="reference internal" href="global_gui.html#sec-gui-layers-vector"><span class="std std-ref">BNA file</span></a>:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">magnitudes.MLc.regionFile</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">@DATADIR@/spatial/vector/magnitudes/regions.bna</span>
<span class="na">magnitudes.MLc.region.test.enable</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span>
<span class="na">magnitudes.MLc.region.test.A0.logA0</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0:-1.3, 60:-2.8, 100:-3.0, 400:-4.5, 1000:-5.85</span>
</pre></div>
</div>
</section>
</section>
<section id="network-magnitudes">
<span id="scmag-networkm"></span><h2>Network magnitudes<a class="headerlink" href="#network-magnitudes" title="Permalink to this heading"></a></h2>
<p>The network magnitude is a magnitude value summarizing several
<a class="reference internal" href="#scmag-stationm"><span class="std std-ref">station magnitudes</span></a> values of one <a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a>.
Different methods are available for forming network magnitudes from station
magnitudes:</p>
<table class="docutils align-left">
<colgroup>
<col style="width: 20.0%" />
<col style="width: 80.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Method</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>mean</p></td>
<td><p>The usual mean value.</p></td>
</tr>
<tr class="row-odd"><td><p>trimmed mean value</p></td>
<td><p>To stabilize the network magnitudes the smallest and the largest 12.5% of the <a class="reference internal" href="../base/glossary.html#term-station-magnitude"><span class="xref std std-term">station magnitude</span></a> values are removed before computing the mean.</p></td>
</tr>
<tr class="row-even"><td><p>median</p></td>
<td><p>The usual median value.</p></td>
</tr>
<tr class="row-odd"><td><p>median trimmed mean</p></td>
<td><p>Removing all station magnitudes with a distance greater than 0.5 (default) from the median of all station magnitudes and computing the mean of all remaining station magnitudes.</p></td>
</tr>
</tbody>
</table>
<p>Configure the method per magnitude type by <a class="reference internal" href="#confval-magnitudes.average"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.average</span></code></a>.
Default values apply for each magnitude type which are defined by the magnitude
itself.
In the <a class="reference internal" href="scolv.html#scolv-sec-magnitude-tab"><span class="std std-ref">scolv Magnitudes tab</span></a> the methods, the
stations magnitudes and other parameters can be selected interactively.</p>
</section>
<section id="summary-magnitude">
<span id="scmag-summarym"></span><h2>Summary magnitude<a class="headerlink" href="#summary-magnitude" title="Permalink to this heading"></a></h2>
<p>scmag can compute a summary magnitude as a weighted sum from all available
<a class="reference internal" href="#scmag-networkm"><span class="std std-ref">network magnitudes</span></a>.
This magnitude is typically called <strong>M</strong> as configured in
<a class="reference internal" href="#confval-summaryMagnitude.type"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.type</span></code></a>.</p>
<p>It is computed as a weighted average over the available magnitudes:</p>
<div class="math">
<p><img src="../_images/math/9af9964f1e826eea97592ba3eb00a1c8b0e42b05.png" alt="M &amp;= \frac{\sum w_{i} * M_{i}}{\sum w_i} \\
w_{i} &amp;= a_i * stationCount(M_{i}) + b_i"/></p>
</div><p>The coefficients a and b can be configured per magnitude type by
<a class="reference internal" href="#confval-summaryMagnitude.coefficients.a"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.coefficients.a</span></code></a>
and <a class="reference internal" href="#confval-summaryMagnitude.coefficients.b"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.coefficients.b</span></code></a>, respectively.
Furthermore each magnitude type can be specifically added to or excluded from the
summary magnitude calculation
as defined in <a class="reference internal" href="#confval-summaryMagnitude.whitelist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.whitelist</span></code></a> or
<a class="reference internal" href="#confval-summaryMagnitude.blacklist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.blacklist</span></code></a>, respectively.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>While the magnitudes are computed by scmag the decision about the preferred
magnitude of an <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">event</span></a> is made by <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.</p>
</div>
</section>
<section id="preferred-magnitude">
<h2>Preferred Magnitude<a class="headerlink" href="#preferred-magnitude" title="Permalink to this heading"></a></h2>
<p>The preferred magnitude of an <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">event</span></a> is set automatically by <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>
or interactively in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>. It can be any network magnitude or the summary
magnitude.</p>
</section>
<section id="module-configuration">
<span id="scmag-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scmag.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scmag.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scmag.cfg</span></code></div>
</div>
<p>scmag inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-magnitudes">
<span class="sig-name descname"><span class="pre">magnitudes</span></span><a class="headerlink" href="#confval-magnitudes" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">MLv,mb,mB,Mwp</span></code></p>
<p>Type: <em>list:string</em></p>
<p>The magnitude types to be calculated. Station magnitudes are
computed from their amplitudes, network magnitudes from their
station magnitudes.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-minimumArrivalWeight">
<span class="sig-name descname"><span class="pre">minimumArrivalWeight</span></span><a class="headerlink" href="#confval-minimumArrivalWeight" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code></p>
<p>Type: <em>double</em></p>
<p>The minimum weight of an arrival for an associated amplitude
to be used for calculating a magnitude.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>magnitudes.*</strong>
<em>General parameters for computing magnitudes. Others are configured</em>
<em>by global binding parameters for specific magnitude types.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-magnitudes.average">
<span class="sig-name descname"><span class="pre">magnitudes.average</span></span><a class="headerlink" href="#confval-magnitudes.average" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
<p>Type: <em>list:string</em></p>
<p>The methods for computing the network magnitude
from station magnitudes. Exactly one method per
magnitude can be configured.
To define the averaging method per magnitude type append
the type after colon, e.g.:
&quot;magnitudes.average = default, MLv:median&quot;</p>
<p>default: Compute the mean if less than 4 contributed
station magnitudes exist. Otherwise apply trimmedMean(25),
trimmed mean with 25%.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-connection.sendInterval">
<span class="sig-name descname"><span class="pre">connection.sendInterval</span></span><a class="headerlink" href="#confval-connection.sendInterval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>Interval between 2 sending processes. The interval controls
how often information is updated.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>summaryMagnitude.*</strong>
<em>The summary magnitude is the weighted average from all</em>
<em>defined network magnitude types: Single network magnitude values</em>
<em>are multiplied with their magnitude-type specific weight and</em>
<em>summed up. The resulting sum is divided by the sum of all weights.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.enabled">
<span class="sig-name descname"><span class="pre">summaryMagnitude.enabled</span></span><a class="headerlink" href="#confval-summaryMagnitude.enabled" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enables summary magnitude calculation.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.type">
<span class="sig-name descname"><span class="pre">summaryMagnitude.type</span></span><a class="headerlink" href="#confval-summaryMagnitude.type" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">M</span></code></p>
<p>Type: <em>string</em></p>
<p>Define the type/name of the summary magnitude.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.minStationCount">
<span class="sig-name descname"><span class="pre">summaryMagnitude.minStationCount</span></span><a class="headerlink" href="#confval-summaryMagnitude.minStationCount" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>int</em></p>
<p>This is the minimum station magnitude required for any
magnitude to contribute to the summary magnitude at all. If
this is set to 4, then no magnitude with less than 4 station
magnitudes is taken into consideration even if this results
in no summary magnitude at all. For this reason, the default
here is 1 but in a purely automatic system it should be
higher, at least 4 is recommended.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.singleton">
<span class="sig-name descname"><span class="pre">summaryMagnitude.singleton</span></span><a class="headerlink" href="#confval-summaryMagnitude.singleton" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Allow computing the summary magnitude even if only one single
network magnitude meeting the other criteria is available.
Unselecting this parameter will suppress computing summary
magnitudes if only one network magnitude is available.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.blacklist">
<span class="sig-name descname"><span class="pre">summaryMagnitude.blacklist</span></span><a class="headerlink" href="#confval-summaryMagnitude.blacklist" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define the magnitude types to be excluded from the summary
magnitude calculation.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.whitelist">
<span class="sig-name descname"><span class="pre">summaryMagnitude.whitelist</span></span><a class="headerlink" href="#confval-summaryMagnitude.whitelist" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define the magnitude types to be included in the summary
magnitude calculation.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>summaryMagnitude.coefficients.*</strong>
<em>The coefficients defining the weight of network magnitudes</em>
<em>for calculating the summary magnitude.</em>
<em>Weight = a * magnitudeStationCount + b.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.coefficients.a">
<span class="sig-name descname"><span class="pre">summaryMagnitude.coefficients.a</span></span><a class="headerlink" href="#confval-summaryMagnitude.coefficients.a" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0,</span> <span class="pre">Mw(mB):0.4,</span> <span class="pre">Mw(Mwp):0.4</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Define the coefficients a. To define the value per magnitude
type append the type after colon. A value without a
type defines the default value.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-summaryMagnitude.coefficients.b">
<span class="sig-name descname"><span class="pre">summaryMagnitude.coefficients.b</span></span><a class="headerlink" href="#confval-summaryMagnitude.coefficients.b" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1,</span> <span class="pre">MLv:2,</span> <span class="pre">Mw(mB):-1,</span> <span class="pre">Mw(Mwp):-1</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Define the coefficients b. To define the value per magnitude
type append the type after colon. A value without a
type defines the default value.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-h">
<span id="cmdoption-scmag-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-V">
<span id="cmdoption-scmag-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-D">
<span id="cmdoption-scmag-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-x">
<span id="cmdoption-scmag-expiry"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--expiry</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scmag-x" title="Permalink to this definition"></a></dt>
<dd><p>Time span in hours after which objects expire.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-v">
<span id="cmdoption-scmag-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-q">
<span id="cmdoption-scmag-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-s">
<span id="cmdoption-scmag-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-l">
<span id="cmdoption-scmag-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-u">
<span id="cmdoption-scmag-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-H">
<span id="cmdoption-scmag-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-t">
<span id="cmdoption-scmag-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-g">
<span id="cmdoption-scmag-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-S">
<span id="cmdoption-scmag-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-d">
<span id="cmdoption-scmag-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmag-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-ep">
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-scmag-ep" title="Permalink to this definition"></a></dt>
<dd><p>Defines an event parameters XML file to be read and processed. This
implies offline mode and only processes all origins contained
in that file. It computes station magnitudes for all picks associated
with an origin where amplitudes are available and the corresponding
network magnitudes. Station and network magnitudes having the
evaluation status set are ignored. Use --reprocess to include those
magnitudes. It outputs an XML text adding the station-
and network magnitudes to the input XML file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-reprocess">
<span class="sig-name descname"><span class="pre">--reprocess</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-reprocess" title="Permalink to this definition"></a></dt>
<dd><p>Reprocess also station and network magnitudes with an evaluation
status set but do not change original weights. New
contributions are added with weight 0.</p>
</dd></dl>
</section>
<section id="reprocess">
<h3>Reprocess<a class="headerlink" href="#reprocess" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-static">
<span class="sig-name descname"><span class="pre">--static</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-static" title="Permalink to this definition"></a></dt>
<dd><p>With that flag all existing station magnitudes are recomputed
based on their associated amplitudes. If an amplitude cannot
be accessed, no station magnitude is updated.
Network magnitudes are recomputed based on their station
magnitude contributions. No new objects will
be created in this mode, it only updates values and weights.
The method to accumulate the station magnitudes to form the network
magnitude will be read from the existing object and replicated.
If it cannot be interpreted, then the configured default for this
magnitude type will be used instead. Weights of station magnitudes
will be changed according to the accumulation method of the
network magnitude.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmag-keep-weights">
<span class="sig-name descname"><span class="pre">--keep-weights</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-keep-weights" title="Permalink to this definition"></a></dt>
<dd><p>Keep the original weights in combination with --static.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scmag</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#relationship-between-amplitudes-and-origins">Relationship between amplitudes and origins</a></li>
<li><a class="reference internal" href="#primary-magnitudes">Primary magnitudes</a></li>
<li><a class="reference internal" href="#local-distances">Local distances</a></li>
<li><a class="reference internal" href="#teleseismic-distances">Teleseismic distances</a></li>
<li><a class="reference internal" href="#derived-magnitudes">Derived magnitudes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#station-magnitudes">Station magnitudes</a><ul>
<li><a class="reference internal" href="#regionalization">Regionalization</a></li>
</ul>
</li>
<li><a class="reference internal" href="#network-magnitudes">Network magnitudes</a></li>
<li><a class="reference internal" href="#summary-magnitude">Summary magnitude</a></li>
<li><a class="reference internal" href="#preferred-magnitude">Preferred Magnitude</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#reprocess">Reprocess</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scevent.html"
title="previous chapter">scevent</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scqc.html"
title="next chapter">scqc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmag.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,428 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scmapcut &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scmssort" href="scmssort.html" />
<link rel="prev" title="scm" href="scm.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">6.9.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="scmssort.html" title="scmssort"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scm.html" title="scm"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scmapcut">
<span id="id1"></span><h1>scmapcut<a class="headerlink" href="#scmapcut" title="Permalink to this heading"></a></h1>
<p><strong>Create image files containing maps of specific regions.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>scmapcut</em> is a commandline tool to create image files containing maps of specific
regions and for selected events. When plotting events given by their eventID, the
event parameters must be provided in a SeisComP event XML file. The XML file can
be retrieved from the database using <a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a>.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Draw a map for the event with event ID &lt;eventID&gt;. Plot a region of at least
3 degrees around the epicentre. The created image has 800x400 px.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmapcut<span class="w"> </span>-E<span class="w"> </span>&lt;eventID&gt;<span class="w"> </span>--ep<span class="w"> </span>&lt;eventID&gt;.xml<span class="w"> </span>-m<span class="w"> </span><span class="m">3</span><span class="w"> </span>-d<span class="w"> </span>800x400<span class="w"> </span>-o<span class="w"> </span>&lt;eventID&gt;.png
</pre></div>
</div>
<figure class="align-center" id="id2">
<span id="fig-workflow"></span><a class="reference internal image-reference" href="../_images/gempa2017xxxx.png"><img alt="../_images/gempa2017xxxx.png" src="../_images/gempa2017xxxx.png" style="width: 10cm;" /></a>
<figcaption>
<p><span class="caption-text">Image example.</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</li>
<li><p>Draw a map for a generic event with magnitude 4. The size of the event shown
on the map scales with magnitude. Plot a region of at least 3 degrees around
the epicentre. The created image has 800x400 px.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmapcut<span class="w"> </span>--lat<span class="w"> </span><span class="m">44</span><span class="w"> </span>--lon<span class="w"> </span><span class="m">12</span><span class="w"> </span>--depth<span class="w"> </span><span class="m">10</span><span class="w"> </span>--mag<span class="w"> </span><span class="m">4</span><span class="w"> </span>-m<span class="w"> </span><span class="m">0</span>.5<span class="w"> </span>-d<span class="w"> </span>800x400<span class="w"> </span>-o<span class="w"> </span>generic.png
</pre></div>
</div>
<figure class="align-center" id="id3">
<span id="fig-workflow-mag4"></span><a class="reference internal image-reference" href="../_images/generic.png"><img alt="../_images/generic.png" src="../_images/generic.png" style="width: 10cm;" /></a>
<figcaption>
<p><span class="caption-text">Generic example.</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="scmapcut-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scmapcut.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scmapcut.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scmapcut.cfg</span></code></div>
</div>
<p>scmapcut inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scmapcut [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-h">
<span id="cmdoption-scmapcut-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-V">
<span id="cmdoption-scmapcut-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-D">
<span id="cmdoption-scmapcut-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-v">
<span id="cmdoption-scmapcut-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-q">
<span id="cmdoption-scmapcut-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-s">
<span id="cmdoption-scmapcut-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-l">
<span id="cmdoption-scmapcut-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-city-xml">
<span class="sig-name descname"><span class="pre">--city-xml</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-city-xml" title="Permalink to this definition"></a></dt>
<dd><p>Path to the cities.xml file. If undefined, the data is
read from CONFIGDIR&#64;/cities.xml or &#64;DATADIR&#64;/cities.xml.</p>
</dd></dl>
</section>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-r">
<span id="cmdoption-scmapcut-region"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-r" title="Permalink to this definition"></a></dt>
<dd><p>Cut region ([lat_dim]x[lon_dim]+lat0+lon0 or +lat0+lon+lat1+lon1).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-m">
<span id="cmdoption-scmapcut-margin"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--margin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-m" title="Permalink to this definition"></a></dt>
<dd><p>Margin in degrees around origin (margin|margin_latxmargin_lon).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-d">
<span id="cmdoption-scmapcut-dimension"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dimension</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-d" title="Permalink to this definition"></a></dt>
<dd><p>Output image dimension (wxh).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-o">
<span id="cmdoption-scmapcut-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-o" title="Permalink to this definition"></a></dt>
<dd><p>Output image, file name.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-lat">
<span class="sig-name descname"><span class="pre">--lat</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-lat" title="Permalink to this definition"></a></dt>
<dd><p>Latitude of symbol.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-long">
<span class="sig-name descname"><span class="pre">--long</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-long" title="Permalink to this definition"></a></dt>
<dd><p>Longitude of symbol.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-depth">
<span class="sig-name descname"><span class="pre">--depth</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-depth" title="Permalink to this definition"></a></dt>
<dd><p>Depth of event.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-mag">
<span class="sig-name descname"><span class="pre">--mag</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-mag" title="Permalink to this definition"></a></dt>
<dd><p>Magnitude of event.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-layers">
<span class="sig-name descname"><span class="pre">--layers</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-layers" title="Permalink to this definition"></a></dt>
<dd><p>Draw polygonal layers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-ep">
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-ep" title="Permalink to this definition"></a></dt>
<dd><p>Name of XML file containing the event parameters to load.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-E">
<span id="cmdoption-scmapcut-event-id"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--event-id</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmapcut-E" title="Permalink to this definition"></a></dt>
<dd><p>Event ID of the event to plot on map.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-html-area">
<span class="sig-name descname"><span class="pre">--html-area</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-html-area" title="Permalink to this definition"></a></dt>
<dd><p>Print html/area section.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmapcut-without-arrivals">
<span class="sig-name descname"><span class="pre">--without-arrivals</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmapcut-without-arrivals" title="Permalink to this definition"></a></dt>
<dd><p>Do not render arrivals (stations).</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scmapcut</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#cities">Cities</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scm.html"
title="previous chapter">scm</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scmssort.html"
title="next chapter">scmssort</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmapcut.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,691 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scmaster &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Processing" href="../toc/processing.html" />
<link rel="prev" title="Messaging" href="../toc/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">6.9.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="../toc/processing.html" title="Processing"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="../toc/messaging.html" title="Messaging"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/messaging.html" accesskey="U">Messaging</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scmaster">
<span id="id1"></span><h1>scmaster<a class="headerlink" href="#scmaster" title="Permalink to this heading"></a></h1>
<p><strong>The messaging system</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scmaster is the implementation of the <a class="reference internal" href="../base/concepts/messaging.html#concepts-messaging"><span class="std std-ref">messaging</span></a>
mediator.</p>
</section>
<section id="message-groups">
<span id="section-scmaster-groups"></span><h2>Message Groups<a class="headerlink" href="#message-groups" title="Permalink to this heading"></a></h2>
<p>scmaster provides the <a class="reference internal" href="../base/concepts/messaging.html#messaging-groups"><span class="std std-ref">message groups</span></a>. Configure</p>
<ul>
<li><p><a class="reference internal" href="#confval-defaultGroups"><code class="xref std std-confval docutils literal notranslate"><span class="pre">defaultGroups</span></code></a>: Add the groups which can be used by all queues.</p></li>
<li><p><a class="reference internal" href="#confval-queues.-name.groups"><code class="xref std std-confval docutils literal notranslate"><span class="pre">queues.$name.groups</span></code></a>: Set all groups which are used by the given
queue. You may inherit <a class="reference internal" href="#confval-defaultGroups"><code class="xref std std-confval docutils literal notranslate"><span class="pre">defaultGroups</span></code></a>, e.g.:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>queues.production.groups = ${defaultGroups},L1PICK
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Setting any value without inheriting <a class="reference internal" href="#confval-defaultGroups"><code class="xref std std-confval docutils literal notranslate"><span class="pre">defaultGroups</span></code></a> ignores all
values of <a class="reference internal" href="#confval-defaultGroups"><code class="xref std std-confval docutils literal notranslate"><span class="pre">defaultGroups</span></code></a>.</p>
</div>
</li>
</ul>
</section>
<section id="queues">
<h2>Queues<a class="headerlink" href="#queues" title="Permalink to this heading"></a></h2>
<p>scmaster provides <em>queues</em> for separating the processing.
Typically, the default queue <em>production</em> is used. To add new queues</p>
<ol class="arabic simple">
<li><p>Define a new queue by adding a new profile with some name,</p></li>
<li><p>Configure the profile parameters <code class="xref std std-confval docutils literal notranslate"><span class="pre">queues.$name.*</span></code>,</p></li>
<li><p>Register the queue in <a class="reference internal" href="#confval-queues"><code class="xref std std-confval docutils literal notranslate"><span class="pre">queues</span></code></a>.</p></li>
</ol>
</section>
<section id="scheme">
<h2>Scheme<a class="headerlink" href="#scheme" title="Permalink to this heading"></a></h2>
<p>scmaster provides unsecured and secured connection which is addressed by the
scheme values <em>scmp</em> and <em>scmps</em>, respectively, in <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>
when connecting to the messaging.
Read the <a class="reference internal" href="../base/concepts/messaging.html#messaging-scheme"><span class="std std-ref">concepts section</span></a> for more details. <em>scmps</em>
is in use when configuring <a class="reference internal" href="#confval-interface.ssl.bind"><code class="xref std std-confval docutils literal notranslate"><span class="pre">interface.ssl.bind</span></code></a>.</p>
</section>
<section id="database-access">
<h2>Database Access<a class="headerlink" href="#database-access" title="Permalink to this heading"></a></h2>
<p>scmaster reads from and writes to the database and reports the database connection
to the clients of the messaging system (compare with the <a class="reference internal" href="../base/concepts/messaging.html#messaging-db"><span class="std std-ref">concepts section</span></a>).</p>
<p>The database is configured per queue.</p>
<section id="single-machine">
<h3>Single Machine<a class="headerlink" href="#single-machine" title="Permalink to this heading"></a></h3>
<p>When running all <cite>SeisComP</cite> modules on a single machine, the read and write
parameters are typically configured with <em>localhost</em> as a <em>host name</em>.</p>
<p>Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>queues.production.processors.messages.dbstore.read = sysop:sysop@localhost/seiscomp
queues.production.processors.messages.dbstore.write = sysop:sysop@localhost/seiscomp
</pre></div>
</div>
</section>
<section id="multiple-machines">
<h3>Multiple Machines<a class="headerlink" href="#multiple-machines" title="Permalink to this heading"></a></h3>
<p>If the clients are located on machines different from the messaging, the
<em>host name</em> of the read parameter
must be available on the client machine and the client machine must be able to
connect to the host with its name. If the database is on the same machine as the
messaging, the <em>host name</em> of the write connection typically remains <em>localhost</em>.</p>
<p>Example for connecting clients on computerB to the messaging on computerA (compare
with the <a class="reference internal" href="../base/concepts/messaging.html#messaging-distribution"><span class="std std-ref">concepts section</span></a>).</p>
<ul>
<li><p>Configuration of scmaster on computerA:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>queues.production.processors.messages.dbstore.read = sysop:sysop@computerA/seiscomp
queues.production.processors.messages.dbstore.write = sysop:sysop@localhost/seiscomp
</pre></div>
</div>
</li>
<li><p>Global configuration of client on computerB:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>connection.server = computerA/production
</pre></div>
</div>
</li>
</ul>
</section>
<section id="database-proxy">
<h3>Database Proxy<a class="headerlink" href="#database-proxy" title="Permalink to this heading"></a></h3>
<p>scmaster can accept database requests and forward results to clients without
exposing the underlying database. That allows clients to connect to the database
of a particular queue via the Websocket HTTP protocol. No specific database
plugin is required at the client which reduces the complexity of configuration.</p>
<p>Be aware that due to the nature of a proxy which is another layer on top of the
actual database connection the performance is not as high as direct database
access.</p>
<p>To let scmaster return the proxy address of the database connection, set</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>queues.production.processors.messages.dbstore.proxy = true
</pre></div>
</div>
<p>in the configuration file.</p>
</section>
</section>
<section id="access-control">
<h2>Access Control<a class="headerlink" href="#access-control" title="Permalink to this heading"></a></h2>
<p>scmaster does not provide any built-in access control to connecting clients.
The only exception is the possibility to verify client certificates against
the server certificate if SSL is enabled.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>interface.ssl.verifyPeer = true
</pre></div>
</div>
<p>It is required that the client certificate is signed by the server certificate
otherwise the client connection will be rejected.</p>
</section>
<section id="module-configuration">
<span id="scmaster-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scmaster.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scmaster.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scmaster.cfg</span></code></div>
</div>
<p>scmaster inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-defaultGroups">
<span class="sig-name descname"><span class="pre">defaultGroups</span></span><a class="headerlink" href="#confval-defaultGroups" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">AMPLITUDE,</span> <span class="pre">PICK,</span> <span class="pre">LOCATION,</span> <span class="pre">MAGNITUDE,</span> <span class="pre">FOCMECH,</span> <span class="pre">EVENT,</span> <span class="pre">QC,</span> <span class="pre">PUBLICATION,</span> <span class="pre">GUI,</span> <span class="pre">INVENTORY,</span> <span class="pre">CONFIG,</span> <span class="pre">LOGGING,</span> <span class="pre">SERVICE_REQUEST,</span> <span class="pre">SERVICE_PROVIDE,</span> <span class="pre">STATUS_GROUP</span></code></p>
<p>Type: <em>list:string</em></p>
<p>The default set of message groups for each queue. Only used
if a queues group list is unset (note: empty is not unset).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues">
<span class="sig-name descname"><span class="pre">queues</span></span><a class="headerlink" href="#confval-queues" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">production,</span> <span class="pre">playback</span></code></p>
<p>Type: <em>list:string</em></p>
<p>Enable messaging queues defined as profile in queues. The profile
names are the final queue names.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>interface.*</strong>
<em>Control the messaging interface. The default protocol is</em>
<em>“scmp” but “scmps” (secure protocol) is</em>
<em>used when valid SSL certificate and key are configured.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.bind">
<span class="sig-name descname"><span class="pre">interface.bind</span></span><a class="headerlink" href="#confval-interface.bind" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.0.0.0:18180</span></code></p>
<p>Type: <em>ipbind</em></p>
<p>Local bind address and port of the messaging system.
0.0.0.0:18180 accepts connections from all clients,
127.0.0.1:18180 only from localhost.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.acl">
<span class="sig-name descname"><span class="pre">interface.acl</span></span><a class="headerlink" href="#confval-interface.acl" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:ipmask</em></p>
<p>The IP access control list for clients which are allowed
to connect to the interface. Separate each IP with a space
and put the entire list in double quotes, e.g.
&quot;127.0.0.1 192.168.1.2 192.168.0.0/16&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.socketPortReuse">
<span class="sig-name descname"><span class="pre">interface.socketPortReuse</span></span><a class="headerlink" href="#confval-interface.socketPortReuse" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>SO_REUSEADDR socket option for the TCP listening socket.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>interface.ssl.*</strong>
<em>SSL encryption is used if key and certificate are configured.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.ssl.bind">
<span class="sig-name descname"><span class="pre">interface.ssl.bind</span></span><a class="headerlink" href="#confval-interface.ssl.bind" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.0.0.0:-1</span></code></p>
<p>Type: <em>ipbind</em></p>
<p>Additional local bind address and port of the messaging
system in case SSL encryption is active.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.ssl.acl">
<span class="sig-name descname"><span class="pre">interface.ssl.acl</span></span><a class="headerlink" href="#confval-interface.ssl.acl" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:ipmask</em></p>
<p>The IP access control list for clients which are allowed
to connect to the interface. See interface.acl for
further details.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.ssl.socketPortReuse">
<span class="sig-name descname"><span class="pre">interface.ssl.socketPortReuse</span></span><a class="headerlink" href="#confval-interface.ssl.socketPortReuse" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>SO_REUSEADDR socket option for the TCP listening socket.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.ssl.key">
<span class="sig-name descname"><span class="pre">interface.ssl.key</span></span><a class="headerlink" href="#confval-interface.ssl.key" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.ssl.certificate">
<span class="sig-name descname"><span class="pre">interface.ssl.certificate</span></span><a class="headerlink" href="#confval-interface.ssl.certificate" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interface.ssl.verifyPeer">
<span class="sig-name descname"><span class="pre">interface.ssl.verifyPeer</span></span><a class="headerlink" href="#confval-interface.ssl.verifyPeer" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled then the certificate of a connecting client
is verified against the servers certificate. It is
required that the client certificate is signed by the
server certificate otherwise the connection is refused.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>queues.*</strong>
<em>Set the parameters for each messaging queue. The queues are used</em>
<em>when listed in the “queues” parameter. Several queues</em>
<em>can be used in parallel. For queues with without databases leave</em>
<em>the processor parameters empty.</em></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>queues.$name.*</strong>
$name is a placeholder for the name to be used and needs to be added to <a class="reference internal" href="#confval-queues"><code class="xref std std-confval docutils literal notranslate"><span class="pre">queues</span></code></a> to become active.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">queues</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>a,b
queues.a.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
queues.b.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
<span class="c1"># c is not active because it has not been added</span>
<span class="c1"># to the list of queues</span>
queues.c.value1<span class="w"> </span><span class="o">=</span><span class="w"> </span>...
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.groups">
<span class="sig-name descname"><span class="pre">queues.$name.groups</span></span><a class="headerlink" href="#confval-queues.-name.groups" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define the list of message groups added to the queue.
If unset, then the defaultGroups will be used.
A queue will always add the default group &quot;STATUS_GROUP&quot;.
This parameter overrides defaultGroups.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.acl">
<span class="sig-name descname"><span class="pre">queues.$name.acl</span></span><a class="headerlink" href="#confval-queues.-name.acl" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.0.0.0/0</span></code></p>
<p>Type: <em>list:ipmask</em></p>
<p>The IP access control list for clients which are allowed
to join the queue. See interface.acl for further details.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.maximumPayloadSize">
<span class="sig-name descname"><span class="pre">queues.$name.maximumPayloadSize</span></span><a class="headerlink" href="#confval-queues.-name.maximumPayloadSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1048576</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>B</em></p>
<p>The maximum size in bytes of a message to be accepted.
Clients which send larger messages will be disconnected.
The default is 1MB.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.plugins">
<span class="sig-name descname"><span class="pre">queues.$name.plugins</span></span><a class="headerlink" href="#confval-queues.-name.plugins" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of plugins required by this queue. This is just a
convenience parameter to improve configurations
readability. The plugins can also be added to the
global list of module plugins.</p>
<p>Example: dbstore</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.processors.messages">
<span class="sig-name descname"><span class="pre">queues.$name.processors.messages</span></span><a class="headerlink" href="#confval-queues.-name.processors.messages" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Interface name. For now, use &quot;dbstore&quot;to
use a database.</p>
<p>Use empty for testing or playbacks without a database.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>queues.$name.processors.messages.dbstore.*</strong>
<em>Define the database connection parameters.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.processors.messages.dbstore.driver">
<span class="sig-name descname"><span class="pre">queues.$name.processors.messages.dbstore.driver</span></span><a class="headerlink" href="#confval-queues.-name.processors.messages.dbstore.driver" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Selected the database driver to use.
Database drivers are available through plugins.
The default plugin is dbmysql which supports
the MYSQL database server. It is activated
with the core.plugins parameter.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.processors.messages.dbstore.read">
<span class="sig-name descname"><span class="pre">queues.$name.processors.messages.dbstore.read</span></span><a class="headerlink" href="#confval-queues.-name.processors.messages.dbstore.read" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Set the database read connection which is
reported to clients that connect to this server.
If a remote setup should be implemented,
ensure that the hostname is reachable from
the remote computer.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.processors.messages.dbstore.write">
<span class="sig-name descname"><span class="pre">queues.$name.processors.messages.dbstore.write</span></span><a class="headerlink" href="#confval-queues.-name.processors.messages.dbstore.write" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Set the database write connection which is
private to scmaster.
A separate write connection enables different
permissions on the database level for scmaster
and clients.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.processors.messages.dbstore.proxy">
<span class="sig-name descname"><span class="pre">queues.$name.processors.messages.dbstore.proxy</span></span><a class="headerlink" href="#confval-queues.-name.processors.messages.dbstore.proxy" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled then the database connection as configured
in read is not being returned to the client
but the URL &quot;proxy://&quot;. This URL
tells the client to open the database via the
websocket proxy at the messaging address,
e.g. http://localhost/production/db. The same
hostname and queue must be used as for the
initial messaging connection.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-queues.-name.processors.messages.dbstore.strictVersionMatch">
<span class="sig-name descname"><span class="pre">queues.$name.processors.messages.dbstore.strictVersionMatch</span></span><a class="headerlink" href="#confval-queues.-name.processors.messages.dbstore.strictVersionMatch" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled, the plugin will check the database
schema version and refuse to start if the
version doesnt match the latest version.
If disabled and the an object needs to be
stored, which is incompatible with the
database schema, this object is lost.
Leave this option enabled unless you know
exactly what are you doing and what the
consequences are.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-http.filebase">
<span class="sig-name descname"><span class="pre">http.filebase</span></span><a class="headerlink" href="#confval-http.filebase" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/scmaster/http/</span></code></p>
<p>Type: <em>path</em></p>
<p>The directory served by the http server at staticPath.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-http.staticPath">
<span class="sig-name descname"><span class="pre">http.staticPath</span></span><a class="headerlink" href="#confval-http.staticPath" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/</span></code></p>
<p>Type: <em>string</em></p>
<p>The URL path at which html files and assets are available.
All files under filebase will be served at this URL path.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-http.brokerPath">
<span class="sig-name descname"><span class="pre">http.brokerPath</span></span><a class="headerlink" href="#confval-http.brokerPath" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/</span></code></p>
<p>Type: <em>string</em></p>
<p>The URL path at which the broker websocket is available.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scmaster [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-h">
<span id="cmdoption-scmaster-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-V">
<span id="cmdoption-scmaster-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-D">
<span id="cmdoption-scmaster-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-v">
<span id="cmdoption-scmaster-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-q">
<span id="cmdoption-scmaster-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-s">
<span id="cmdoption-scmaster-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-l">
<span id="cmdoption-scmaster-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmaster-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="wired">
<h3>Wired<a class="headerlink" href="#wired" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-bind">
<span class="sig-name descname"><span class="pre">--bind</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-bind" title="Permalink to this definition"></a></dt>
<dd><p>The non-encrypted bind address. Format [ip:]port</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmaster-sbind">
<span class="sig-name descname"><span class="pre">--sbind</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmaster-sbind" title="Permalink to this definition"></a></dt>
<dd><p>The encrypted bind address. Format: [ip:]port</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scmaster</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#message-groups">Message Groups</a></li>
<li><a class="reference internal" href="#queues">Queues</a></li>
<li><a class="reference internal" href="#scheme">Scheme</a></li>
<li><a class="reference internal" href="#database-access">Database Access</a><ul>
<li><a class="reference internal" href="#single-machine">Single Machine</a></li>
<li><a class="reference internal" href="#multiple-machines">Multiple Machines</a></li>
<li><a class="reference internal" href="#database-proxy">Database Proxy</a></li>
</ul>
</li>
<li><a class="reference internal" href="#access-control">Access Control</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#wired">Wired</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../toc/messaging.html"
title="previous chapter">Messaging</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../toc/processing.html"
title="next chapter">Processing</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmaster.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,472 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scmm &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scmv" href="scmv.html" />
<link rel="prev" title="scheli" href="scheli.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">6.9.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="scmv.html" title="scmv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scheli.html" title="scheli"
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scmm">
<span id="id1"></span><h1>scmm<a class="headerlink" href="#scmm" title="Permalink to this heading"></a></h1>
<p><strong>Messaging Monitor</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><strong>scmm</strong> is the messaging monitor, the graphical interface to <a class="reference internal" href="scm.html#scm"><span class="std std-ref">scm</span></a>. It allows to
view the messages from all modules sent around by the SeisComP messaging system.
Therefore, <strong>scmm</strong> can be used to debug configured message groups and module
connections, e.g. in a system with several processing pipelines and specific
message groups.</p>
<p>In addition, <strong>scmm</strong> allows to view the content of single messges
as well as the memory consumption and other statistics of all modules connected
to the SeisComP messaging system.</p>
<figure class="align-center" id="id2">
<a class="reference internal image-reference" href="../_images/scmm_messages.png"><img alt="../_images/scmm_messages.png" src="../_images/scmm_messages.png" style="width: 8cm;" /></a>
<figcaption>
<p><span class="caption-text">View message notifications.</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<figure class="align-center" id="id3">
<a class="reference internal image-reference" href="../_images/scmm_message.png"><img alt="../_images/scmm_message.png" src="../_images/scmm_message.png" style="width: 8cm;" /></a>
<figcaption>
<p><span class="caption-text">View the message content by clicking on individual messages.</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<figure class="align-center" id="id4">
<a class="reference internal image-reference" href="../_images/scmm_clients.png"><img alt="../_images/scmm_clients.png" src="../_images/scmm_clients.png" style="width: 8cm;" /></a>
<figcaption>
<p><span class="caption-text">View module memory consumptions.</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<figure class="align-center" id="id5">
<a class="reference internal image-reference" href="../_images/scmm_statistics.png"><img alt="../_images/scmm_statistics.png" src="../_images/scmm_statistics.png" style="width: 8cm;" /></a>
<figcaption>
<p><span class="caption-text">View module statistics.</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="module-configuration">
<span id="scmm-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scmm.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scmm.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scmm.cfg</span></code></div>
</div>
<p>scmm inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scmm [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-h">
<span id="cmdoption-scmm-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-V">
<span id="cmdoption-scmm-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-v">
<span id="cmdoption-scmm-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-q">
<span id="cmdoption-scmm-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-s">
<span id="cmdoption-scmm-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-l">
<span id="cmdoption-scmm-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-u">
<span id="cmdoption-scmm-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-H">
<span id="cmdoption-scmm-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-t">
<span id="cmdoption-scmm-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-g">
<span id="cmdoption-scmm-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-S">
<span id="cmdoption-scmm-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-d">
<span id="cmdoption-scmm-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-I">
<span id="cmdoption-scmm-record-url"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmm-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="user-interface">
<h3>User interface<a class="headerlink" href="#user-interface" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-F">
<span id="cmdoption-scmm-full-screen"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--full-screen</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-F" title="Permalink to this definition"></a></dt>
<dd><p>Start the application in fullscreen</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmm-N">
<span id="cmdoption-scmm-non-interactive"></span><span class="sig-name descname"><span class="pre">-N</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--non-interactive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmm-N" title="Permalink to this definition"></a></dt>
<dd><p>Use non interactive presentation mode</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scmm</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scheli.html"
title="previous chapter">scheli</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scmv.html"
title="next chapter">scmv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmm.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,284 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scmssort &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scorgls" href="scorgls.html" />
<link rel="prev" title="scmapcut" href="scmapcut.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">6.9.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="scorgls.html" title="scorgls"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scmapcut.html" title="scmapcut"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scmssort">
<span id="id1"></span><h1>scmssort<a class="headerlink" href="#scmssort" title="Permalink to this heading"></a></h1>
<p><strong>Read and manipulate miniSEED records</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scmssort reads unsorted (and possibly multiplexed) MiniSEED files and sorts
the individual records by time. This is useful e.g. for simulating data
acquisition and playbacks. Removing of duplicate data and trimming of time
window is available.</p>
<p>scmssort reads single files and output to the command line. Cat many files
to read them at the same time. In this way huge amount of data can be processed
efficiently.</p>
<p>Applications to miniSEED records:</p>
<ul class="simple">
<li><p>Sort records by time, e.g., for playbacks.</p></li>
<li><p>Remove duplicate records from files and clean waveform archives.</p></li>
<li><p>Filter data records, i.e. keep or remove them, based on</p>
<ul>
<li><p>time windows,</p></li>
<li><p>stream lists where each line has the format NET.STA.LOC.CHA including regular
expressions. Such stream lists can be generated, e.g., using <a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>.</p></li>
</ul>
</li>
</ul>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<ul class="simple">
<li><p>Combine with <a class="reference internal" href="scart.html#scart"><span class="std std-ref">scart</span></a> or <a class="reference internal" href="msrtsimul.html#msrtsimul"><span class="std std-ref">msrtsimul</span></a> to archive data or to make
playbacks with real-time simulations.</p></li>
<li><p>Filter data by stream IDs using NSLC lists which can be generated using
<a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>.</p></li>
</ul>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Read a single miniSEED data file. The records are sorted by endtime and
duplicates are removed.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmssort<span class="w"> </span>-vuE<span class="w"> </span>unsorted.mseed<span class="w"> </span>&gt;<span class="w"> </span>sorted.mseed
</pre></div>
</div>
</li>
<li><p>Read all files ending with “.mseed” at the same time. The data are trimmed
to a time window and duplicated or empty records are ignored.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cat<span class="w"> </span>*.mseed<span class="w"> </span><span class="p">|</span><span class="w"> </span>scmssort<span class="w"> </span>-vuiE<span class="w"> </span>-t<span class="w"> </span><span class="m">2020</span>-03-28T15:48~2020-03-28T16:18<span class="w"> </span>&gt;<span class="w"> </span>sorted.mseed
</pre></div>
</div>
</li>
<li><p>Remove streams listed by stream code and sort records by end time. Also ignore
duplicated or empty records. Stream lists can be generated, e.g., by <a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmssort<span class="w"> </span>-vuiE<span class="w"> </span>--rm<span class="w"> </span>-l<span class="w"> </span>stream-list.txt<span class="w"> </span>test.mseed<span class="w"> </span>&gt;<span class="w"> </span>sorted.mseed
</pre></div>
</div>
</li>
<li><p>Extract streams by time and stream code and sort records by end time. Also ignore
duplicated or empty records.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span>CX.PB01..BH?<span class="w"> </span><span class="p">|</span><span class="w"> </span>scmssort<span class="w"> </span>-vuE<span class="w"> </span>-t<span class="w"> </span><span class="m">2007</span>-03-28T15:48~2007-03-28T16:18<span class="w"> </span>-l<span class="w"> </span>-<span class="w"> </span>test.mseed<span class="w"> </span>&gt;<span class="w"> </span>sorted.mseed
scmssort<span class="w"> </span>-vuiE<span class="w"> </span>-t<span class="w"> </span><span class="m">2007</span>-03-28T15:48~2007-03-28T16:18<span class="w"> </span>-l<span class="w"> </span>stream-list.txt<span class="w"> </span>test.mseed<span class="w"> </span>&gt;<span class="w"> </span>sorted.mseed
</pre></div>
</div>
</li>
</ol>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scmssort [options] input</strong></p>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-h">
<span id="cmdoption-scmssort-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-h" title="Permalink to this definition"></a></dt>
<dd><p>Show the command-line help and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-E">
<span id="cmdoption-scmssort-sort-by-end-time"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sort-by-end-time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-E" title="Permalink to this definition"></a></dt>
<dd><p>Sort by end time.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-i">
<span id="cmdoption-scmssort-ignore"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-i" title="Permalink to this definition"></a></dt>
<dd><p>Ignore all records which have no data samples.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-l">
<span id="cmdoption-scmssort-list"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-l" title="Permalink to this definition"></a></dt>
<dd><p>File with streams to filter the records. One stream per
line. Instead of a file read the from stdin (-). Line
format: NET.STA.LOC.CHA - wildcards and regular expressions
are considered. Example: CX.*..BH? .</p>
<p>NSLC lists may be generated, e.g., using scinv.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-o">
<span id="cmdoption-scmssort-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-o" title="Permalink to this definition"></a></dt>
<dd><p>Name of output file for miniSEED data (default is stdout).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-r">
<span id="cmdoption-scmssort-rm"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--rm</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-r" title="Permalink to this definition"></a></dt>
<dd><p>Remove all traces in stream list given by --list
instead of keeping them.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-t">
<span id="cmdoption-scmssort-time-window"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-window</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-t" title="Permalink to this definition"></a></dt>
<dd><p>Specify time window (as one -properly quoted- string).
Times are of course UTC and separated by a tilde ~</p>
<p>Example:</p>
<p>2020-03-28T15:48~2020-03-28T16:18</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-u">
<span id="cmdoption-scmssort-uniqueness"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--uniqueness</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-u" title="Permalink to this definition"></a></dt>
<dd><p>Ensure uniqueness of output, i.e. skip duplicate records.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmssort-v">
<span id="cmdoption-scmssort-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmssort-v" title="Permalink to this definition"></a></dt>
<dd><p>Run in verbose mode.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scmssort</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scmapcut.html"
title="previous chapter">scmapcut</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scorgls.html"
title="next chapter">scorgls</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmssort.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,855 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scmv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scolv" href="scolv.html" />
<link rel="prev" title="scmm" href="scmm.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">6.9.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="scolv.html" title="scolv"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scmm.html" title="scmm"
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scmv">
<span id="id1"></span><h1>scmv<a class="headerlink" href="#scmv" title="Permalink to this heading"></a></h1>
<p><strong>Map view</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scmv visualizes the actual information regarding earthquakes, trigger status,
ground motion and station quality. This information is visualized in a map
showing also the topography of the region including bathymetry, state borders
and geologic faults. scmv provides two different tabs with maps showing the
ground motion and the network status.</p>
<section id="ground-motion-status">
<h3>Ground motion status<a class="headerlink" href="#ground-motion-status" title="Permalink to this heading"></a></h3>
<p>The ground motion tab (fig. <a class="reference internal" href="#fig-scmv-gm"><span class="std std-ref">Ground motion tab</span></a>) shows the actual groundmotion
in nm/s at each station color-coded. Furthermore the trigger status (new picks)
of the stations are announced by blinking triangles (the same in all
other tabs). In case a new pick is associated to an event, the blinking color
changes from red to green (default). Events are represented by open circles
and the depth is color-coded. By right mouse click on the symbol of a station
more detailed information are shown in an information widget (fig. <a class="reference internal" href="#fig-scmv-infowidget"><span class="std std-ref">Station information widget</span></a>).</p>
<figure class="align-center" id="id2">
<span id="fig-scmv-gm"></span><a class="reference internal image-reference" href="../_images/ground-motion.png"><img alt="../_images/ground-motion.png" src="../_images/ground-motion.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Ground motion tab</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
<div class="legend">
<p>Tab 1-2 = Ground Motion, Network Status tab; Station A = station with ground
motion between 0 and 200 nm/s; Station B = triggering (red blinking) station;
Station C = station of undefined status; Station D = triggering and associated
station (green blinking); EQ = location of the earthquake/event; P = spreading
of the P-wave; S = spreading of the S-wave; Legend = ground motion scale.</p>
</div>
</figcaption>
</figure>
</section>
<section id="network-status">
<h3>Network status<a class="headerlink" href="#network-status" title="Permalink to this heading"></a></h3>
<p>The network status tab (fig. <a class="reference internal" href="#fig-scmv-netstat"><span class="std std-ref">Network status tab</span></a>) visualizes the quality control
parameters of all shown stations. The colors of the triangles represent the data
the selected parameters of a station, e.g. latency or delay. More detailed information about station quality
can be derived by opening an information widget (fig. <a class="reference internal" href="#fig-scmv-infowidget"><span class="std std-ref">Station information widget</span></a> left)
with a right mouse click on the symbol.</p>
<figure class="align-center" id="id3">
<span id="fig-scmv-netstat"></span><a class="reference internal image-reference" href="../_images/netstat.png"><img alt="../_images/netstat.png" src="../_images/netstat.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Network status tab</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
<div class="legend">
<p>Station A = station with up to 20 sec data latency/delay;
Station B = station with up to 10 min data latency/delay and a warning;
Station C = disabled station;
EQ = location of a recent or historic earthquake/event;
Legend = scale of the delay;
Status = connection status.</p>
</div>
</figcaption>
</figure>
<p>The visualized QC parameters can be selected in the QC parameters widget of scmv.</p>
<figure class="align-center" id="id4">
<span id="fig-scmv-qc-select"></span><a class="reference internal image-reference" href="../_images/qc-selection.png"><img alt="../_images/qc-selection.png" src="../_images/qc-selection.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">QC parameters selection widget</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>The station information widget opens by right mouse click on a station symbol
in one of the scmv maps. The widget gives a more detailed list of parameters.
For a station general information (coordinates, network code etc.), quality
parameter (latency, gaps etc.), amplitude information and the actual waveform
data are provided. For an event information like the location, the number of
stations and the azimuthal gap are shown.</p>
<figure class="align-center" id="id5">
<span id="fig-scmv-infowidget"></span><a class="reference internal image-reference" href="../_images/infowidget-station.png"><img alt="../_images/infowidget-station.png" src="../_images/infowidget-station.png" style="width: 8cm;" /></a>
<figcaption>
<p><span class="caption-text">Station information widget</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>The info widget of a station shows station information like network code
and location. The quality of the station can be checked here. The lower
part shows the last 15 minutes of waveforms including picks (if available).</p>
</section>
<section id="event-information">
<h3>Event information<a class="headerlink" href="#event-information" title="Permalink to this heading"></a></h3>
<p>In addition to the current event scmv also shows all events it has currently
saved in its session as circles. This depends on the configured time span it remembers
events. Showing the events can give a convenient overview of the network activity.
If available focal mechanisms are displayed with dashed lines connecting to their location.
The circles and focal mechanisms are again colored by their depth and sized by
magnitude.</p>
<figure class="align-center" id="id6">
<span id="fig-scmv-historic-origins"></span><a class="reference internal image-reference" href="../_images/historic-origins.png"><img alt="../_images/historic-origins.png" src="../_images/historic-origins.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Show historic origins</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
<div class="legend">
<p>All historic origins currently saved in scmv are shown as circles.</p>
</div>
</figcaption>
</figure>
<p>The events shown an the map can be confined by selecting the mode and the status
of preferred origins in the event selection widget.</p>
<figure class="align-center" id="id7">
<span id="fig-scmv-event-select"></span><a class="reference internal image-reference" href="../_images/event-selection.png"><img alt="../_images/event-selection.png" src="../_images/event-selection.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Event selection widget</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<p>The event information widget opens by right mouse click on an event symbol.
It shows event details.
Clicking on the “Show Details” button allows to open the preferred origin of
the event in other GUIs such as in scolv.</p>
<figure class="align-center" id="id8">
<span id="fig-scmv-event-info"></span><a class="reference internal image-reference" href="../_images/event-info.png"><img alt="../_images/event-info.png" src="../_images/event-info.png" style="width: 8cm;" /></a>
<figcaption>
<p><span class="caption-text">Event information widget</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
</section>
<section id="hotkeys">
<h2>Hotkeys<a class="headerlink" href="#hotkeys" title="Permalink to this heading"></a></h2>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Hotkey</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F2</kbd></p></td>
<td><p>Setup connection dialog</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F3</kbd></p></td>
<td><p>Toggle ray paths and associated stations</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F6</kbd></p></td>
<td><p>Hide propagation of P and S waves</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F7</kbd></p></td>
<td><p>Toggle legend</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F8</kbd></p></td>
<td><p>Toggle historic origins</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F9</kbd></p></td>
<td><p>Toggle station annotation</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">F10</kbd></p></td>
<td><p>Toggle event list (event tab)</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">F11</kbd></p></td>
<td><p>Toggle full screen mode</p></td>
</tr>
<tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">CTRL</kbd> <kbd class="kbd docutils literal notranslate"></kbd>+<kbd class="kbd docutils literal notranslate"></kbd> <kbd class="kbd docutils literal notranslate">f</kbd></kbd></p></td>
<td><p>Seach station</p></td>
</tr>
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Arrows</kbd></p></td>
<td><p>Move focus</p></td>
</tr>
<tr class="row-even"><td><p>Mouse wheel</p></td>
<td><p>Zoom in or out</p></td>
</tr>
<tr class="row-odd"><td><p>Double click</p></td>
<td><p>Center map</p></td>
</tr>
<tr class="row-even"><td><p>Right mouse button</p></td>
<td><p>Open info widget</p></td>
</tr>
<tr class="row-odd"><td><p>Mid mouse button</p></td>
<td><p>Set preliminary origin</p></td>
</tr>
</tbody>
</table>
</section>
<section id="use-cases">
<h2>Use cases<a class="headerlink" href="#use-cases" title="Permalink to this heading"></a></h2>
<section id="get-station-information">
<h3>Get station information<a class="headerlink" href="#get-station-information" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Position the mouse above a triangle representing a station.</p></li>
<li><p>Click the right mouse button for opening the station info widget.</p></li>
<li><p>Choose one station in case several stations are in the selection range.</p></li>
</ul>
</section>
<section id="get-event-information">
<h3>Get event information<a class="headerlink" href="#get-event-information" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Position the mouse above a circle representing a location of an event.</p></li>
<li><p>Click the right mouse button for opening the event info widget.</p></li>
<li><p>Choose one event in case several events are in the selection range.</p></li>
</ul>
</section>
<section id="set-preliminary-origin">
<h3>Set preliminary origin<a class="headerlink" href="#set-preliminary-origin" title="Permalink to this heading"></a></h3>
<ul>
<li><p>Position the mouse in the map</p></li>
<li><p>Press the middle mouse button</p></li>
<li><p>Set date &amp; time and latitude, longitude &amp; depth</p></li>
<li><p>Press “Create” to open the origin in another GUI, e.g. scolv.</p>
<a class="reference internal image-reference" href="../_images/artificial-origin.png"><img alt="../_images/artificial-origin.png" src="../_images/artificial-origin.png" style="width: 4cm;" /></a>
</li>
</ul>
</section>
<section id="search-station-network">
<h3>Search station/network<a class="headerlink" href="#search-station-network" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Press <kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">CTRL</kbd> <kbd class="kbd docutils literal notranslate"></kbd>+<kbd class="kbd docutils literal notranslate"></kbd> <kbd class="kbd docutils literal notranslate">f</kbd></kbd></p></li>
<li><p>Type station/network name</p></li>
<li><p>Double click in a station in the list to center the map at this location</p></li>
</ul>
</section>
</section>
<section id="module-configuration">
<span id="scmv-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scmv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scmv.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scmv.cfg</span></code></div>
</div>
<p>scmv inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-displaymode">
<span class="sig-name descname"><span class="pre">displaymode</span></span><a class="headerlink" href="#confval-displaymode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Start scmv in one of the available display modes:</p>
<p>groundmotion or qualitycontrol</p>
<p>and without tabs and menus as walldisplay.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-groundMotionRecordLifeSpan">
<span class="sig-name descname"><span class="pre">groundMotionRecordLifeSpan</span></span><a class="headerlink" href="#confval-groundMotionRecordLifeSpan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>Set the maximum latency in seconds of the ground motion records
to be valid.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-removeEventDataOlderThan">
<span class="sig-name descname"><span class="pre">removeEventDataOlderThan</span></span><a class="headerlink" href="#confval-removeEventDataOlderThan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">43200</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Set the time span in seconds to keep events.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-readEventsNotOlderThan">
<span class="sig-name descname"><span class="pre">readEventsNotOlderThan</span></span><a class="headerlink" href="#confval-readEventsNotOlderThan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Set the time span in seconds to read events initially from
database.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-centerOrigins">
<span class="sig-name descname"><span class="pre">centerOrigins</span></span><a class="headerlink" href="#confval-centerOrigins" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If a new origin/event is set/selected this option defines if the
map is centered or not at the origin location.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventActivityLifeSpan">
<span class="sig-name descname"><span class="pre">eventActivityLifeSpan</span></span><a class="headerlink" href="#confval-eventActivityLifeSpan" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">900</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Time span of which an event is active after origin time to
show blinking associated stations.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-expiredEventsInterval">
<span class="sig-name descname"><span class="pre">expiredEventsInterval</span></span><a class="headerlink" href="#confval-expiredEventsInterval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>A positive value (greater than zero) defines the interval to check
for expired events. A negative or zero value disables the interval
check and expired events are only removed when a new event is declared
or an existing event is updated.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-annotations">
<span class="sig-name descname"><span class="pre">annotations</span></span><a class="headerlink" href="#confval-annotations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enable/disable drawing of station annotations at startup.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-annotationsWithChannels">
<span class="sig-name descname"><span class="pre">annotationsWithChannels</span></span><a class="headerlink" href="#confval-annotationsWithChannels" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enable/disable drawing of station annotations with
location/channel codes.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-mapLegendPosition">
<span class="sig-name descname"><span class="pre">mapLegendPosition</span></span><a class="headerlink" href="#confval-mapLegendPosition" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">topleft</span></code></p>
<p>Type: <em>string</em></p>
<p>Set the location of the map symbol legend (QC, ground motion).
Use either: topleft, topright, bottomright or bottomleft.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventLegendPosition">
<span class="sig-name descname"><span class="pre">eventLegendPosition</span></span><a class="headerlink" href="#confval-eventLegendPosition" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">bottomleft</span></code></p>
<p>Type: <em>string</em></p>
<p>Set the location of the event symbol legend. Use either:
topleft, topright, bottomright or bottomleft.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventTable.visible">
<span class="sig-name descname"><span class="pre">eventTable.visible</span></span><a class="headerlink" href="#confval-eventTable.visible" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to show the event table initially or not.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-eventTable.columns">
<span class="sig-name descname"><span class="pre">eventTable.columns</span></span><a class="headerlink" href="#confval-eventTable.columns" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>The columns that are visible in the table. If nothing
is specified then all columns are visible. Valid column names are:
&quot;Event&quot;, &quot;Origin Time&quot;, &quot;Magnitude&quot;,
&quot;Magnitude Type&quot;, &quot;Region&quot;, &quot;Latitude&quot;,
&quot;Longitude&quot;, &quot;Depth&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-stations.groundMotionFilter">
<span class="sig-name descname"><span class="pre">stations.groundMotionFilter</span></span><a class="headerlink" href="#confval-stations.groundMotionFilter" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&quot;RMHP(50)&gt;&gt;ITAPER(20)&gt;&gt;BW(2,0.04,2)&quot;</span></code></p>
<p>Type: <em>string</em></p>
<p>The filter applied to waveforms for measuring ground motion.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>display.*</strong>
<em>Allow to define an initial rectangular region for the map.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.latmin">
<span class="sig-name descname"><span class="pre">display.latmin</span></span><a class="headerlink" href="#confval-display.latmin" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-90</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Minimum latitude in degrees.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.lonmin">
<span class="sig-name descname"><span class="pre">display.lonmin</span></span><a class="headerlink" href="#confval-display.lonmin" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Minimum longitude in degrees.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.latmax">
<span class="sig-name descname"><span class="pre">display.latmax</span></span><a class="headerlink" href="#confval-display.latmax" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">90</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum latitude in degrees.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-display.lonmax">
<span class="sig-name descname"><span class="pre">display.lonmax</span></span><a class="headerlink" href="#confval-display.lonmax" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum longitude in degrees.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scmv [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-h">
<span id="cmdoption-scmv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-V">
<span id="cmdoption-scmv-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-v">
<span id="cmdoption-scmv-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-q">
<span id="cmdoption-scmv-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-s">
<span id="cmdoption-scmv-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-l">
<span id="cmdoption-scmv-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-u">
<span id="cmdoption-scmv-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-H">
<span id="cmdoption-scmv-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-t">
<span id="cmdoption-scmv-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-g">
<span id="cmdoption-scmv-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-S">
<span id="cmdoption-scmv-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-d">
<span id="cmdoption-scmv-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-I">
<span id="cmdoption-scmv-record-url"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-city-xml">
<span class="sig-name descname"><span class="pre">--city-xml</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-city-xml" title="Permalink to this definition"></a></dt>
<dd><p>The path to the cities XML file. This overrides the default
paths. Compare with the global parameter &quot;citiesXML&quot;.</p>
</dd></dl>
</section>
<section id="user-interface">
<h3>User interface<a class="headerlink" href="#user-interface" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-F">
<span id="cmdoption-scmv-full-screen"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--full-screen</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-F" title="Permalink to this definition"></a></dt>
<dd><p>Start the application filling the entire screen.
This only works with GUI applications.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-N">
<span id="cmdoption-scmv-non-interactive"></span><span class="sig-name descname"><span class="pre">-N</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--non-interactive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-N" title="Permalink to this definition"></a></dt>
<dd><p>Use non-interactive presentation mode. This only works with
GUI applications.</p>
</dd></dl>
</section>
<section id="mapview">
<h3>Mapview<a class="headerlink" href="#mapview" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-displaymode">
<span class="sig-name descname"><span class="pre">--displaymode</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scmv-displaymode" title="Permalink to this definition"></a></dt>
<dd><p>Start scmv as walldisplay.
Modes: groundmotion, qualitycontrol</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scmv-with-legend">
<span class="sig-name descname"><span class="pre">--with-legend</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmv-with-legend" title="Permalink to this definition"></a></dt>
<dd><p>Show the map legend if started as walldisplay.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scmv</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#ground-motion-status">Ground motion status</a></li>
<li><a class="reference internal" href="#network-status">Network status</a></li>
<li><a class="reference internal" href="#event-information">Event information</a></li>
</ul>
</li>
<li><a class="reference internal" href="#hotkeys">Hotkeys</a></li>
<li><a class="reference internal" href="#use-cases">Use cases</a><ul>
<li><a class="reference internal" href="#get-station-information">Get station information</a></li>
<li><a class="reference internal" href="#get-event-information">Get event information</a></li>
<li><a class="reference internal" href="#set-preliminary-origin">Set preliminary origin</a></li>
<li><a class="reference internal" href="#search-station-network">Search station/network</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#cities">Cities</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#mapview">Mapview</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scmm.html"
title="previous chapter">scmm</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scolv.html"
title="next chapter">scolv</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,400 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scorgls &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scquery" href="scquery.html" />
<link rel="prev" title="scmssort" href="scmssort.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">6.9.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="scquery.html" title="scquery"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scmssort.html" title="scmssort"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scorgls">
<span id="id1"></span><h1>scorgls<a class="headerlink" href="#scorgls" title="Permalink to this heading"></a></h1>
<p><strong>List origin IDs from database.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>scorgls</em> lists all available origin IDs within a given time range to stdout.
Origins are fetched from database or read from a <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> file.</p>
<p>Similarly, use <a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a> for listing all event IDs. In extension to
<em>scorgls</em> and <a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a> <a class="reference internal" href="scquery.html#scquery"><span class="std std-ref">scquery</span></a> can search for parameters based on
complex custom queries.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Print all origin IDs for the complete year 2012.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scorgls<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--begin<span class="w"> </span><span class="s2">&quot;2012-01-01 00:00:00&quot;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--end<span class="w"> </span><span class="s2">&quot;2013-01-01 00:00:00&quot;</span>
</pre></div>
</div>
</li>
<li><p>Print the IDs of all origins provided with the XML file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtls<span class="w"> </span>-i<span class="w"> </span>origins.xml
</pre></div>
</div>
</li>
</ul>
</section>
<section id="module-configuration">
<span id="scorgls-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scorgls.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scorgls.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scorgls.cfg</span></code></div>
</div>
<p>scorgls inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scorgls [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-h">
<span id="cmdoption-scorgls-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-V">
<span id="cmdoption-scorgls-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-D">
<span id="cmdoption-scorgls-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-v">
<span id="cmdoption-scorgls-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-q">
<span id="cmdoption-scorgls-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-s">
<span id="cmdoption-scorgls-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-l">
<span id="cmdoption-scorgls-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-d">
<span id="cmdoption-scorgls-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scorgls-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-i">
<span id="cmdoption-scorgls-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scorgls-i" title="Permalink to this definition"></a></dt>
<dd><p>Name of input XML file. Read from stdin if - is given.
Deactivates reading origins from database.</p>
</dd></dl>
</section>
<section id="origins">
<h3>Origins<a class="headerlink" href="#origins" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-begin">
<span class="sig-name descname"><span class="pre">--begin</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scorgls-begin" title="Permalink to this definition"></a></dt>
<dd><p>The lower bound of the time interval. Format:
012-01-01T00:00:00.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-end">
<span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scorgls-end" title="Permalink to this definition"></a></dt>
<dd><p>The upper bound of the time interval. Format:
2012-01-01T00:00:00.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scorgls-0">
<span id="cmdoption-scorgls-delimiter"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--delimiter</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-scorgls-0" title="Permalink to this definition"></a></dt>
<dd><p>The delimiter of the resulting origin IDs.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scorgls</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#origins">Origins</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scmssort.html"
title="previous chapter">scmssort</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scquery.html"
title="next chapter">scquery</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scorgls.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,495 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scquery &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scqueryqc" href="scqueryqc.html" />
<link rel="prev" title="scorgls" href="scorgls.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">6.9.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="scqueryqc.html" title="scqueryqc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scorgls.html" title="scorgls"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scquery">
<span id="id1"></span><h1>scquery<a class="headerlink" href="#scquery" title="Permalink to this heading"></a></h1>
<p><strong>Read database objects and writes them to the command line.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>scquery</em> reads objects such as event information from a
<a class="reference internal" href="../base/concepts/database.html#concepts-database"><span class="std std-ref">SeisComP database</span></a> using custom queries. The results
are written to stdout. The module extends <a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a> and <a class="reference internal" href="scorgls.html#scorgls"><span class="std std-ref">scorgls</span></a>
which are limited to searching event and origin IDs, respectively, by time.</p>
<p>scquery takes into account and requires <a class="reference internal" href="#scquery-queries"><span class="std std-ref">query profiles</span></a>
for querying the database. The profiles are defined in</p>
<ul class="simple">
<li><p><code class="file docutils literal notranslate"><span class="pre">&#64;SYSTEMCONFIGDIR&#64;/queries.cfg</span></code> or</p></li>
<li><p><code class="file docutils literal notranslate"><span class="pre">&#64;CONFIGDIR&#64;/queries.cfg</span></code></p></li>
</ul>
<p>while parameters in the latter take priority. The are no default query profile,
hence they must be created first.</p>
</section>
<section id="module-setup">
<h2>Module Setup<a class="headerlink" href="#module-setup" title="Permalink to this heading"></a></h2>
<ol class="arabic" id="scquery-config">
<li><p>Create the query profiles in <code class="file docutils literal notranslate"><span class="pre">queries.cfg</span></code> in <code class="file docutils literal notranslate"><span class="pre">&#64;SYSTEMCONFIGDIR&#64;</span></code>
or <code class="file docutils literal notranslate"><span class="pre">&#64;CONFIGDIR&#64;</span></code>. The file contains your database queries. Examples for
MariaDB/MySQL and PostgreSQL are found in the section <a class="reference internal" href="#scquery-queries"><span class="std std-ref">Queries</span></a>.</p></li>
<li><p><strong>Optional:</strong> Add the database connection parameter to the configuration file
<code class="file docutils literal notranslate"><span class="pre">scquery.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code> in &#64;CONFIGDIR&#64; or to &#64;SYSTEMCONFIGDIR&#64;:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">database</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">mysql://sysop:sysop@localhost/seiscomp</span>
</pre></div>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>If the database connection is configured, the database option
<a class="reference internal" href="global.html#confval-database"><code class="xref std std-confval docutils literal notranslate"><span class="pre">-d</span></code></a> in the section <a class="reference internal" href="#scquery-examples"><span class="std std-ref">Examples</span></a>
can be omitted or used to override the configuration.</p>
</div>
</li>
</ol>
</section>
<section id="examples">
<span id="scquery-examples"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>Choose any query profile defined in the <a class="reference internal" href="#scquery-queries"><span class="std std-ref">queries.cfg</span></a>.
Provide the required parameters in the same order as in the database request.
The required parameters are indicated by hashes, e.g. ##latMin##.</p>
<ol class="arabic">
<li><p>List all available query profiles using the command-line option
<code class="xref std std-confval docutils literal notranslate"><span class="pre">showqueries</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>--showqueries
</pre></div>
</div>
</li>
<li><p>Profile <strong>event_filter</strong>: Fetch all event IDs and event parameters for events
with magnitude ranging from 2.5 to 5 in central Germany between 2014 and 2017:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>-d<span class="w"> </span>localhost/seiscomp<span class="w"> </span>eventFilter<span class="w"> </span><span class="m">50</span><span class="w"> </span><span class="m">52</span><span class="w"> </span><span class="m">11</span>.5<span class="w"> </span><span class="m">12</span>.5<span class="w"> </span><span class="m">2</span>.5<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2014</span>-01-01<span class="w"> </span><span class="m">2018</span>-01-01<span class="w"> </span>&gt;<span class="w"> </span>events_vogtland.txt
</pre></div>
</div>
</li>
<li><p>Profile <strong>eventByAuthor</strong>: Fetch all event IDs where the preferred origin was
provided by a specific author for events 2.5 to 5 with 6 to 20 phases in central
Germany between 2014 and 2017:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>-d<span class="w"> </span>localhost/seiscomp<span class="w"> </span>eventByAuthor<span class="w"> </span><span class="m">50</span><span class="w"> </span><span class="m">52</span><span class="w"> </span><span class="m">11</span>.5<span class="w"> </span><span class="m">12</span>.5<span class="w"> </span><span class="m">6</span><span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="m">2</span>.5<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2014</span>-01-01<span class="w"> </span><span class="m">2018</span>-01-01<span class="w"> </span>scautoloc<span class="w"> </span>&gt;<span class="w"> </span>events_vogtland.txt
</pre></div>
</div>
</li>
<li><p>Profile <strong>eventType</strong>: Fetch all event IDs and event times from events
with the given event type and within the provided time interval:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>-d<span class="w"> </span>localhost/seiscomp<span class="w"> </span>eventType<span class="w"> </span>explosion<span class="w"> </span><span class="s1">&#39;2017-11-01 00:00:00&#39;</span><span class="w"> </span><span class="s1">&#39;2018-11-01 00:00:00&#39;</span>
</pre></div>
</div>
</li>
</ol>
</section>
<section id="queries">
<span id="scquery-queries"></span><h2>Queries<a class="headerlink" href="#queries" title="Permalink to this heading"></a></h2>
<p>Example queries for <a class="reference internal" href="#scquery-mariadb"><span class="std std-ref">MariaDB/MySQL</span></a> and <a class="reference internal" href="#scquery-psql"><span class="std std-ref">PostgreSQL</span></a> are given
below.</p>
<section id="mariadb-mysql">
<span id="scquery-mariadb"></span><h3>MariaDB/MySQL<a class="headerlink" href="#mariadb-mysql" title="Permalink to this heading"></a></h3>
<p><strong>General event/origin queries</strong></p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">queries</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">eventFilter, eventUncertainty, eventByAuthor, eventWithStationCount, eventType, originByAuthor</span>
<span class="na">query.eventFilter.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Returns all events (lat, lon, mag, time) that fall into a certain region and a magnitude range&quot;</span>
<span class="na">query.eventFilter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value,Origin.longitude_value, Origin.depth_value, Magnitude.magnitude_value, Magnitude.type FROM Origin,PublicObject as POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject as PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID=Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value &gt;= ##latMin## AND Origin.latitude_value &lt;= ##latMax## AND Origin.longitude_value &gt;= ##lonMin## AND Origin.longitude_value &lt;= ##lonMax## AND Magnitude.magnitude_value &gt;= ##minMag## AND Magnitude.magnitude_value &lt;= ##maxMag## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.eventUncertainty.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Returns all events (eventsIDs, time, lat, lat error, lon, lon error, depth, depth error, magnitude, region name) in the form of an event catalog&quot;</span>
<span class="na">query.eventUncertainty</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value AS OT, ROUND(Origin.latitude_value, 3), ROUND(Origin.latitude_uncertainty, 3), ROUND(Origin.longitude_value, 3), ROUND(Origin.longitude_uncertainty, 3), ROUND(Origin.depth_value, 3), ROUND(Origin.depth_uncertainty, 3), ROUND(Magnitude.magnitude_value, 1), EventDescription.text FROM Event, PublicObject AS PEvent, EventDescription, Origin, PublicObject AS POrigin, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND Event.preferredOriginID = POrigin.publicID AND Event.preferredMagnitudeID = PMagnitude.publicID AND Event._oid = EventDescription._parent_oid AND EventDescription.type = &#39;region name&#39; AND Event.type = &#39;##type##&#39; AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.eventByAuthor.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Get events by preferred origin author etc&quot;</span>
<span class="na">query.eventByAuthor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value AS lat,Origin.longitude_value AS lon, Origin.depth_value AS dep, Magnitude.magnitude_value AS mag, Magnitude.type AS mtype, Origin.quality_usedPhaseCount AS phases, Event.type AS type, Event.typeCertainty AS certainty, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value &gt;= ##latMin## AND Origin.latitude_value &lt;= ##latMax## AND Origin.longitude_value &gt;= ##lonMin## AND Origin.longitude_value &lt;= ##lonMax## AND Origin.quality_usedPhaseCount &gt;= ##minPhases## AND Origin.quality_usedPhaseCount &lt;= ##maxPhases## AND Magnitude.magnitude_value &gt;= ##minMag## AND Magnitude.magnitude_value &lt;= ##maxMag## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39; AND Origin.creationInfo_author like &#39;##author##&#39;;&quot;</span>
<span class="na">query.eventWithStationCount.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Get events by preferred origin author etc&quot;</span>
<span class="na">query.eventWithStationCount</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value AS lat, Origin.longitude_value AS lon, Origin.depth_value AS dep, Magnitude.magnitude_value AS mag, Magnitude.type AS mtype, Origin.quality_usedStationCount AS stations, Event.type AS type, Event.typeCertainty AS certainty, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.eventType.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Returns all eventIDs FROM event WHERE the type is flagged AS &#39;event type&#39;&quot;</span>
<span class="na">query.eventType</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT pe.publicID, o.time_value AS OT FROM PublicObject pe, PublicObject po, Event e, Origin o WHERE pe._oid = e._oid AND po._oid = o._oid AND e.preferredOriginID = po.publicID AND e.type = &#39;##type##&#39; AND o.time_value &gt;= &#39;##startTime##&#39; AND o.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.originByAuthor.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Get origins by author&quot;</span>
<span class="na">query.originByAuthor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT po.publicID, o.time_value AS OT, o.creationInfo_author FROM PublicObject po JOIN Origin o ON po._oid = o._oid WHERE o.creationInfo_author like &#39;##author##&#39; AND o.time_value &gt;= &#39;##startTime##&#39; AND o.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
</pre></div>
</div>
<p><strong>More examples and statistics</strong></p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">queries</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">phaseCountPerAuthor, time, mag_time, space_time, all, space_mag_time, event, fm_space_time, picks, stationPicks, assoc_picks, pref_assoc_picks, sta_net_mag, sta_net_mag_type, delta_sta_net_mag, delta_sta_net_mag_type</span>
<span class="na">query.phaseCountPerAuthor.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Get phase count per origin author FROM event #EventID#&quot;</span>
<span class="na">query.phaseCountPerAuthor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.creationInfo_author, MAX(Origin.quality_usedPhaseCount) FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, OriginReference WHERE Origin._oid = POrigin._oid AND Event._oid = PEvent._oid AND OriginReference._parent_oid = Event._oid AND OriginReference.originID = POrigin.publicID AND PEvent.publicID = &#39;##EventID##&#39; group by Origin.creationInfo_author;&quot;</span>
<span class="na">query.time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Events in time range&quot;</span>
<span class="na">query.time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.mag_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Events in magnitude-time range&quot;</span>
<span class="na">query.mag_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Magnitude.magnitude_value &gt;= ##minMag## AND Magnitude.magnitude_value &lt;= ##maxMag## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.space_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Events in space-time range&quot;</span>
<span class="na">query.space_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value &gt;= ##latMin## AND Origin.latitude_value &lt;= ##latMax## AND Origin.longitude_value &gt;= ##lonMin## AND Origin.longitude_value &lt;= ##lonMax## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.all.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Events in space-magnitude-time-quality range by author&quot;</span>
<span class="na">query.all</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value &gt;= ##latMin## AND Origin.latitude_value &lt;= ##latMax## AND Origin.longitude_value &gt;= ##lonMin## AND Origin.longitude_value &lt;= ##lonMax## AND Origin.quality_usedPhaseCount &gt;= ##minPhases## AND Origin.quality_usedPhaseCount &lt;= ##maxPhases## AND Magnitude.magnitude_value &gt;= ##minMag## AND Magnitude.magnitude_value &lt;= ##maxMag## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39; AND Origin.creationInfo_author like &#39;##author##%&#39;;&quot;</span>
<span class="na">query.space_mag_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Events in space-magnitude-time range&quot;</span>
<span class="na">query.space_mag_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value &gt;= ##latMin## AND Origin.latitude_value &lt;= ##latMax## AND Origin.longitude_value &gt;= ##lonMin## AND Origin.longitude_value &lt;= ##lonMax## AND Magnitude.magnitude_value &gt;= ##minMag## AND Magnitude.magnitude_value &lt;= ##maxMag## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.fm_space_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Events with focal mechanisms in space-time range&quot;</span>
<span class="na">query.fm_space_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, MomentTensor.doubleCouple, MomentTensor.variance, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude, FocalMechanism, PublicObject AS PFocalMechanism, MomentTensor WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND FocalMechanism._oid = PFocalMechanism._oid AND PFocalMechanism.publicID = Event.preferredFocalMechanismID AND MomentTensor._parent_oid = FocalMechanism._oid AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value &gt;= ##latMin## AND Origin.latitude_value &lt;= ##latMax## AND Origin.longitude_value &gt;= ##lonMin## AND Origin.longitude_value &lt;= ##lonMax## AND Origin.time_value &gt;= &#39;##startTime##&#39; AND Origin.time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.event.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;List authors and number of origins for event&quot;</span>
<span class="na">query.event</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.publicID, Origin.creationInfo_author, MAX(Origin.quality_usedPhaseCount) FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, OriginReference WHERE Origin._oid = POrigin._oid AND Event._oid = PEvent._oid AND OriginReference._parent_oid = Event._oid AND OriginReference.originID = POrigin.publicID AND PEvent.publicID = &#39;##EventID##&#39; group by Origin.creationInfo_author;&quot;</span>
<span class="na">query.picks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;List number of picks per station in a certain timespan&quot;</span>
<span class="na">query.picks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT waveformID_networkCode AS Network, waveformID_stationCode AS Station, COUNT(_oid) AS Picks, MIN(time_value) AS Start, MAX(time_value) AS End FROM Pick WHERE time_value &gt;= &#39;##startTime##&#39; AND time_value &lt;= &#39;##endTime##&#39; GROUP BY waveformID_networkCode, waveformID_stationCode;&quot;</span>
<span class="na">query.stationPicks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;List the picks and phase hints per station in a certain timespan&quot;</span>
<span class="na">query.stationPicks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PPick.publicID, Pick.phaseHint_code FROM Pick, PublicObject AS PPick WHERE Pick._oid = PPick._oid AND waveformID_networkCode = &#39;##netCode##&#39; AND waveformID_stationCode = &#39;##staCode##&#39; AND time_value &gt;= &#39;##startTime##&#39; AND time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
<span class="na">query.assoc_picks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;List number of associated picks per station in a certain time span&quot;</span>
<span class="na">query.assoc_picks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT Pick.waveformID_networkCode AS Network, Pick.waveformID_stationCode AS Station, COUNT(DISTINCT(Pick._oid)) AS Picks, MIN(Pick.time_value) AS Start, MAX(Pick.time_value) AS End FROM Pick, PublicObject PPick, Arrival WHERE Pick._oid = PPick._oid AND PPick.publicID = Arrival.pickID AND Pick.time_value &gt;= &#39;##startTime##&#39; AND Pick.time_value &lt;= &#39;##endTime##&#39; GROUP BY Pick.waveformID_networkCode, Pick.waveformID_stationCode;&quot;</span>
<span class="na">query.pref_assoc_picks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;List number of associated picks of preferred origins per station for certain time span&quot;</span>
<span class="na">query.pref_assoc_picks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT Pick.waveformID_networkCode AS Network, Pick.waveformID_stationCode AS Station, COUNT(DISTINCT(Pick._oid)) AS Picks, MIN(Pick.time_value) AS Start, MAX(Pick.time_value) AS End FROM Pick, PublicObject PPick, Arrival, Origin, PublicObject POrigin, Event WHERE Event.preferredOriginID = POrigin.publicID AND Origin._oid = POrigin._oid AND Origin._oid = Arrival._parent_oid AND Pick._oid = PPick._oid AND PPick.publicID = Arrival.pickID AND Pick.time_value &gt;= &#39;##startTime##&#39; AND Pick.time_value &lt;= &#39;##endTime##&#39; GROUP BY Pick.waveformID_networkCode, Pick.waveformID_stationCode;&quot;</span>
<span class="na">query.sta_net_mag.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Compares station magnitudes of a particular station with the network magnitude in a certain time span&quot;</span>
<span class="na">query.sta_net_mag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, StationMagnitude.magnitude_value AS StaMag, Magnitude.magnitude_value AS NetMag, Magnitude.type AS NetMagType, StationMagnitude.creationInfo_creationTime AS CreationTime FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.waveformID_networkCode = &#39;##netCode##&#39; AND StationMagnitude.waveformID_stationCode = &#39;##staCode##&#39; AND StationMagnitude.creationInfo_creationTime &gt;= &#39;##startTime##&#39; AND StationMagnitude.creationInfo_creationTime &lt;= &#39;##endTime##&#39; ORDER BY StationMagnitude.creationInfo_creationTime;&quot;</span>
<span class="na">query.sta_net_mag_type.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Compares station magnitudes of a particular station with the network magnitude of specific type in a certain time span&quot;</span>
<span class="na">query.sta_net_mag_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, StationMagnitude.magnitude_value AS StaMag, Magnitude.magnitude_value AS NetMag, Magnitude.type AS NetMagType, StationMagnitude.creationInfo_creationTime AS CreationTime FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.waveformID_networkCode = &#39;##netCode##&#39; AND StationMagnitude.waveformID_stationCode = &#39;##staCode##&#39; AND StationMagnitude.creationInfo_creationTime &gt;= &#39;##startTime##&#39; AND StationMagnitude.creationInfo_creationTime &lt;= &#39;##endTime##&#39; AND Magnitude.type = &#39;##magType##&#39; ORDER BY StationMagnitude.creationInfo_creationTime;&quot;</span>
<span class="na">query.delta_sta_net_mag.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Calculates delta values of station and network magnitudes for all stations in a certain time span&quot;</span>
<span class="na">query.delta_sta_net_mag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, AVG(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaAvg, MIN(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMin, MAX(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMax, MIN(StationMagnitude.creationInfo_creationTime) AS Start, MAX(StationMagnitude.creationInfo_creationTime) AS End FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oidStationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicIDStationMagnitudeContribution._parent_oid = Magnitude._oidStationMagnitude.creationInfo_creationTime &gt;= &#39;##startTime##&#39;StationMagnitude.creationInfo_creationTime &lt;= &#39;##endTime##&#39; GROUP BY StationMagnitude.waveformID_networkCode, StationMagnitude.waveformID_stationCode;&quot;</span>
<span class="na">query.delta_sta_net_mag_type.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Calculates delta values of station and network magnitudes for all stations and all magnitude types in a certain time span&quot;</span>
<span class="na">query.delta_sta_net_mag_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, AVG(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaAvg, MIN(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMin, MAX(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMax, Magnitude.type AS NetMagType, MIN(StationMagnitude.creationInfo_creationTime) AS Start, MAX(StationMagnitude.creationInfo_creationTime) AS End FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.creationInfo_creationTime &gt;= &#39;##startTime##&#39; AND StationMagnitude.creationInfo_creationTime &lt;= &#39;##endTime##&#39; GROUP BY StationMagnitude.waveformID_networkCode, StationMagnitude.waveformID_stationCode, Magnitude.type;&quot;</span>
</pre></div>
</div>
</section>
<section id="postgresql">
<span id="scquery-psql"></span><h3>PostgreSQL<a class="headerlink" href="#postgresql" title="Permalink to this heading"></a></h3>
<p>In contrast to queries for objects in <a class="reference internal" href="#scquery-mariadb"><span class="std std-ref">MariaDB/MySQL</span></a> the
string <code class="docutils literal notranslate"><span class="pre">m_</span></code> must be added to the value and publicID database columns as shown
below for the query “eventFilter”.</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">queries</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">eventFilter</span>
<span class="na">query.eventFilter.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Returns all events (lat, lon, mag, time) that fall into a certain region and a magnitude range&quot;</span>
<span class="na">query.eventFilter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SELECT PEvent.m_publicID, Origin.m_time_value AS OT, Origin.m_latitude_value, Origin.m_longitude_value, Origin.m_depth_value, Magnitude.m_magnitude_value, Magnitude.m_type FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.m_publicID = Event.m_preferredMagnitudeID AND POrigin.m_publicID = Event.m_preferredOriginID AND Origin.m_latitude_value &gt;= ##latMin## AND Origin.m_latitude_value &lt;= ##latMax## AND Origin.m_longitude_value &gt;= ##lonMin## AND Origin.m_longitude_value &lt;= ##lonMax## AND Magnitude.m_magnitude_value &gt;= ##minMag## AND Magnitude.m_magnitude_value &lt;= ##maxMag## AND Origin.m_time_value &gt;= &#39;##startTime##&#39; AND Origin.m_time_value &lt;= &#39;##endTime##&#39;;&quot;</span>
</pre></div>
</div>
</section>
</section>
<section id="module-configuration">
<span id="scquery-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scquery.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scquery.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scquery.cfg</span></code></div>
</div>
<p>scquery inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scquery [OPTIONS] [query name] [query parameters]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-h">
<span id="cmdoption-scquery-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-V">
<span id="cmdoption-scquery-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-v">
<span id="cmdoption-scquery-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-q">
<span id="cmdoption-scquery-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-s">
<span id="cmdoption-scquery-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-l">
<span id="cmdoption-scquery-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-d">
<span id="cmdoption-scquery-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
</section>
<section id="commands">
<h3>Commands<a class="headerlink" href="#commands" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-showqueries">
<span class="sig-name descname"><span class="pre">--showqueries</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-showqueries" title="Permalink to this definition"></a></dt>
<dd><p>Show the queries defined in queries.cfg.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-delimiter">
<span class="sig-name descname"><span class="pre">--delimiter</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-delimiter" title="Permalink to this definition"></a></dt>
<dd><p>Column delimiter. If found, this character will be escaped
in output values. Default: |.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-print-column-name">
<span class="sig-name descname"><span class="pre">--print-column-name</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-print-column-name" title="Permalink to this definition"></a></dt>
<dd><p>Print the name of each output column in a header.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-print-header">
<span class="sig-name descname"><span class="pre">--print-header</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-print-header" title="Permalink to this definition"></a></dt>
<dd><p>Print the query parameters and the query filter description
as a header of the query output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-print-query-only">
<span class="sig-name descname"><span class="pre">--print-query-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-print-query-only" title="Permalink to this definition"></a></dt>
<dd><p>Only print the full query to stdout and then quit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scquery-Q">
<span id="cmdoption-scquery-query"></span><span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--query</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-Q" title="Permalink to this definition"></a></dt>
<dd><p>Execute the given query instead of applying queries
pre-defined by configuration.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scquery</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-setup">Module Setup</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#queries">Queries</a><ul>
<li><a class="reference internal" href="#mariadb-mysql">MariaDB/MySQL</a></li>
<li><a class="reference internal" href="#postgresql">PostgreSQL</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#commands">Commands</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scorgls.html"
title="previous chapter">scorgls</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scqueryqc.html"
title="next chapter">scqueryqc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scquery.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,420 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scqueryqc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scsendjournal" href="scsendjournal.html" />
<link rel="prev" title="scquery" href="scquery.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">6.9.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="scsendjournal.html" title="scsendjournal"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scquery.html" title="scquery"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scqueryqc">
<span id="id1"></span><h1>scqueryqc<a class="headerlink" href="#scqueryqc" title="Permalink to this heading"></a></h1>
<p><strong>Query waveform quality control (QC) parameters from database.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scqueryqc queries a database for waveform quality control (QC) parameters. The
QC parameters can be provided and written to the database, e.g., by <a class="reference internal" href="scqc.html#scqc"><span class="std std-ref">scqc</span></a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Writing QC parameters to the database by <a class="reference internal" href="scqc.html#scqc"><span class="std std-ref">scqc</span></a> will result in a rapidly
growing database and is therefore not recommended in permanent application without
regularly stripping these parameters from the database!</p>
</div>
<p>The database query is done for</p>
<ul>
<li><p>One or multiple streams,</p></li>
<li><p>One or multiple QC parameters. All QC parameters can be requested. Defaults
apply. For reading the defaults use</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scqueryqc<span class="w"> </span>-h
</pre></div>
</div>
</li>
<li><p>A single time window where the begin time must be provided. Current time is
considered if the end is not give.</p></li>
</ul>
<section id="workflow">
<h3>Workflow<a class="headerlink" href="#workflow" title="Permalink to this heading"></a></h3>
<p>You should minimize the impact of stored waveform QC parameters on the size of the
database.</p>
<ol class="arabic">
<li><p>Compute the QC parameters in real time using <a class="reference internal" href="scqc.html#scqc"><span class="std std-ref">scqc</span></a> and save them in the
<cite>SeisComP</cite> database. Saving the QC parameters in the database requires to
adjust the scqc module configuration parameters
<code class="xref std std-confval docutils literal notranslate"><span class="pre">plugins.$name.archive.interval</span></code> for each plugin.</p></li>
<li><p>Regularly use scqueryqc for some time span to read the QC parameters from the
database. Save them in a XML files.</p>
<p>Example for all QC parameters found for all streams in the inventory before
end time:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scqueryqc<span class="w"> </span>-d<span class="w"> </span><span class="o">[</span>host<span class="o">]</span><span class="w"> </span>-e<span class="w"> </span><span class="s1">&#39;[end time]&#39;</span><span class="w"> </span>--streams-from-inventory<span class="w"> </span>-o<span class="w"> </span><span class="o">[</span>XML<span class="w"> </span>file<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Clean the database from QC parameters.</p>
<ul>
<li><p>Either use <a class="reference internal" href="scdispatch.html#scdispatch"><span class="std std-ref">scdispatch</span></a> with the parameters saved in XML. You may need
to set the routing table for sending the QualityControl parameters to the
right message group, e.g., QC:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch<span class="w"> </span>-H<span class="w"> </span><span class="o">[</span>host<span class="o">]</span><span class="w"> </span>-O<span class="w"> </span>remove<span class="w"> </span>--routingtable<span class="w"> </span>QualityControl:QC<span class="w"> </span>-i<span class="w"> </span><span class="o">[</span>XML<span class="w"> </span>file<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Alternatively, use <a class="reference internal" href="scdbstrip.html#scdbstrip"><span class="std std-ref">scdbstrip</span></a> with the command-line option
<code class="xref std std-option docutils literal notranslate"><span class="pre">--qc-only</span></code> and remove <strong>all</strong> QC parameters in the time span. Use the same
period for which the QC parameters were retrieved:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span><span class="o">[</span>database<span class="o">]</span><span class="w"> </span>-Q<span class="w"> </span>--date-time<span class="w"> </span><span class="s1">&#39;[end time]&#39;</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Considering an end time by <code class="xref std std-option docutils literal notranslate"><span class="pre">--date-time</span></code> has the advantage that no QC
parameters are removed which were measured after scqueryqc was applied with the
same end time value.</p>
</div>
</li>
</ul>
</li>
</ol>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<ul>
<li><p>Query rms and delay values for the stream AU.AS18..SHZ,AU.AS19..SHZ before
2021-11-20 00:00:00. Write the XML to stdout</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scqueryqc<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-e<span class="w"> </span><span class="s1">&#39;2021-11-20 00:00:00&#39;</span><span class="w"> </span>-p<span class="w"> </span>rms,delay<span class="w"> </span>-i<span class="w"> </span>AU.AS18..SHZ,AU.AS19..SHZ
</pre></div>
</div>
</li>
<li><p>Query all default QC parameter values for all streams found in the inventory
from 2021-11-20 00:00:00 until current. Write the formatted XML output to
<code class="file docutils literal notranslate"><span class="pre">/tmp/query.xml</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scqueryqc<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-b<span class="w"> </span><span class="s1">&#39;2021-11-20 00:00:00&#39;</span><span class="w"> </span>--streams-from-inventory<span class="w"> </span>-f<span class="w"> </span>-o<span class="w"> </span>/tmp/query.xml
</pre></div>
</div>
</li>
</ul>
</section>
</section>
<section id="module-configuration">
<span id="scqueryqc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scqueryqc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scqueryqc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scqueryqc.cfg</span></code></div>
</div>
<p>scqueryqc inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scqueryqc [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-h">
<span id="cmdoption-scqueryqc-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-V">
<span id="cmdoption-scqueryqc-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-v">
<span id="cmdoption-scqueryqc-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-q">
<span id="cmdoption-scqueryqc-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-s">
<span id="cmdoption-scqueryqc-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-l">
<span id="cmdoption-scqueryqc-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-d">
<span id="cmdoption-scqueryqc-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scqueryqc-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-o">
<span id="cmdoption-scqueryqc-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">filename</span></span><a class="headerlink" href="#cmdoption-scqueryqc-o" title="Permalink to this definition"></a></dt>
<dd><p>Name of output XML file. Objects are sent to stderr if none
is given.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-f">
<span id="cmdoption-scqueryqc-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-f" title="Permalink to this definition"></a></dt>
<dd><p>Write formatted XML.</p>
</dd></dl>
</section>
<section id="query">
<h3>Query<a class="headerlink" href="#query" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-b">
<span id="cmdoption-scqueryqc-begin"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--begin</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scqueryqc-b" title="Permalink to this definition"></a></dt>
<dd><p>Begin time of query. Format: YYYY-MM-DD hh:mm:ss.
1900-01-01T00:00:00Z is considered if undefined.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-e">
<span id="cmdoption-scqueryqc-end"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scqueryqc-e" title="Permalink to this definition"></a></dt>
<dd><p>End time of query. Format: YYYY-MM-DD hh:mm:ss.
Current time is considered if undefined.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-i">
<span id="cmdoption-scqueryqc-stream-id"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--stream-id</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-scqueryqc-i" title="Permalink to this definition"></a></dt>
<dd><p>Waveform stream ID to search for QC parameters: net.sta.loc.cha -
[networkCode].[stationCode].[sensorLocationCode].[channelCode].
Provide a single ID or a comma-separated list. Overrides
--streams-from-inventory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-p">
<span id="cmdoption-scqueryqc-parameter"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--parameter</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-scqueryqc-p" title="Permalink to this definition"></a></dt>
<dd><p>QC parameter to output: (e.g. delay,rms,gaps count …).
Use quotes if QC parameter has more than 1 word.
Provide a single parameter or a comma-separated list.
Defaults are used if parameter is undefined.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scqueryqc-streams-from-inventory">
<span class="sig-name descname"><span class="pre">--streams-from-inventory</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scqueryqc-streams-from-inventory" title="Permalink to this definition"></a></dt>
<dd><p>Read streams from inventory. Superseded by --stream-id.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scqueryqc</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#workflow">Workflow</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
<li><a class="reference internal" href="#query">Query</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scquery.html"
title="previous chapter">scquery</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scsendjournal.html"
title="next chapter">scsendjournal</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scqueryqc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,662 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>screloc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="screpick" href="screpick.html" />
<link rel="prev" title="scqc" href="scqc.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">6.9.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="screpick.html" title="screpick"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scqc.html" title="scqc"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/processing.html" accesskey="U">Processing</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="screloc">
<span id="id1"></span><h1>screloc<a class="headerlink" href="#screloc" title="Permalink to this heading"></a></h1>
<p><strong>Automatic relocator.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>screloc is an automatic relocator that receives origins from realtime
locators such as scautoloc and relocates them with a configurable locator.
screloc can be conveniently used to test different locators and velocity models
or to relocate events with updated velocity models. Check the
<a class="reference internal" href="#screloc-example"><span class="std std-ref">Example applications</span></a> for screloc.</p>
<p>screloc processes any incoming automatic origin but does not yet listen to event
information nor does it skip origins for that a more recent one exists.</p>
<p>To run screloc along with all processing modules add it to the list of
clients in the seiscomp configuration frontend.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>screloc
seiscomp<span class="w"> </span>start<span class="w"> </span>screloc
</pre></div>
</div>
<p>Descriptions of parameters for screloc:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>screloc<span class="w"> </span>-h
</pre></div>
</div>
<p>Test the performance of screloc and learn from debug output:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>screloc<span class="w"> </span>--debug
</pre></div>
</div>
</section>
<section id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading"></a></h2>
<p>The following example configuration shows a setup of screloc for
<a class="reference internal" href="global_nonlinloc.html#global-nonlinloc"><span class="std std-ref">NonLinLoc</span></a>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>locnll
<span class="c1"># Define the locator algorithm to use</span>
reloc.locator<span class="w"> </span><span class="o">=</span><span class="w"> </span>NonLinLoc
<span class="c1"># Define a suffix appended to the publicID of the origin to be relocated</span>
<span class="c1"># to form the new publicID.</span>
<span class="c1"># This helps to identify pairs of origins before and after relocation.</span>
<span class="c1"># However, new publicIDs are unrelated to the time of creation.</span>
<span class="c1"># If not defined, a new publicID will be generated automatically.</span>
reloc.originIDSuffix<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;#relocated&quot;</span>
<span class="c1">########################################################</span>
<span class="c1">################ NonLinLoc configuration################</span>
<span class="c1">########################################################</span>
<span class="nv">NLLROOT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/nll/data
NonLinLoc.outputPath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/output/
<span class="c1"># Define the default control file if no profile specific</span>
<span class="c1"># control file is defined.</span>
NonLinLoc.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.default.conf
<span class="c1"># Set the default pick error in seconds passed to NonLinLoc</span>
<span class="c1"># if no SeisComP pick uncertainty is available.</span>
NonLinLoc.defaultPickError<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>.1
<span class="c1"># Define the available NonLinLoc location profiles. The order</span>
<span class="c1"># implicitly defines the priority for overlapping regions</span>
<span class="c1">#NonLinLoc.profiles = swiss_3d, swiss_1d, global</span>
NonLinLoc.profiles<span class="w"> </span><span class="o">=</span><span class="w"> </span>swiss_3d,<span class="w"> </span>global
<span class="c1"># The earthModelID is copied to earthModelID attribute of the</span>
<span class="c1"># resulting origin</span>
NonLinLoc.profile.swiss_1d.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;swiss regional 1D&quot;</span>
<span class="c1"># Specify the velocity model table path as used by NonLinLoc</span>
NonLinLoc.profile.swiss_1d.tablePath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/time_1d_regio/regio
<span class="c1"># Specify the region valid for this profile</span>
NonLinLoc.profile.swiss_1d.region<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">41</span>.2,<span class="w"> </span><span class="m">3</span>.8,<span class="w"> </span><span class="m">50</span>.1,<span class="w"> </span><span class="m">16</span>.8
<span class="c1"># The NonLinLoc default control file to use for this profile</span>
NonLinLoc.profile.swiss_1d.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.swiss_1d.conf
<span class="c1"># Configure the swiss_3d profile</span>
NonLinLoc.profile.swiss_3d.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;swiss regional 3D&quot;</span>
NonLinLoc.profile.swiss_3d.tablePath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/time_3d/ch
NonLinLoc.profile.swiss_3d.region<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">45</span>.15,<span class="w"> </span><span class="m">5</span>.7,<span class="w"> </span><span class="m">48</span>.3,<span class="w"> </span><span class="m">11</span>.0
NonLinLoc.profile.swiss_3d.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.swiss_3d.conf
<span class="c1"># And the global profile</span>
NonLinLoc.profile.global.earthModelID<span class="w"> </span><span class="o">=</span><span class="w"> </span>iaspei91
NonLinLoc.profile.global.tablePath<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/iasp91/iasp91
NonLinLoc.profile.global.controlFile<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">NLLROOT</span><span class="si">}</span>/NLL.global.conf
</pre></div>
</div>
</section>
<section id="examples">
<span id="screloc-example"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Run screloc to with a specific velocity model given in a profile by <a class="reference internal" href="global_nonlinloc.html#global-nonlinloc"><span class="std std-ref">NonLinLoc</span></a>.
Use a specific userID and authorID for uniquely recognizing the relocation.
Changing the priority in <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> before running the example, e.g. to
TIME_AUTOMATIC, sets the latest origin (which will be created by screloc) to preferred.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># set specific velocity profile defined for NonLinLoc</span>
<span class="nv">profile</span><span class="o">=</span>&lt;your_profile&gt;
<span class="c1"># set userID</span>
<span class="nv">userID</span><span class="o">=</span><span class="s2">&quot;&lt;your_user&gt;&quot;</span>
<span class="c1"># set authorID</span>
<span class="nv">authorID</span><span class="o">=</span><span class="s2">&quot;&lt;screloc&gt;&quot;</span>
<span class="k">for</span><span class="w"> </span>i<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="sb">`</span>scevtls<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--begin<span class="w"> </span><span class="s1">&#39;2015-01-01 00:00:00&#39;</span><span class="w"> </span>--end<span class="w"> </span><span class="s1">&#39;2015-02-01 00:00:00&#39;</span><span class="sb">`</span><span class="p">;</span><span class="w"> </span><span class="k">do</span>
<span class="w"> </span><span class="nv">orgID</span><span class="o">=</span><span class="sb">`</span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;select preferredOriginID from Event,PublicObject where Event._oid=PublicObject._oid and PublicObject.publicID=&#39;</span><span class="nv">$i</span><span class="s2">&#39;&quot;</span><span class="w"> </span><span class="p">|</span><span class="se">\</span>
<span class="w"> </span>mysql<span class="w"> </span>-u<span class="w"> </span>sysop<span class="w"> </span>-p<span class="w"> </span>sysop<span class="w"> </span>-D<span class="w"> </span>seiscomp<span class="w"> </span>-h<span class="w"> </span>localhost<span class="w"> </span>-N<span class="sb">`</span>
<span class="w"> </span>screloc<span class="w"> </span>-O<span class="w"> </span><span class="nv">$orgID</span><span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--locator<span class="w"> </span>NonLinLoc<span class="w"> </span>--profile<span class="w"> </span><span class="nv">$profile</span><span class="w"> </span>-u<span class="w"> </span><span class="nv">$userID</span><span class="w"> </span>--debug<span class="w"> </span>--author<span class="o">=</span><span class="nv">$authorID</span>
<span class="k">done</span>
</pre></div>
</div>
</li>
</ul>
</section>
<section id="module-configuration">
<span id="screloc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/screloc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/screloc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/screloc.cfg</span></code></div>
</div>
<p>screloc inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.locator">
<span class="sig-name descname"><span class="pre">reloc.locator</span></span><a class="headerlink" href="#confval-reloc.locator" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Defines the locator to be used such as NonLinLoc.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.profile">
<span class="sig-name descname"><span class="pre">reloc.profile</span></span><a class="headerlink" href="#confval-reloc.profile" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The locator profile to use.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.ignoreRejectedOrigins">
<span class="sig-name descname"><span class="pre">reloc.ignoreRejectedOrigins</span></span><a class="headerlink" href="#confval-reloc.ignoreRejectedOrigins" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Ignores origins with status REJECTED.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.allowAnyStatus">
<span class="sig-name descname"><span class="pre">reloc.allowAnyStatus</span></span><a class="headerlink" href="#confval-reloc.allowAnyStatus" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Triggers processing on origins with any evaluation status.
Overrides &quot;allowPreliminaryOrigins&quot; but not
&quot;ignoreRejectedOrigins&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.allowPreliminaryOrigins">
<span class="sig-name descname"><span class="pre">reloc.allowPreliminaryOrigins</span></span><a class="headerlink" href="#confval-reloc.allowPreliminaryOrigins" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Triggers processing also on origins with status PRELIMINARY.
Origins with any other status is ignored anyway. The parameter
is overridden by &quot;allowAnyStatus&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.allowManualOrigins">
<span class="sig-name descname"><span class="pre">reloc.allowManualOrigins</span></span><a class="headerlink" href="#confval-reloc.allowManualOrigins" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Triggers processing also on origins with evaluatuion mode
MANUAL. Otherwise only origins with mode AUTOMATIC are
considered. The triggering may be limited due to an evaluation
status, see &quot;allowPreliminaryOrigins&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.useWeight">
<span class="sig-name descname"><span class="pre">reloc.useWeight</span></span><a class="headerlink" href="#confval-reloc.useWeight" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to use the weight of the picks associated with the
input origin as defined in the input origin as input for
the locator or not. If false then all picks associated with
the input origin will be forwarded to the locator with full
weight.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.adoptFixedDepth">
<span class="sig-name descname"><span class="pre">reloc.adoptFixedDepth</span></span><a class="headerlink" href="#confval-reloc.adoptFixedDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If the input origins depth is fixed then it will be fixed
during the relocation process as well.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.storeSourceOriginID">
<span class="sig-name descname"><span class="pre">reloc.storeSourceOriginID</span></span><a class="headerlink" href="#confval-reloc.storeSourceOriginID" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to store the ID of the input origin as comment in the
relocated origin or not.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-reloc.originIDSuffix">
<span class="sig-name descname"><span class="pre">reloc.originIDSuffix</span></span><a class="headerlink" href="#confval-reloc.originIDSuffix" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Suffix appended to the publicID of the origin to be relocated
to form the new publicID. This
helps to identify pairs of origins before and after relocation.
However, new publicIDs are unrelated to the time of creation.
If not defined, a new publicID will be generated automatically.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-h">
<span id="cmdoption-screloc-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-V">
<span id="cmdoption-screloc-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-D">
<span id="cmdoption-screloc-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-v">
<span id="cmdoption-screloc-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-q">
<span id="cmdoption-screloc-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-s">
<span id="cmdoption-screloc-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-l">
<span id="cmdoption-screloc-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-u">
<span id="cmdoption-screloc-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-H">
<span id="cmdoption-screloc-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-t">
<span id="cmdoption-screloc-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-g">
<span id="cmdoption-screloc-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-S">
<span id="cmdoption-screloc-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-d">
<span id="cmdoption-screloc-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-test" title="Permalink to this definition"></a></dt>
<dd><p>Test mode, do not send any message</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-O">
<span id="cmdoption-screloc-origin-id"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--origin-id</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-O" title="Permalink to this definition"></a></dt>
<dd><p>Reprocess the origin and send a message unless test mode is activated</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-locator">
<span class="sig-name descname"><span class="pre">--locator</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-locator" title="Permalink to this definition"></a></dt>
<dd><p>The locator type to use</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-use-weight">
<span class="sig-name descname"><span class="pre">--use-weight</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-use-weight" title="Permalink to this definition"></a></dt>
<dd><p>Use current picks weight</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-evaluation-mode">
<span class="sig-name descname"><span class="pre">--evaluation-mode</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-evaluation-mode" title="Permalink to this definition"></a></dt>
<dd><p>set origin evaluation mode: &quot;AUTOMATIC&quot; or &quot;MANUAL&quot;</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-ep">
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-screloc-ep" title="Permalink to this definition"></a></dt>
<dd><p>Defines an event parameters XML file to be read and processed. This
implies offline mode and only processes all origins contained
in that file. Each relocated origin is appended to the list
of origins unless --replace is given.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-replace">
<span class="sig-name descname"><span class="pre">--replace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-replace" title="Permalink to this definition"></a></dt>
<dd><p>Used in combination with --ep. If given then each origin for
that an output has been generated is replaced by the result
of relocation. In other words: two LocSAT origins in, two
NonLinLoc origins out. All other objects are passed through.</p>
</dd></dl>
</section>
<section id="profiling">
<h3>Profiling<a class="headerlink" href="#profiling" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-measure-relocation-time">
<span class="sig-name descname"><span class="pre">--measure-relocation-time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-measure-relocation-time" title="Permalink to this definition"></a></dt>
<dd><p>Measure the time spent in a single relocation</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-repeated-relocations">
<span class="sig-name descname"><span class="pre">--repeated-relocations</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-repeated-relocations" title="Permalink to this definition"></a></dt>
<dd><p>improve measurement of relocation time by running each relocation multiple times. Specify the number of relocations, e.g. 100.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">screloc</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#profiling">Profiling</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scqc.html"
title="previous chapter">scqc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="screpick.html"
title="next chapter">screpick</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/screloc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,411 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>screpick &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scwfparam" href="scwfparam.html" />
<link rel="prev" title="screloc" href="screloc.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">6.9.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="scwfparam.html" title="scwfparam"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="screloc.html" title="screloc"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/processing.html" accesskey="U">Processing</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="screpick">
<span id="id1"></span><h1>screpick<a class="headerlink" href="#screpick" title="Permalink to this heading"></a></h1>
<p><strong>Reads an XML file of picks and repicks them using a post picker. The
picks will be modified in place and written to another XML file.</strong></p>
<section id="module-configuration">
<span id="screpick-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/screpick.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/screpick.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/screpick.cfg</span></code></div>
</div>
<p>screpick inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-picker">
<span class="sig-name descname"><span class="pre">picker</span></span><a class="headerlink" href="#confval-picker" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Picker interface to be used for repicking.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-anyPhase">
<span class="sig-name descname"><span class="pre">anyPhase</span></span><a class="headerlink" href="#confval-anyPhase" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>If enabled then all picks will be processed. Otherwise only
P phases or picks without a phase hint will be considered.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-h">
<span id="cmdoption-screpick-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-V">
<span id="cmdoption-screpick-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-D">
<span id="cmdoption-screpick-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-v">
<span id="cmdoption-screpick-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-q">
<span id="cmdoption-screpick-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-s">
<span id="cmdoption-screpick-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-l">
<span id="cmdoption-screpick-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-d">
<span id="cmdoption-screpick-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-I">
<span id="cmdoption-screpick-record-url"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screpick-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-ep">
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-screpick-ep" title="Permalink to this definition"></a></dt>
<dd><p>Name of input XML file (SCML) with all picks for offline
processing.</p>
</dd></dl>
</section>
<section id="picker">
<h3>Picker<a class="headerlink" href="#picker" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-P">
<span id="cmdoption-screpick-picker"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--picker</span></span><span class="sig-prename descclassname"> <span class="pre">interface</span></span><a class="headerlink" href="#cmdoption-screpick-P" title="Permalink to this definition"></a></dt>
<dd><p>Defines the picker interface to be used. It must be part of
the common libraries or loaded as plugin.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screpick-A">
<span id="cmdoption-screpick-any-phase"></span><span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--any-phase</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screpick-A" title="Permalink to this definition"></a></dt>
<dd><p>Accept any pick regardless of its phase hint.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">screpick</a><ul>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#picker">Picker</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="screloc.html"
title="previous chapter">screloc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scwfparam.html"
title="next chapter">scwfparam</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/screpick.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,426 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scsendjournal &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scsendorigin" href="scsendorigin.html" />
<link rel="prev" title="scqueryqc" href="scqueryqc.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">6.9.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="scsendorigin.html" title="scsendorigin"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scqueryqc.html" title="scqueryqc"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scsendjournal">
<span id="id1"></span><h1>scsendjournal<a class="headerlink" href="#scsendjournal" title="Permalink to this heading"></a></h1>
<p><strong>Send journaling information to the messaging to manipulate event parameter objects.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scsendjournal sends journals to the <cite>scname</cite> messaging system.
Currently, journals can be used to command <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.
The journals command <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> to manipulate event parameters according to
the <a class="reference internal" href="#scsendjournal-actions"><span class="std std-ref">journal actions</span></a> which must be known to
<a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.</p>
<p>The actions allow to:</p>
<ul class="simple">
<li><p>Create new events,</p></li>
<li><p>Modify event parameters,</p></li>
<li><p>Control the association of origins to events.</p></li>
</ul>
</section>
<section id="actions">
<span id="scsendjournal-actions"></span><h2>Actions<a class="headerlink" href="#actions" title="Permalink to this heading"></a></h2>
<p>There are specific journal actions for handling non-events and events. The documentation
of <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> contains a <a class="reference internal" href="scevent.html#scevent-journals"><span class="std std-ref">complete list of journals known to scevent</span></a>.
Parameters used on the command line can also be passed from file using the option
<code class="xref std std-option docutils literal notranslate"><span class="pre">-i</span></code>.</p>
<section id="none-event-specific-actions">
<h3>None-event specific actions<a class="headerlink" href="#none-event-specific-actions" title="Permalink to this heading"></a></h3>
<ul>
<li><p><strong>EvNewEvent</strong>: Create a new event from origin with the provided origin ID.
The origin must be known to <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.</p>
<p>Example: Create a new event from the
origin with given originID. Apply the action in the message system on <em>localhost</em>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost Origin#20170505130954.736019.318 EvNewEvent
</pre></div>
</div>
</li>
</ul>
</section>
<section id="origin-association">
<h3>Origin association<a class="headerlink" href="#origin-association" title="Permalink to this heading"></a></h3>
<ul>
<li><p><strong>EvGrabOrg</strong>: Grab origin and move the origin to the event with the given eventID.
If the origins is already associated to another event, remove this reference
in the other event.</p></li>
<li><p><strong>EvMerge</strong>: Merge events into one event.</p>
<p>Example: Merge all origins from the source event with eventID <em>eventS</em> into the
target event with eventID <em>eventT</em>. Remove event <em>eventS</em>. Apply the action in
the message system on <em>host</em>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H {host} {eventT} EvMerge {eventS}
</pre></div>
</div>
</li>
<li><p><strong>EvSplitOrg</strong>: Split origins to 2 events.</p></li>
</ul>
</section>
<section id="event-parameters">
<h3>Event parameters<a class="headerlink" href="#event-parameters" title="Permalink to this heading"></a></h3>
<ul>
<li><p><strong>EvName</strong>: Set <em>EventDescription</em> of type <em>earthquake name</em>.</p>
<p>Example, setting the name of the event with
eventID <em>gempa2021abcd</em> to <em>Petrinja</em></p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost gempa2020abcd EvName &quot;Petrinja&quot;
</pre></div>
</div>
</li>
<li><p><strong>EvOpComment</strong>: Set event operators comment.</p></li>
<li><p><strong>EvPrefFocMecID</strong>: Set event preferred focal mechanism.</p></li>
<li><p><strong>EvPrefMagTypev:</strong> Set preferred magnitude type.</p></li>
<li><p><strong>EvPrefMw</strong>: Set Mw from focal mechanism as preferred magnitude.</p></li>
<li><p><strong>EvPrefOrgAutomatic</strong>: Set the preferred mode to <em>automatic</em> corresponding to <em>unfix</em> in scolv.</p></li>
<li><p><strong>EvPrefOrgEvalMode</strong>: Set preferred origin by evaluation mode.</p></li>
<li><p><strong>EvPrefOrgID</strong>: Set preferred origin by ID.</p></li>
<li><p><strong>EvRefresh</strong>: Select the preferred origin, the preferred magnitude, update
the region. Call processors loaded with plugins, e.g. the
<a class="reference internal" href="scevent_regioncheck.html#scevent-regioncheck"><span class="std std-ref">evrc</span></a> plugin for scevent.</p>
<p>Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost gempa2021abcd EvRefresh
</pre></div>
</div>
</li>
<li><p><strong>EvType</strong>: Set event type.</p>
<p>Example: Set the type of the event with eventID <em>gempa2021abcd</em> to <em>nuclear explosion</em>.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost gempa2021abcd EvType &quot;nuclear explosion&quot;
</pre></div>
</div>
</li>
<li><p><strong>EvTypeCertainty</strong>: set event type certainty.</p></li>
</ul>
</section>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scsendjournal [opts] {objectID} {action} [parameters]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-h">
<span id="cmdoption-scsendjournal-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-V">
<span id="cmdoption-scsendjournal-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-D">
<span id="cmdoption-scsendjournal-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-v">
<span id="cmdoption-scsendjournal-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-q">
<span id="cmdoption-scsendjournal-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-s">
<span id="cmdoption-scsendjournal-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-l">
<span id="cmdoption-scsendjournal-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendjournal-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-u">
<span id="cmdoption-scsendjournal-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-H">
<span id="cmdoption-scsendjournal-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-t">
<span id="cmdoption-scsendjournal-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-g">
<span id="cmdoption-scsendjournal-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-S">
<span id="cmdoption-scsendjournal-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendjournal-i">
<span id="cmdoption-scsendjournal-input"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendjournal-i" title="Permalink to this definition"></a></dt>
<dd><p>Read parameters from given file instead from command line.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scsendjournal</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#actions">Actions</a><ul>
<li><a class="reference internal" href="#none-event-specific-actions">None-event specific actions</a></li>
<li><a class="reference internal" href="#origin-association">Origin association</a></li>
<li><a class="reference internal" href="#event-parameters">Event parameters</a></li>
</ul>
</li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scqueryqc.html"
title="previous chapter">scqueryqc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scsendorigin.html"
title="next chapter">scsendorigin</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scsendjournal.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,340 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scsendorigin &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scsohlog" href="scsohlog.html" />
<link rel="prev" title="scsendjournal" href="scsendjournal.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">6.9.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="scsohlog.html" title="scsohlog"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scsendjournal.html" title="scsendjournal"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scsendorigin">
<span id="id1"></span><h1>scsendorigin<a class="headerlink" href="#scsendorigin" title="Permalink to this heading"></a></h1>
<p><strong>Create an artificial origin and send to the messaging.</strong></p>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scsendorigin [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-h">
<span id="cmdoption-scsendorigin-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-V">
<span id="cmdoption-scsendorigin-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-D">
<span id="cmdoption-scsendorigin-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-v">
<span id="cmdoption-scsendorigin-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-q">
<span id="cmdoption-scsendorigin-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-s">
<span id="cmdoption-scsendorigin-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-l">
<span id="cmdoption-scsendorigin-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-u">
<span id="cmdoption-scsendorigin-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-H">
<span id="cmdoption-scsendorigin-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-t">
<span id="cmdoption-scsendorigin-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-g">
<span id="cmdoption-scsendorigin-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-S">
<span id="cmdoption-scsendorigin-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsendorigin-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="parameters">
<h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-time">
<span class="sig-name descname"><span class="pre">--time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-time" title="Permalink to this definition"></a></dt>
<dd><p>Time of origin. Use quotes to encapsulate date and time.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsendorigin-coord">
<span class="sig-name descname"><span class="pre">--coord</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsendorigin-coord" title="Permalink to this definition"></a></dt>
<dd><p>Latitude,longitude,depth of origin.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scsendorigin</a><ul>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#parameters">Parameters</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scsendjournal.html"
title="previous chapter">scsendjournal</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scsohlog.html"
title="next chapter">scsohlog</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scsendorigin.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,414 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scsohlog &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scvoice" href="scvoice.html" />
<link rel="prev" title="scsendorigin" href="scsendorigin.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">6.9.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="scvoice.html" title="scvoice"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scsendorigin.html" title="scsendorigin"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scsohlog">
<span id="id1"></span><h1>scsohlog<a class="headerlink" href="#scsohlog" title="Permalink to this heading"></a></h1>
<p><strong>Connect to the messaging and collect all information sent from connected
clients.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scsohlog connects to the messaging and collects all information sent from connected
clients. It creates an XML file and writes that to disc at a configurable interval.
That output can be read by any consumer and converted to the desired output.</p>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this heading"></a></h2>
<p>Create an output XML file every 60 seconds and execute a custom script to process
that XML file.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
scsohlog<span class="w"> </span>-o<span class="w"> </span>stat.xml<span class="w"> </span>-i<span class="w"> </span><span class="m">60</span><span class="w"> </span>--script<span class="w"> </span>process-stat.sh
</pre></div>
</div>
<p>You can also preconfigure these values:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>monitor.output.file<span class="w"> </span><span class="o">=</span><span class="w"> </span>/path/to/stat.xml
monitor.output.interval<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">60</span>
monitor.output.script<span class="w"> </span><span class="o">=</span><span class="w"> </span>/path/to/script.sh
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="scsohlog-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scsohlog.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scsohlog.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scsohlog.cfg</span></code></div>
</div>
<p>scsohlog inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-monitor.output.interval">
<span class="sig-name descname"><span class="pre">monitor.output.interval</span></span><a class="headerlink" href="#confval-monitor.output.interval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">60</span></code></p>
<p>Type: <em>uint</em></p>
<p>Unit: <em>s</em></p>
<p>The output interval in seconds.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-monitor.output.file">
<span class="sig-name descname"><span class="pre">monitor.output.file</span></span><a class="headerlink" href="#confval-monitor.output.file" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;/server.xml</span></code></p>
<p>Type: <em>string</em></p>
<p>The output XML file.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-monitor.output.script">
<span class="sig-name descname"><span class="pre">monitor.output.script</span></span><a class="headerlink" href="#confval-monitor.output.script" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The script to execute.
Example: &#64;CONFIGDIR&#64;/scripts/scsohlog_script.sh.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scsohlog [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-h">
<span id="cmdoption-scsohlog-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-V">
<span id="cmdoption-scsohlog-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-D">
<span id="cmdoption-scsohlog-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-v">
<span id="cmdoption-scsohlog-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-q">
<span id="cmdoption-scsohlog-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-s">
<span id="cmdoption-scsohlog-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-l">
<span id="cmdoption-scsohlog-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scsohlog-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-u">
<span id="cmdoption-scsohlog-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-H">
<span id="cmdoption-scsohlog-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-t">
<span id="cmdoption-scsohlog-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-g">
<span id="cmdoption-scsohlog-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-S">
<span id="cmdoption-scsohlog-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-o">
<span id="cmdoption-scsohlog-file"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--file</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-scsohlog-o" title="Permalink to this definition"></a></dt>
<dd><p>The output XML file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-i">
<span id="cmdoption-scsohlog-interval"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-i" title="Permalink to this definition"></a></dt>
<dd><p>The output interval in seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scsohlog-script">
<span class="sig-name descname"><span class="pre">--script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scsohlog-script" title="Permalink to this definition"></a></dt>
<dd><p>The script to execute. Example: path/scsohlog_script.sh.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scsohlog</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scsendorigin.html"
title="previous chapter">scsendorigin</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scvoice.html"
title="next chapter">scvoice</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scsohlog.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,618 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scvoice &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scxmldump" href="scxmldump.html" />
<link rel="prev" title="scsohlog" href="scsohlog.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">6.9.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="scxmldump.html" title="scxmldump"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scsohlog.html" title="scsohlog"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scvoice">
<span id="id1"></span><h1>scvoice<a class="headerlink" href="#scvoice" title="Permalink to this heading"></a></h1>
<p><strong>Real time voice alert.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>This tool runs an external script whenever an event has been created or updated.
It can also run a script in case an amplitude of a particular type or a
preliminary origin (heads-up message) has been sent. The common purpose for
this tool is to play a sound or to convert a message to speech using external
tools like festival or espeak.
There are three possible trigger mechanisms for calling scripts:</p>
<ul class="simple">
<li><p>Event creation/update</p></li>
<li><p>Amplitude creation</p></li>
<li><p>Origin creation (with status = preliminary)</p></li>
</ul>
<p>Although this tool was designed to alert the user acoustically it can also be
used to send e-mails, sms or to do any other kind of alert. scvoice can only
run one script per call type at a time! A template (<a class="reference internal" href="scalert.html#scalert"><span class="std std-ref">scalert</span></a>) Python script with
more options has been added to <cite>SeisComP</cite> to be used as source for custom notifications.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<section id="event-script">
<h3>Event script<a class="headerlink" href="#event-script" title="Permalink to this heading"></a></h3>
<p>The following script is used as event script. It requires
<a class="reference external" href="http://www.cstr.ed.ac.uk/projects/festival/">festival</a> which should be
available in almost any Linux distribution.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>When saving the scripts given below do not forget to set the executable
bit otherwise scvoice cannot call the scripts. In Linux just run:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>chmod<span class="w"> </span>+x<span class="w"> </span>/path/to/file
</pre></div>
</div>
</div>
<ol class="arabic">
<li><p>Save an executable script file, e.g., under, e.g. <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/event.sh</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="k">if</span><span class="w"> </span><span class="o">[</span><span class="w"> </span><span class="s2">&quot;</span><span class="nv">$2</span><span class="s2">&quot;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;1&quot;</span><span class="w"> </span><span class="o">]</span><span class="p">;</span><span class="w"> </span><span class="k">then</span>
<span class="nb">echo</span><span class="w"> </span><span class="s2">&quot; </span><span class="nv">$1</span><span class="s2">&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sed<span class="w"> </span><span class="s1">&#39;s/,/, ,/g&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>festival<span class="w"> </span>--tts<span class="p">;</span>
<span class="k">else</span>
<span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;Event updated, </span><span class="nv">$1</span><span class="s2">&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sed<span class="w"> </span><span class="s1">&#39;s/,/, ,/g&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>festival<span class="w"> </span>--tts<span class="p">;</span>
<span class="k">fi</span>
</pre></div>
</div>
</li>
<li><p>Add the file to the configuration of <a class="reference internal" href="#confval-scripts.event"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.event</span></code></a> in the file
<code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/scvoice.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts.event<span class="w"> </span><span class="o">=</span><span class="w"> </span>/home/sysop/.seiscomp/event.sh
</pre></div>
</div>
</li>
</ol>
</section>
<section id="amplitude-script">
<h3>Amplitude script<a class="headerlink" href="#amplitude-script" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Save an executable script file, e.g., under <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/amplitude.sh</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="c1"># Play a wav file with a particular volume</span>
<span class="c1"># derived from the amplitude itself.</span>
playwave<span class="w"> </span>~/.seiscomp/beep.wav<span class="w"> </span>-v<span class="w"> </span><span class="nv">$3</span>
</pre></div>
</div>
</li>
<li><p>Add the file to the configuration of <a class="reference internal" href="#confval-scripts.amplitude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.amplitude</span></code></a> in the
file <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/scvoice.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts.amplitude<span class="w"> </span><span class="o">=</span><span class="w"> </span>/home/sysop/.seiscomp/amplitude.sh
</pre></div>
</div>
</li>
</ol>
</section>
<section id="alert-script">
<h3>Alert script<a class="headerlink" href="#alert-script" title="Permalink to this heading"></a></h3>
<ol class="arabic">
<li><p>Create a sound file <code class="file docutils literal notranslate"><span class="pre">siren.wav</span></code> for accoustic alerts.</p></li>
<li><p>Save an executable script file under, e.g., <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/alert.sh</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
playwave<span class="w"> </span>/home/sysop/.seiscomp/siren.wav
</pre></div>
</div>
</li>
<li><p>Add the script filename to the configuration of <a class="reference internal" href="#confval-scripts.alert"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.alert</span></code></a> in
the file <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/scvoice.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts.alert<span class="w"> </span><span class="o">=</span><span class="w"> </span>/home/sysop/.seiscomp/alert.sh
</pre></div>
</div>
</li>
</ol>
</section>
</section>
<section id="module-configuration">
<span id="scvoice-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scvoice.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scvoice.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code></div>
</div>
<p>scvoice inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-firstNew">
<span class="sig-name descname"><span class="pre">firstNew</span></span><a class="headerlink" href="#confval-firstNew" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Treat an event as new event when it is seen the first time.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-agencyIDs">
<span class="sig-name descname"><span class="pre">agencyIDs</span></span><a class="headerlink" href="#confval-agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define a white list of agencyIDs to alert an event. The
agencyID is extracted from the preferred origin of the event.
If this list is empty, all agencies are allowed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.message">
<span class="sig-name descname"><span class="pre">poi.message</span></span><a class="headerlink" href="#confval-poi.message" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The default message string for the event-script is
&quot;earthquake, [HOURS] hours [MINS] minutes ago, [DESC],
magnitude [MAG], depth [DEP] kilometers&quot; whereas [DESC]
is the string given in the event.description attribute.
This string can be overwritten using one of the following
options. There are three placeholders that can be used:
&#64;region&#64;, &#64;dist&#64; and &#64;poi&#64;.
Example: &quot;&#64;region&#64;, &#64;dist&#64; kilometers from &#64;poi&#64; away&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.maxDist">
<span class="sig-name descname"><span class="pre">poi.maxDist</span></span><a class="headerlink" href="#confval-poi.maxDist" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>When using the nearest point of interest (city) as part of the
message string, specify the maximum distance in degrees from the
event. Any point of interest farther away will be ignored.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-poi.minPopulation">
<span class="sig-name descname"><span class="pre">poi.minPopulation</span></span><a class="headerlink" href="#confval-poi.minPopulation" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">50000</span></code></p>
<p>Type: <em>double</em></p>
<p>Minimum population for a city to become a point of interest.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.amplitude">
<span class="sig-name descname"><span class="pre">scripts.amplitude</span></span><a class="headerlink" href="#confval-scripts.amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Specify the script to be called if an amplitude
arrives, network-, stationcode and amplitude are passed
as parameters $1, $2 and $3.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.alert">
<span class="sig-name descname"><span class="pre">scripts.alert</span></span><a class="headerlink" href="#confval-scripts.alert" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Specify the script to be called if a preliminary
origin arrives, latitude and longitude are passed as
parameters $1 and $2.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-scripts.event">
<span class="sig-name descname"><span class="pre">scripts.event</span></span><a class="headerlink" href="#confval-scripts.event" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Specify the script to be called when an event has been
declared; the message string, a flag (1=new event,
0=update event), the EventID, the arrival count and the
magnitude (optional when set) are passed as parameter
$1, $2, $3, $4 and $5.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scvoice [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-h">
<span id="cmdoption-scvoice-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-V">
<span id="cmdoption-scvoice-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-D">
<span id="cmdoption-scvoice-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-first-new">
<span class="sig-name descname"><span class="pre">--first-new</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-first-new" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-firstNew"><code class="xref std std-confval docutils literal notranslate"><span class="pre">firstNew</span></code></a>.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-v">
<span id="cmdoption-scvoice-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-q">
<span id="cmdoption-scvoice-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-s">
<span id="cmdoption-scvoice-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-l">
<span id="cmdoption-scvoice-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-u">
<span id="cmdoption-scvoice-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-H">
<span id="cmdoption-scvoice-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-t">
<span id="cmdoption-scvoice-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-g">
<span id="cmdoption-scvoice-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-S">
<span id="cmdoption-scvoice-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-d">
<span id="cmdoption-scvoice-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scvoice-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="alert">
<h3>Alert<a class="headerlink" href="#alert" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-amp-type">
<span class="sig-name descname"><span class="pre">--amp-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-amp-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify the amplitude type to listen to.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-amp-script">
<span class="sig-name descname"><span class="pre">--amp-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-amp-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-scripts.amplitude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.amplitude</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-alert-script">
<span class="sig-name descname"><span class="pre">--alert-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-alert-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-scripts.alert"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.alert</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-event-script">
<span class="sig-name descname"><span class="pre">--event-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-event-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-scripts.event"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.event</span></code></a>.</p>
</dd></dl>
</section>
<section id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-max-dist">
<span class="sig-name descname"><span class="pre">--max-dist</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-max-dist" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-poi.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">poi.maxDist</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-min-population">
<span class="sig-name descname"><span class="pre">--min-population</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-min-population" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-poi.minPopulation"><code class="xref std std-confval docutils literal notranslate"><span class="pre">poi.minPopulation</span></code></a>.</p>
</dd></dl>
</section>
<section id="debug">
<h3>Debug<a class="headerlink" href="#debug" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scvoice-E">
<span id="cmdoption-scvoice-eventid"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--eventid</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scvoice-E" title="Permalink to this definition"></a></dt>
<dd><p>Specify event ID that is used for testing.
After running the alert scripts scvoice will exit.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scvoice</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#event-script">Event script</a></li>
<li><a class="reference internal" href="#amplitude-script">Amplitude script</a></li>
<li><a class="reference internal" href="#alert-script">Alert script</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#alert">Alert</a></li>
<li><a class="reference internal" href="#cities">Cities</a></li>
<li><a class="reference internal" href="#debug">Debug</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scsohlog.html"
title="previous chapter">scsohlog</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scxmldump.html"
title="next chapter">scxmldump</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scvoice.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,387 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scwfas &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="seedlink" href="seedlink.html" />
<link rel="prev" title="scardac" href="scardac.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">6.9.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="seedlink.html" title="seedlink"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scardac.html" title="scardac"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scwfas">
<span id="id1"></span><h1>scwfas<a class="headerlink" href="#scwfas" title="Permalink to this heading"></a></h1>
<p><strong>Waveform archive server</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The waveform archive server is a small application that serves a local
SDS archive via different protocols. Currently there are two implementations:</p>
<ul class="simple">
<li><p><a class="reference internal" href="fdsnws.html#sec-dataselect"><span class="std std-ref">fdsnws dataselect</span></a></p>
<ul>
<li><p>dataselect/1/query</p></li>
<li><p>dataselect/1/version</p></li>
<li><p>dataselect/1/application.wadl</p></li>
</ul>
</li>
<li><p>Arclink (deprecated)</p></li>
</ul>
<p>This application is meant to share data with trusted computers in a fast and
efficient way. It does not require inventory information and supports wildcards
on each level.</p>
<p>All data are forwarded unrestricted. There are no options to add restriction
checks or user authentication.</p>
</section>
<section id="module-configuration">
<span id="scwfas-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scwfas.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scwfas.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scwfas.cfg</span></code></div>
</div>
<p>scwfas inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-handlerSDS">
<span class="sig-name descname"><span class="pre">handlerSDS</span></span><a class="headerlink" href="#confval-handlerSDS" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Defines an alternative SDS archive handler. This is the name
of an RecordStream interface that can be loaded via a plugin.
If not given, an internal implementation will be used.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-filebase">
<span class="sig-name descname"><span class="pre">filebase</span></span><a class="headerlink" href="#confval-filebase" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/lib/archive</span></code></p>
<p>Type: <em>string</em></p>
<p>The filebase of the SDS archive. If an alternative archive
handler is defined by &quot;handlerSDS&quot;, this value serves
as input to setSource().</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-arclink.port">
<span class="sig-name descname"><span class="pre">arclink.port</span></span><a class="headerlink" href="#confval-arclink.port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
<p>Type: <em>int</em></p>
<p>The server port for Arclink connections. -1
deactivates the Arclink server. The standard Arclink port is
18001.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-fdsnws.port">
<span class="sig-name descname"><span class="pre">fdsnws.port</span></span><a class="headerlink" href="#confval-fdsnws.port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">8080</span></code></p>
<p>Type: <em>int</em></p>
<p>The server port for FDSNWS connections. -1
deactivates the FDSN Web server.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-fdsnws.baseURL">
<span class="sig-name descname"><span class="pre">fdsnws.baseURL</span></span><a class="headerlink" href="#confval-fdsnws.baseURL" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://localhost:8080/fdsnws</span></code></p>
<p>Type: <em>string</em></p>
<p>The base URL of the FDSN Web service that is
given in the WADL document.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-fdsnws.maxTimeWindow">
<span class="sig-name descname"><span class="pre">fdsnws.maxTimeWindow</span></span><a class="headerlink" href="#confval-fdsnws.maxTimeWindow" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>The aggregated maximum time window (seconds)
for all requested streams. A value of 0 will deactive
any restriction.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scwfas [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-h">
<span id="cmdoption-scwfas-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-V">
<span id="cmdoption-scwfas-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-D">
<span id="cmdoption-scwfas-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-v">
<span id="cmdoption-scwfas-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-q">
<span id="cmdoption-scwfas-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-s">
<span id="cmdoption-scwfas-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-l">
<span id="cmdoption-scwfas-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scwfas-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scwfas-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="server">
<h3>Server<a class="headerlink" href="#server" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-arclink-port">
<span class="sig-name descname"><span class="pre">--arclink-port</span></span><span class="sig-prename descclassname"> <span class="pre">int</span></span><a class="headerlink" href="#cmdoption-scwfas-arclink-port" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-arclink.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">arclink.port</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-fdsnws-port">
<span class="sig-name descname"><span class="pre">--fdsnws-port</span></span><span class="sig-prename descclassname"> <span class="pre">int</span></span><a class="headerlink" href="#cmdoption-scwfas-fdsnws-port" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-fdsnws.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">fdsnws.port</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scwfas-fdsnws-baseurl">
<span class="sig-name descname"><span class="pre">--fdsnws-baseurl</span></span><span class="sig-prename descclassname"> <span class="pre">string</span></span><a class="headerlink" href="#cmdoption-scwfas-fdsnws-baseurl" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-fdsnws.baseURL"><code class="xref std std-confval docutils literal notranslate"><span class="pre">fdsnws.baseURL</span></code></a>.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scwfas</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#server">Server</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scardac.html"
title="previous chapter">scardac</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="seedlink.html"
title="next chapter">seedlink</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scwfas.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,627 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scxmldump &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scxmlmerge" href="scxmlmerge.html" />
<link rel="prev" title="scvoice" href="scvoice.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">6.9.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="scxmlmerge.html" title="scxmlmerge"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scvoice.html" title="scvoice"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scxmldump">
<span id="id1"></span><h1>scxmldump<a class="headerlink" href="#scxmldump" title="Permalink to this heading"></a></h1>
<p><strong>Dump database objects to XML files.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scxmldump reads various parameters from a SeisComP database:</p>
<ul class="simple">
<li><p>Availability,</p></li>
<li><p>Config (bindings parameters),</p></li>
<li><p>Event parameters,</p></li>
<li><p>Inventory,</p></li>
<li><p>Journal,</p></li>
<li><p>Routing.</p></li>
</ul>
<p>The parameters are sent to stdout or written into an XML (<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>) file.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Waveform quality control (QC) parameters can be read from databases using
<span class="xref std std-ref">scqcquery</span>.</p>
</div>
<section id="event-parameters">
<h3>Event parameters<a class="headerlink" href="#event-parameters" title="Permalink to this heading"></a></h3>
<p>To get event, origin or pick information from the database without using SQL
commands is an important task for the user. <a class="reference internal" href="#scxmldump"><span class="std std-ref">scxmldump</span></a> queries the
database and transforms that information into XML. Events and origins can be
treated further by <a class="reference internal" href="scbulletin.html#scbulletin"><span class="std std-ref">scbulletin</span></a> for generating bulletins or conversion
into KML.</p>
<p>Many processing modules, e.g., <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> support the on-demand processing
of dumped event parameters by the command-line option <code class="xref std std-option docutils literal notranslate"><span class="pre">--ep</span></code>.
Importing event parameters into another database is possible with <a class="reference internal" href="scdb.html#scdb"><span class="std std-ref">scdb</span></a>
and sending to a SeisComP messaging is provided by <a class="reference internal" href="scdispatch.html#scdispatch"><span class="std std-ref">scdispatch</span></a>.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Events, origins and picks are referred to by their public IDs. IDs of events
and origins can be provided by <a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a> and <a class="reference internal" href="scorgls.html#scorgls"><span class="std std-ref">scorgls</span></a>,
respectively. Event, origin and pick IDs can also be read from graphical
tools like <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or used database queries assisted by <a class="reference internal" href="scquery.html#scquery"><span class="std std-ref">scquery</span></a>.</p>
</div>
</section>
<section id="format-conversion">
<h3>Format conversion<a class="headerlink" href="#format-conversion" title="Permalink to this heading"></a></h3>
<p>Conversion of <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> into other formats is supported by <a class="reference internal" href="sccnv.html#sccnv"><span class="std std-ref">sccnv</span></a>.
An XSD schema of the XML output can be found under
<code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/share/xml/</span></code>.</p>
</section>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h3>
<p>Dump inventory</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fI<span class="w"> </span>-o<span class="w"> </span>inventory.xml<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
<p>Dump config (bindings parameters)</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fC<span class="w"> </span>-o<span class="w"> </span>config.xml<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
<p>Dump full event data incl. the relevant journal entries</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fPAMFJ<span class="w"> </span>-E<span class="w"> </span>test2012abcd<span class="w"> </span>-o<span class="w"> </span>test2012abcd.xml<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
<p>Dump summary event data</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fap<span class="w"> </span>-E<span class="w"> </span>test2012abcd<span class="w"> </span>-o<span class="w"> </span>test2012abcd.xml<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
<p>Create bulletin from an event</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fPAMF<span class="w"> </span>-E<span class="w"> </span>test2012abcd
<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="se">\</span>
scbulletin
</pre></div>
</div>
<p>Copy event parameters to another database</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fPAMF<span class="w"> </span>-E<span class="w"> </span>test2012abcd<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="se">\</span>
scdb<span class="w"> </span>-i<span class="w"> </span>-<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@archive-db/seiscomp
</pre></div>
</div>
<p>Export the entire journal:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmldump<span class="w"> </span>-fJ<span class="w"> </span>-o<span class="w"> </span>journal.xml<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp
</pre></div>
</div>
</section>
</section>
<section id="module-configuration">
<span id="scxmldump-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scxmldump.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scxmldump.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scxmldump.cfg</span></code></div>
</div>
<p>scxmldump inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scxmldump [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-h">
<span id="cmdoption-scxmldump-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-V">
<span id="cmdoption-scxmldump-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-D">
<span id="cmdoption-scxmldump-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-v">
<span id="cmdoption-scxmldump-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-q">
<span id="cmdoption-scxmldump-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-s">
<span id="cmdoption-scxmldump-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-l">
<span id="cmdoption-scxmldump-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-u">
<span id="cmdoption-scxmldump-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-H">
<span id="cmdoption-scxmldump-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-t">
<span id="cmdoption-scxmldump-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-g">
<span id="cmdoption-scxmldump-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-S">
<span id="cmdoption-scxmldump-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-d">
<span id="cmdoption-scxmldump-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-config-db">
<span class="sig-name descname"><span class="pre">--config-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmldump-config-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the configuration from the given database or file,
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
</section>
<section id="dump">
<h3>Dump<a class="headerlink" href="#dump" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-listen">
<span class="sig-name descname"><span class="pre">--listen</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-listen" title="Permalink to this definition"></a></dt>
<dd><p>Enable server mode which listens to the message server for
incoming events and dumps each received add/update.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-I">
<span id="cmdoption-scxmldump-inventory"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--inventory</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-I" title="Permalink to this definition"></a></dt>
<dd><p>Dump the inventory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-without-station-groups">
<span class="sig-name descname"><span class="pre">--without-station-groups</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-without-station-groups" title="Permalink to this definition"></a></dt>
<dd><p>Remove all station groups from inventory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-stations">
<span class="sig-name descname"><span class="pre">--stations</span></span><span class="sig-prename descclassname"> <span class="pre">sta-list</span></span><a class="headerlink" href="#cmdoption-scxmldump-stations" title="Permalink to this definition"></a></dt>
<dd><p>If inventory is exported, filter the stations to export.
Wildcards are supported. Format of each item: net[.{sta|*}].</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-C">
<span id="cmdoption-scxmldump-config"></span><span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-C" title="Permalink to this definition"></a></dt>
<dd><p>Dump the configuration (bindings).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-J">
<span id="cmdoption-scxmldump-journal"></span><span class="sig-name descname"><span class="pre">-J</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--journal</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-J" title="Permalink to this definition"></a></dt>
<dd><p>Dump the journal. In combination with -E only corresponding
journal entries are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-R">
<span id="cmdoption-scxmldump-routing"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--routing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-R" title="Permalink to this definition"></a></dt>
<dd><p>Dump the routing.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-Y">
<span id="cmdoption-scxmldump-availability"></span><span class="sig-name descname"><span class="pre">-Y</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--availability</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-Y" title="Permalink to this definition"></a></dt>
<dd><p>Dump data availability information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-with-segments">
<span class="sig-name descname"><span class="pre">--with-segments</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-with-segments" title="Permalink to this definition"></a></dt>
<dd><p>Dump individual data segments.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-pick">
<span class="sig-name descname"><span class="pre">--pick</span></span><span class="sig-prename descclassname"> <span class="pre">ID</span></span><a class="headerlink" href="#cmdoption-scxmldump-pick" title="Permalink to this definition"></a></dt>
<dd><p>Pick public ID(s) to dump. Multiple IDs may be specified
as a comma-separated list.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-O">
<span id="cmdoption-scxmldump-origin"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--origin</span></span><span class="sig-prename descclassname"> <span class="pre">ID</span></span><a class="headerlink" href="#cmdoption-scxmldump-O" title="Permalink to this definition"></a></dt>
<dd><p>Origin public ID(s) to dump. Multiple origins may be specified
as a comma-separated list.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-E">
<span id="cmdoption-scxmldump-event"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--event</span></span><span class="sig-prename descclassname"> <span class="pre">ID</span></span><a class="headerlink" href="#cmdoption-scxmldump-E" title="Permalink to this definition"></a></dt>
<dd><p>Event public ID(s) to dump. Multiple events may be specified
as a comma-separated list.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-P">
<span id="cmdoption-scxmldump-with-picks"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--with-picks</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-P" title="Permalink to this definition"></a></dt>
<dd><p>Add picks associated to origins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-A">
<span id="cmdoption-scxmldump-with-amplitudes"></span><span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--with-amplitudes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-A" title="Permalink to this definition"></a></dt>
<dd><p>Add amplitudes associated to magnitudes.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-M">
<span id="cmdoption-scxmldump-with-magnitudes"></span><span class="sig-name descname"><span class="pre">-M</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--with-magnitudes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-M" title="Permalink to this definition"></a></dt>
<dd><p>Add station magnitudes associated to origins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-F">
<span id="cmdoption-scxmldump-with-focal-mechanism"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--with-focal-mechanism</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-F" title="Permalink to this definition"></a></dt>
<dd><p>Add focal mechanisms associated to events.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-a">
<span id="cmdoption-scxmldump-ignore-arrivals"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-arrivals</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-a" title="Permalink to this definition"></a></dt>
<dd><p>Do not dump arrivals part of origins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-ignore-magnitudes">
<span class="sig-name descname"><span class="pre">--ignore-magnitudes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-ignore-magnitudes" title="Permalink to this definition"></a></dt>
<dd><p>Do not export (network) magnitudes of origins. This
option is most useful in combination with -O to only
export the location information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-p">
<span id="cmdoption-scxmldump-preferred-only"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--preferred-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-p" title="Permalink to this definition"></a></dt>
<dd><p>When exporting events only the preferred origin, the preferred
magnitude and the preferred focal mechanism will be dumped.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-m">
<span id="cmdoption-scxmldump-all-magnitudes"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--all-magnitudes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-m" title="Permalink to this definition"></a></dt>
<dd><p>If only the preferred origin is exported, all magnitudes for
this origin will be dumped.</p>
</dd></dl>
</section>
<section id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-f">
<span id="cmdoption-scxmldump-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-f" title="Permalink to this definition"></a></dt>
<dd><p>Use formatted XML output. Otherwise all XML is printed
on one line.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-o">
<span id="cmdoption-scxmldump-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-o" title="Permalink to this definition"></a></dt>
<dd><p>Name of output file. If not given, output is sent to
stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmldump-prepend-datasize">
<span class="sig-name descname"><span class="pre">--prepend-datasize</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmldump-prepend-datasize" title="Permalink to this definition"></a></dt>
<dd><p>Prepend a line with the length of the XML data.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scxmldump</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#event-parameters">Event parameters</a></li>
<li><a class="reference internal" href="#format-conversion">Format conversion</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#dump">Dump</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scvoice.html"
title="previous chapter">scvoice</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scxmlmerge.html"
title="next chapter">scxmlmerge</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scxmldump.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,370 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scxmlmerge &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="sczip" href="sczip.html" />
<link rel="prev" title="scxmldump" href="scxmldump.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">6.9.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="sczip.html" title="sczip"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scxmldump.html" title="scxmldump"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scxmlmerge">
<span id="id1"></span><h1>scxmlmerge<a class="headerlink" href="#scxmlmerge" title="Permalink to this heading"></a></h1>
<p><strong>Merge the content of multiple XML files in SCML format.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scxmlmerge reads all <cite>SeisComP</cite> elements from one or more XML files in <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>
format. It merges the content and prints the result to standard output. The
input can contain and <a class="reference internal" href="../base/api-python.html#api-datamodel-python"><span class="std std-ref">SeisComP element</span></a> and the
content can be filtered to print only some elements such as EventParameters.
The output can be redirected into one single file and used by other applications.</p>
<p>The supported <a class="reference internal" href="../base/api-python.html#api-datamodel-python"><span class="std std-ref">SeisComP elements</span></a> are:</p>
<ul class="simple">
<li><p>Config</p></li>
<li><p>DataAvailability</p></li>
<li><p>EventParameters</p></li>
<li><p>Inventory</p></li>
<li><p>Journaling</p></li>
<li><p>QualityControl</p></li>
<li><p>Routing</p></li>
</ul>
<p>By default all supported elements will be parsed and merged. Duplicates are
removed. Use options to restrict the element types.</p>
<p>There are alternative modules for processing inventory XML files:</p>
<ul class="simple">
<li><p><a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>: Merge inventory XML files, extract inventory information.</p></li>
<li><p><a class="reference internal" href="invextr.html#invextr"><span class="std std-ref">invextr</span></a>: Extract and filter inventory information.</p></li>
</ul>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Merge the all SeisComP elements from 2 XML files into a single XML file:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmlmerge<span class="w"> </span>file1.xml<span class="w"> </span>file2.xml<span class="w"> </span>&gt;<span class="w"> </span>file.xml
</pre></div>
</div>
</li>
<li><p>Merge the all EventParameters and all Config elements from 2 XML files into a
single XML file. Other element types will be ignored:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scxmlmerge<span class="w"> </span>-E<span class="w"> </span>-C<span class="w"> </span>file1.xml<span class="w"> </span>file2.xml<span class="w"> </span>&gt;<span class="w"> </span>file.xml
</pre></div>
</div>
</li>
</ol>
</section>
<section id="module-configuration">
<span id="scxmlmerge-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scxmlmerge.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scxmlmerge.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scxmlmerge.cfg</span></code></div>
</div>
<p>scxmlmerge inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scxmlmerge [options] inputFiles</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-h">
<span id="cmdoption-scxmlmerge-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-V">
<span id="cmdoption-scxmlmerge-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmlmerge-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-v">
<span id="cmdoption-scxmlmerge-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-q">
<span id="cmdoption-scxmlmerge-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmlmerge-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmlmerge-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-s">
<span id="cmdoption-scxmlmerge-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-l">
<span id="cmdoption-scxmlmerge-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmlmerge-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmlmerge-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scxmlmerge-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="dump">
<h3>Dump<a class="headerlink" href="#dump" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-Y">
<span id="cmdoption-scxmlmerge-availability"></span><span class="sig-name descname"><span class="pre">-Y</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--availability</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-Y" title="Permalink to this definition"></a></dt>
<dd><p>Include DataAvailability specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-E">
<span id="cmdoption-scxmlmerge-event"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--event</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-E" title="Permalink to this definition"></a></dt>
<dd><p>Include EventParameters specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-I">
<span id="cmdoption-scxmlmerge-inventory"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--inventory</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-I" title="Permalink to this definition"></a></dt>
<dd><p>Include Inventory specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-J">
<span id="cmdoption-scxmlmerge-journaling"></span><span class="sig-name descname"><span class="pre">-J</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--journaling</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-J" title="Permalink to this definition"></a></dt>
<dd><p>Include QualityControl specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-C">
<span id="cmdoption-scxmlmerge-config"></span><span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-C" title="Permalink to this definition"></a></dt>
<dd><p>Include Config specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-Q">
<span id="cmdoption-scxmlmerge-quality"></span><span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quality</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-Q" title="Permalink to this definition"></a></dt>
<dd><p>Include QualityControl specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-R">
<span id="cmdoption-scxmlmerge-routing"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--routing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-R" title="Permalink to this definition"></a></dt>
<dd><p>Include Routing specifically. If no specfic object
type is given, all supported objects are included.</p>
</dd></dl>
</section>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scxmlmerge-ignore-bad-files">
<span class="sig-name descname"><span class="pre">--ignore-bad-files</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scxmlmerge-ignore-bad-files" title="Permalink to this definition"></a></dt>
<dd><p>Tolerate empty or corrupted input files and continue without
interruption. Otherwise, the application stops if corrupt
or empty files are processed.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scxmlmerge</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#dump">Dump</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scxmldump.html"
title="previous chapter">scxmldump</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="sczip.html"
title="next chapter">sczip</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scxmlmerge.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,340 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>sczip &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="seiscomp" href="seiscomp.html" />
<link rel="prev" title="scxmlmerge" href="scxmlmerge.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">6.9.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="seiscomp.html" title="seiscomp"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scxmlmerge.html" title="scxmlmerge"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="sczip">
<span id="id1"></span><h1>sczip<a class="headerlink" href="#sczip" title="Permalink to this heading"></a></h1>
<p><strong>Compress or expand files with ZIP algorithm</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>sczip can compress and decompress data using the ZIP algorithm (PKZIP). It
is not meant to supersede any available packagers but a little helper to
decompress zipped SeisComPML formats. Like GZip, sczip can only handle one file
and does not support archives. It compresses a byte stream and outputs a byte
stream.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>Decompress a file</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>-d<span class="w"> </span>file.xml.zip<span class="w"> </span>-o<span class="w"> </span>file.xml
</pre></div>
</div>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>-d<span class="w"> </span>file.xml.zip<span class="w"> </span>-o<span class="w"> </span>file.xml
</pre></div>
</div>
<p>Compress a file</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>file.xml<span class="w"> </span>-o<span class="w"> </span>file.xml.zip
</pre></div>
</div>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>&lt;<span class="w"> </span>file.xml<span class="w"> </span>&gt;<span class="w"> </span>file.xml.zip
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="sczip-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/sczip.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/sczip.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/sczip.cfg</span></code></div>
</div>
<p>sczip inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">sczip file.dat -o file.zip</strong></p>
<p><strong class="program">sczip file.dat -d -o file.zip</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-h">
<span id="cmdoption-sczip-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-V">
<span id="cmdoption-sczip-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-D">
<span id="cmdoption-sczip-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-v">
<span id="cmdoption-sczip-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-q">
<span id="cmdoption-sczip-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-s">
<span id="cmdoption-sczip-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-l">
<span id="cmdoption-sczip-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-d">
<span id="cmdoption-sczip-decompress"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--decompress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-d" title="Permalink to this definition"></a></dt>
<dd><p>Decompress.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sczip-o">
<span id="cmdoption-sczip-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-sczip-o" title="Permalink to this definition"></a></dt>
<dd><p>Output file name. Default is stdout.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">sczip</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scxmlmerge.html"
title="previous chapter">scxmlmerge</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="seiscomp.html"
title="next chapter">seiscomp</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/sczip.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,560 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>seiscomp &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="sh2proc" href="sh2proc.html" />
<link rel="prev" title="sczip" href="sczip.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">6.9.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="sh2proc.html" title="sh2proc"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="sczip.html" title="sczip"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="seiscomp">
<span id="id1"></span><h1>seiscomp<a class="headerlink" href="#seiscomp" title="Permalink to this heading"></a></h1>
<p><strong>SeisComP system control utility</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The tool <strong class="program">seiscomp</strong> allows controlling your <cite>SeisComP</cite> system on the
command line. As other <cite>SeisComP</cite> modules it provides
options and commands, e.g., the command <strong class="command">help</strong>. Apply
<strong class="program">seiscomp</strong> to</p>
<ul class="simple">
<li><p>Install software dependencies,</p></li>
<li><p>Print</p>
<ul>
<li><p>environment variables of the installed <cite>SeisComP</cite> system,</p></li>
<li><p>internal <cite>SeisComP</cite> variables which can be used in configurations,</p></li>
<li><p>suggestions for timed automatic actions, i.e. “<em>conjobs</em>”,</p></li>
</ul>
</li>
<li><p>Make a basic setup including the <cite>SeisComP</cite> database,</p></li>
<li><p>List daemon modules by categories,</p></li>
<li><p>Enable or disable modules in order to start them by default,</p></li>
<li><p>Start, stop, restart or reload single or multiple modules or all default
modules,</p></li>
<li><p>Check the status of module,</p></li>
<li><p>Execute single or multiple modules or all default modules</p></li>
<li><p>Print the run status of modules,</p></li>
<li><p>Manage modules aliases,</p></li>
<li><p>Update inventory or bindings configurations,</p></li>
<li><p>Manage <span class="xref std std-ref">bindings</span> by a specific shell.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When executing <strong class="program">seiscomp</strong>, all actions refer to the <cite>SeisComP</cite>
installation from within which <strong class="program">seiscomp</strong> is called. This allows
to refer to a default but also to any other installed <cite>SeisComP</cite> system and to
operate multiple <cite>SeisComP</cite> systems in parallel, e.g., for testing different
versions or for running different projects. Then give the full path to the
<strong class="program">seiscomp</strong> tools. Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">$HOME</span>/seiscomp-test/bin/seiscomp
</pre></div>
</div>
</div>
<p>Many of these actions are used by <a class="reference internal" href="scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a>.</p>
</section>
<section id="help">
<span id="sec-seiscomp-help"></span><h2>Help<a class="headerlink" href="#help" title="Permalink to this heading"></a></h2>
<p>Use the command <strong class="command">help</strong> for learning about the full set of options and
other commands including examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">help</span>
</pre></div>
</div>
<p>For basic help you may also use the option <code class="xref std std-option docutils literal notranslate"><span class="pre">-h</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>-h
</pre></div>
</div>
</section>
<section id="applications">
<span id="sec-seiscomp-applications"></span><h2>Applications<a class="headerlink" href="#applications" title="Permalink to this heading"></a></h2>
<section id="software-dependencies">
<span id="sec-seiscomp-sw-deps"></span><h3>Software dependencies<a class="headerlink" href="#software-dependencies" title="Permalink to this heading"></a></h3>
<p>Software dependencies should be installed after installation or updates of
<cite>SeisComP</cite>. You may install dependencies on different levels, e.g., <em>base</em>,
<em>gui</em>, <em>fdswnws</em>, <em>[database]-server</em>. Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>install-deps<span class="w"> </span>base
seiscomp<span class="w"> </span>install-deps<span class="w"> </span>base<span class="w"> </span>gui<span class="w"> </span>mariadb-server
</pre></div>
</div>
<p>Alternatively run the shell scripts for your Linux flavor and version located in
<code class="file docutils literal notranslate"><span class="pre">seiscomp/share/deps/</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For making a full installation and setup follow the instructions starting
with section <a class="reference internal" href="../base/installation.html#installation"><span class="std std-ref">SeisComP Installation</span></a>.</p>
</div>
</section>
<section id="print">
<span id="sec-seiscomp-print"></span><h3>Print<a class="headerlink" href="#print" title="Permalink to this heading"></a></h3>
<p>You may print the environment variables related to your considered <cite>SeisComP</cite>
installation, internal <cite>SeisComP</cite> variables or suggestions for timed automatic
procedures. Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>print<span class="w"> </span>env
<span class="nv">$HOME</span>/seiscomp-test/bin/seiscomp<span class="w"> </span>print<span class="w"> </span>env
seiscomp<span class="w"> </span>print<span class="w"> </span>variables
seiscomp<span class="w"> </span>print<span class="w"> </span>crontab
</pre></div>
</div>
<p>Add the environment variables to your shell configuration for making them known
user wide. Internal variables are resolved when applying them in user
configurations. For adjusting, adding or removing <strong class="program">crontab</strong> listings
execute:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>man<span class="w"> </span>crontab
crontab<span class="w"> </span>-e
</pre></div>
</div>
</section>
<section id="basic-setup">
<span id="sec-seiscomp-setup"></span><h3>Basic setup<a class="headerlink" href="#basic-setup" title="Permalink to this heading"></a></h3>
<p>Make a basic setup of your <cite>SeisComP</cite> system interactively after installation.
This will also allow you to generate a database or to configure the connection
to an existing one. Run, e.g.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>setup
<span class="nv">$HOME</span>/seiscomp-test/bin/seiscomp<span class="w"> </span>setup
</pre></div>
</div>
</section>
<section id="list">
<span id="sec-seiscomp-list"></span><h3>List<a class="headerlink" href="#list" title="Permalink to this heading"></a></h3>
<p>List modules which can be started to run as background daemon modules by
categories. Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>list<span class="w"> </span>modules
seiscomp<span class="w"> </span>list<span class="w"> </span>enabled
seiscomp<span class="w"> </span>list<span class="w"> </span>started
</pre></div>
</div>
</section>
<section id="enable-disable">
<span id="sec-seiscomp-enable"></span><h3>Enable/disable <a class="footnote-reference brackets" href="#id7" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>*<span class="fn-bracket">]</span></a><a class="headerlink" href="#enable-disable" title="Permalink to this heading"></a></h3>
<p>Enabled modules will be started to run as a background daemon module.
You may enable or disable one or multiple modules. Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>scautopick
seiscomp<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>scautopick<span class="w"> </span>scautoloc
seiscomp<span class="w"> </span>disable<span class="w"> </span>scautopick<span class="w"> </span>scautoloc
</pre></div>
</div>
</section>
<section id="start-stop-restart-reload">
<span id="sec-seiscomp-start"></span><h3>Start/stop/restart/reload <a href="#id8"><span class="problematic" id="id9"><span id="id3"></span>[*]_</span></a><a class="headerlink" href="#start-stop-restart-reload" title="Permalink to this heading"></a></h3>
<p>Start all enabled modules:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>start
</pre></div>
</div>
<p>Stop all modules and start all enabled modules:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>restart
</pre></div>
</div>
<p>Start/stop/restart specific modules</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>start<span class="w"> </span>scautopick<span class="w"> </span>scautoloc
seiscomp<span class="w"> </span>stop<span class="w"> </span>scautopick<span class="w"> </span>scautoloc
seiscomp<span class="w"> </span>restart<span class="w"> </span>scautopick<span class="w"> </span>scautoloc
</pre></div>
</div>
<p>In order to apply configurations, a module must be (re)started since it reads
any configuration only during startup. Restarts will create downtimes and should
be avoided as much as possible. In order to minimize downtimes, some modules
may apply changes in configuration by reloading during runtime without
restarting. For reloading you may use the command <strong class="command">seiscomp reload</strong>.
The application of reloading is therefore restricted to a limited range of
modules and parameters.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Graphical modules such as <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> cannot be operated as background
daemon modules. Therefore, they cannot be started but they can
be <a class="reference internal" href="#sec-seiscomp-execute"><span class="std std-ref">executed</span></a>.</p>
</div>
</section>
<section id="check">
<span id="sec-seiscomp-check"></span><h3>Check <a href="#id8"><span class="problematic" id="id10"><span id="id4"></span>[*]_</span></a><a class="headerlink" href="#check" title="Permalink to this heading"></a></h3>
<p>When modules stop unexpectedly, they are not stopped in a clean way. Such
stopped modules may be detected and started again in order to minimize
downtimes. Apply the <strong class="command">check</strong> command to all or specific modules.
Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>check
seiscomp<span class="w"> </span>check<span class="w"> </span>scautopick
</pre></div>
</div>
</section>
<section id="execute">
<span id="sec-seiscomp-execute"></span><h3>Execute<a class="headerlink" href="#execute" title="Permalink to this heading"></a></h3>
<p>Instead of running daemon modules you may execute modules in a terminal and
observe the output, e.g., for debugging or for applying command-line options.
Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>scolv<span class="w"> </span>--debug
seiscomp<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>scautopick<span class="w"> </span>--debug
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When all relevant system environment variables point to the same <cite>SeisComP</cite>
installation from where seiscomp is executed, then it is enough to execute
modules by their names replacing the above:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scolv<span class="w"> </span>--debug
scautopick<span class="w"> </span>--debug
</pre></div>
</div>
</div>
</section>
<section id="status">
<span id="sec-seiscomp-status"></span><h3>Status <a href="#id8"><span class="problematic" id="id11"><span id="id5"></span>[*]_</span></a><a class="headerlink" href="#status" title="Permalink to this heading"></a></h3>
<p>List the status of all, enabled, disabled, started, or specific modules.
Examples:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>status
seiscomp<span class="w"> </span>status<span class="w"> </span>enabled
seiscomp<span class="w"> </span>status<span class="w"> </span>disabled
seiscomp<span class="w"> </span>status<span class="w"> </span>started
seiscomp<span class="w"> </span>status<span class="w"> </span>scautopick
</pre></div>
</div>
<p>:command:status` will report modules which terminated due to errors.</p>
</section>
<section id="module-aliases">
<span id="sec-seiscomp-aliases"></span><h3>Module Aliases<a class="headerlink" href="#module-aliases" title="Permalink to this heading"></a></h3>
<p>For some <cite>SeisComP</cite> modules aliases can be generated allowing the separate
execution with specific configurations in parallel the original module
and even in separate pipeline with specific message groups.
Using the <strong class="command">alias</strong> command aliases modules can be created or removed.
Examples for creating or removing the alias <strong class="program">l1autopick</strong> to
<a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>l1autopick<span class="w"> </span>scautopick
seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>remove<span class="w"> </span>l1autopick
</pre></div>
</div>
<p>When creating aliases, soft links to the original module executable files, the
default configuration and the init files are created. The alias itself is
registered in <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/descriptions/aliases</span></code>. If a module does
not allow creating aliases a notification is printed. Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>scolv1<span class="w"> </span>scolv
error:<span class="w"> </span>module<span class="w"> </span><span class="s1">&#39;scolv&#39;</span><span class="w"> </span>not<span class="w"> </span>found
</pre></div>
</div>
<p>After creating aliases, they may be configured and operated in the same way as
the original module.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The length of alias names for modules considering
<a class="reference internal" href="../base/concepts/configuration.html#global-bindings-config"><span class="std std-ref">bindings</span></a> is strictly limited to 20 characters.</p>
</div>
<p>When removing aliases, all links and the alias registration are removed but
possibly existing module or binding configurations remained unchanged. The
option <code class="xref std std-option docutils literal notranslate"><span class="pre">--interactive</span></code> allows removing these configurations
interactively.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>--interactive<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>remove<span class="w"> </span>l1autopick
</pre></div>
</div>
</section>
<section id="update-configuration">
<span id="sec-seiscomp-update"></span><h3>Update configuration <a href="#id8"><span class="problematic" id="id12"><span id="id6"></span>[*]_</span></a><a class="headerlink" href="#update-configuration" title="Permalink to this heading"></a></h3>
<p>The command <strong class="command">update-config</strong> allows reading bindings configurations from
the standard <code class="file docutils literal notranslate"><span class="pre">&#64;KEYDIR&#64;</span></code> directory as well as inventory from
<code class="file docutils literal notranslate"><span class="pre">&#64;SYSTEMCONFIGDIR&#64;/inventory</span></code> and sending them to the messaging for
storing in the database or for generating the configuration of
<a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone modules</span></a>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config
</pre></div>
</div>
<p>Executing <strong class="command">seiscomp update-config</strong> involves:</p>
<ul class="simple">
<li><p>Merging inventory,</p></li>
<li><p>Sending inventory updates to the messaging,</p></li>
<li><p>Synchronisation of inventory, key files and bindings,</p></li>
<li><p>Sending any updates of bindings to the messaging,</p></li>
<li><p>Generation of configuration for <a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone modules</span></a>.</p></li>
</ul>
<p>The command can therefore be rater time consuming. For speeding up you may be
more specific:</p>
<ul>
<li><p>Only update global bindings and all <a class="reference internal" href="../base/glossary.html#term-trunk"><span class="xref std std-term">trunk</span></a> modules without inventory</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config<span class="w"> </span>trunk
</pre></div>
</div>
</li>
<li><p>Update only inventory</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config<span class="w"> </span>inventory
</pre></div>
</div>
</li>
<li><p>Update bindings of <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> only</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config<span class="w"> </span>scautopick
</pre></div>
</div>
<p>The command may be similarly applied to any other module considering
bindings.</p>
</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Instead of reading bindings configurations from the standard &#64;KEYDIR&#64;
directory, the module <a class="reference internal" href="bindings2cfg.html#bindings2cfg"><span class="std std-ref">bindings2cfg</span></a> can read bindings from any key
directory and write the Config parameters to <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> or send them to
the messaging.</p>
</div>
</section>
</section>
<section id="seiscomp-shell">
<span id="sec-seiscomp-shell"></span><h2>seiscomp Shell<a class="headerlink" href="#seiscomp-shell" title="Permalink to this heading"></a></h2>
<p>The seiscomp shell is a special environment, e.g., allowing to control
<a class="reference internal" href="../base/glossary.html#term-binding"><span class="xref std std-term">bindings</span></a> of <a class="reference internal" href="../base/glossary.html#term-module"><span class="xref std std-term">modules</span></a> to stations.</p>
<p>Applications are:</p>
<ul class="simple">
<li><p>Create or remove station bindings,</p></li>
<li><p>Create or remove binding profiles,</p></li>
<li><p>Remove binding profiles.</p></li>
</ul>
<p>Invoke <strong class="program">seiscomp</strong> along with the <strong class="command">shell</strong> command to start the
shell:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nv">shell</span>
<span class="w"> </span><span class="o">================================================================================</span>
<span class="w"> </span>SeisComP<span class="w"> </span><span class="nv">shell</span>
<span class="w"> </span><span class="o">================================================================================</span>
<span class="w"> </span>Welcome<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span>SeisComP<span class="w"> </span>interactive<span class="w"> </span>shell.<span class="w"> </span>You<span class="w"> </span>can<span class="w"> </span>get<span class="w"> </span><span class="nb">help</span><span class="w"> </span>about
<span class="w"> </span>available<span class="w"> </span>commands<span class="w"> </span>with<span class="w"> </span><span class="s1">&#39;help&#39;</span>.<span class="w"> </span><span class="s1">&#39;exit&#39;</span><span class="w"> </span>leaves<span class="w"> </span>the<span class="w"> </span>shell.
<span class="w"> </span>$
</pre></div>
</div>
<p>The full list of shell control commands are printed along with the help of the
seiscomp shell:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">================================================================================</span>
SeisComP<span class="w"> </span><span class="nv">shell</span>
<span class="o">================================================================================</span>
Welcome<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span>SeisComP<span class="w"> </span>interactive<span class="w"> </span>shell.<span class="w"> </span>You<span class="w"> </span>can<span class="w"> </span>get<span class="w"> </span><span class="nb">help</span><span class="w"> </span>about
available<span class="w"> </span>commands<span class="w"> </span>with<span class="w"> </span><span class="s1">&#39;help&#39;</span>.<span class="w"> </span><span class="s1">&#39;exit&#39;</span><span class="w"> </span>leaves<span class="w"> </span>the<span class="w"> </span>shell.
$<span class="w"> </span><span class="nb">help</span>
Commands:
<span class="w"> </span>list<span class="w"> </span>stations
<span class="w"> </span>Lists<span class="w"> </span>all<span class="w"> </span>available<span class="w"> </span>stations<span class="w"> </span>keys.
<span class="w"> </span>list<span class="w"> </span>profiles<span class="w"> </span><span class="o">{</span>mod<span class="o">}</span>
<span class="w"> </span>Lists<span class="w"> </span>all<span class="w"> </span>available<span class="w"> </span>profiles<span class="w"> </span>of<span class="w"> </span>a<span class="w"> </span>module.
...
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id7" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id2">*</a><span class="fn-bracket">]</span></span>
<p>With this command, the flag <code class="xref std std-option docutils literal notranslate"><span class="pre">--invert</span></code> can be used
in order to invert the application to the specific modules. You may provide
one or more module names. A major application is to
restart most <cite>SeisComP</cite> modules after a change in global bindings. However,
<a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> and <a class="reference internal" href="slarchive.html#slarchive"><span class="std std-ref">slarchive</span></a> are not affected by global
bindings and any downtime of these modules shall be avoided. Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>--invert<span class="w"> </span>restart<span class="w"> </span>seedlink<span class="w"> </span>slarchive
</pre></div>
</div>
<p>The same procedure could be achieved without <code class="xref std std-option docutils literal notranslate"><span class="pre">--invert</span></code> by
explicitly stating all other modules which, however, may result in a
long list of module names.</p>
</aside>
</aside>
</div>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">seiscomp [flags] command(s) [argument(s)]</strong></p>
<section id="flags">
<h3>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-seiscomp-asroot">
<span class="sig-name descname"><span class="pre">--asroot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-seiscomp-asroot" title="Permalink to this definition"></a></dt>
<dd><p>Allow running a command as root.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-seiscomp-csv">
<span class="sig-name descname"><span class="pre">--csv</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-seiscomp-csv" title="Permalink to this definition"></a></dt>
<dd><p>Print output as CSV in machine-readable format.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-seiscomp-h">
<span id="cmdoption-seiscomp-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-seiscomp-h" title="Permalink to this definition"></a></dt>
<dd><p>Produce this help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-seiscomp-i">
<span id="cmdoption-seiscomp-interactive"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--interactive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-seiscomp-i" title="Permalink to this definition"></a></dt>
<dd><p>Interactive mode: Allow deleting configurations interactively when
removing aliases.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-seiscomp-invert">
<span class="sig-name descname"><span class="pre">--invert</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-seiscomp-invert" title="Permalink to this definition"></a></dt>
<dd><p>Invert the selection of the specified module names when using any of the
commands: start, stop, check, status, reload, or restart.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-seiscomp-wait">
<span class="sig-name descname"><span class="pre">--wait</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-seiscomp-wait" title="Permalink to this definition"></a></dt>
<dd><p>Define a timeout in seconds for acquiring the seiscomp lock
file, e.g., <cite>seiscomp --wait 10 update-config</cite>.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">seiscomp</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#help">Help</a></li>
<li><a class="reference internal" href="#applications">Applications</a><ul>
<li><a class="reference internal" href="#software-dependencies">Software dependencies</a></li>
<li><a class="reference internal" href="#print">Print</a></li>
<li><a class="reference internal" href="#basic-setup">Basic setup</a></li>
<li><a class="reference internal" href="#list">List</a></li>
<li><a class="reference internal" href="#enable-disable">Enable/disable </a></li>
<li><a class="reference internal" href="#start-stop-restart-reload">Start/stop/restart/reload [*]_</a></li>
<li><a class="reference internal" href="#check">Check [*]_</a></li>
<li><a class="reference internal" href="#execute">Execute</a></li>
<li><a class="reference internal" href="#status">Status [*]_</a></li>
<li><a class="reference internal" href="#module-aliases">Module Aliases</a></li>
<li><a class="reference internal" href="#update-configuration">Update configuration [*]_</a></li>
</ul>
</li>
<li><a class="reference internal" href="#seiscomp-shell">seiscomp Shell</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#flags">Flags</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="sczip.html"
title="previous chapter">sczip</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="sh2proc.html"
title="next chapter">sh2proc</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/seiscomp.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,594 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>sh2proc &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="slmon" href="slmon.html" />
<link rel="prev" title="seiscomp" href="seiscomp.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">6.9.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="slmon.html" title="slmon"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="seiscomp.html" title="seiscomp"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="sh2proc">
<span id="id1"></span><h1>sh2proc<a class="headerlink" href="#sh2proc" title="Permalink to this heading"></a></h1>
<p><strong>Convert SeismicHandler event files to SCML.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>sh2proc converts <a class="reference external" href="http://www.seismic-handler.org/">Seismic Handler</a> event data to
SeisComP XML format. Data is read from input file or <cite>stdin</cite> if no input file is
specified. The result is available on <cite>stdout</cite>.</p>
</section>
<section id="code-mapping">
<h2>Code mapping<a class="headerlink" href="#code-mapping" title="Permalink to this heading"></a></h2>
<p>Since Seismic Handler only specifies station and component codes, a mapping to
SeisComP network, location and channel codes is necessary. The script assumes
that the same station code is not used in different networks. In case an
ambiguous id is found a warning is printed and the first network code is used.
The channel and stream code is extracted from the dectecStream and detecLocid
configured in the global bindings. In case no configuration module is available
the first location and stream is used.</p>
</section>
<section id="event-parameters">
<h2>Event parameters<a class="headerlink" href="#event-parameters" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Event types given in Seismic Handler files are mapped to SeisComP event types:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Seismic Handler</p></th>
<th class="head"><p>SeisComP</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>teleseismic quake</p></td>
<td><p>earthquake</p></td>
</tr>
<tr class="row-odd"><td><p>regional quake</p></td>
<td><p>earthquake</p></td>
</tr>
<tr class="row-even"><td><p>local quake</p></td>
<td><p>earthquake</p></td>
</tr>
<tr class="row-odd"><td><p>quarry blast</p></td>
<td><p>quarry blast</p></td>
</tr>
<tr class="row-even"><td><p>nuclear explosion</p></td>
<td><p>nuclear explosion</p></td>
</tr>
<tr class="row-odd"><td><p>mining event</p></td>
<td><p>mining explosion</p></td>
</tr>
</tbody>
</table>
</li>
<li><p>The EventID given in Seismic Handler files is mapped as a comment to the event.</p></li>
</ul>
</section>
<section id="magnitudes">
<h2>Magnitudes<a class="headerlink" href="#magnitudes" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Magnitude types given in Seismic Handler files are mapped to SeisComP magnitudes:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Seismic Handler</p></th>
<th class="head"><p>SeisComP</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>m</p></td>
<td><p>M</p></td>
</tr>
<tr class="row-odd"><td><p>ml</p></td>
<td><p>ML</p></td>
</tr>
<tr class="row-even"><td><p>mb</p></td>
<td><p>mb</p></td>
</tr>
<tr class="row-odd"><td><p>ms</p></td>
<td><p>Ms(BB)</p></td>
</tr>
<tr class="row-even"><td><p>mw</p></td>
<td><p>Mw</p></td>
</tr>
<tr class="row-odd"><td><p>bb</p></td>
<td><p>mB</p></td>
</tr>
</tbody>
</table>
</li>
<li><p>ML magnitudes in Seismic Handler files have no corresponding measured amplitudes.
Therefore the ML station magnitudes are converted without referencing the amplitude.</p></li>
<li><p>Seismic Handler uses the phase name “L” for referring to surface waves without
further specification. The phase name is kept unchanged.</p></li>
</ul>
</section>
<section id="distance-calculations">
<h2>Distance calculations<a class="headerlink" href="#distance-calculations" title="Permalink to this heading"></a></h2>
<p>In Seismic Handler files distances can be given in units of km or degree but in
SeisComP only degree is used. Both representations are considered for conversion.
In case of double posting preference is given to the Seismic Handler values given in km
due to their higher precision.</p>
</section>
<section id="beam-parameters">
<h2>Beam parameters<a class="headerlink" href="#beam-parameters" title="Permalink to this heading"></a></h2>
<p>Seismic Handler files provide the phase picks with theoretical, measured and corrected
slowness and (back) azimuth but the pick in SeisComP knows only one value.
During conversion highest preference is given to corrected values.
The theoretical values are ignored.</p>
</section>
<section id="limitations">
<h2>Limitations<a class="headerlink" href="#limitations" title="Permalink to this heading"></a></h2>
<p>The following parameters from Seismic Handler files are not considered:</p>
<ul class="simple">
<li><p>Phase Flag</p></li>
<li><p>Location Input Params</p></li>
<li><p>Reference Location Name</p></li>
<li><p>Quality Number</p></li>
<li><p>Ampl&amp;Period Source</p></li>
<li><p>Location Quality</p></li>
<li><p>Reference Latitude</p></li>
<li><p>Reference Longitude</p></li>
<li><p>Amplitude Time</p></li>
</ul>
</section>
<section id="further-processing-in-seiscomp">
<h2>Further processing in SeisComP<a class="headerlink" href="#further-processing-in-seiscomp" title="Permalink to this heading"></a></h2>
<p>The created XML files can be used in multiple ways, e.g.:</p>
<ol class="arabic simple">
<li><p>By other modules in an XML-base playback</p></li>
<li><p>Inject into the messaging system by <a class="reference internal" href="scdispatch.html#scdispatch"><span class="std std-ref">scdispatch</span></a></p></li>
<li><p>Integrate into the database by <a class="reference internal" href="scdb.html#scdb"><span class="std std-ref">scdb</span></a></p></li>
</ol>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Convert the Seismic Handler file <cite>shm.evt</cite> and writes SCML into the file
<cite>sc.xml</cite>. The database connection to read inventory and configuration
information is fetched from the default messaging connection.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sh2proc<span class="w"> </span>shm.evt<span class="w"> </span>&gt;<span class="w"> </span>sc.xml
</pre></div>
</div>
</li>
<li><p>Read Seismic Handler data from <cite>stdin</cite>. Inventory and configuration information
is provided through files.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cat<span class="w"> </span>shm.evt<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh2proc<span class="w"> </span>--inventory-db<span class="o">=</span>inventory.xml<span class="w"> </span>--config-db<span class="o">=</span>config.xml<span class="w"> </span>&gt;<span class="w"> </span>sc.xml
</pre></div>
</div>
</li>
</ol>
</section>
<section id="shm-evt-file-format">
<h2>shm.evt file format<a class="headerlink" href="#shm-evt-file-format" title="Permalink to this heading"></a></h2>
<p>The list of parameters supported by sh2proc may be incomplete.
Read the original <a class="reference external" href="http://www.seismic-handler.org/wiki/ShmDocFileEvt">format and parameter description</a>
of the SeismicHandler .evt files for providing correct input files.</p>
<p>Example of a SeismicHandler <cite>shm.evt</cite> file with supported parameters:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Event<span class="w"> </span>ID<span class="w"> </span>:<span class="w"> </span><span class="m">1170102002</span>
Station<span class="w"> </span>code<span class="w"> </span>:<span class="w"> </span>VITZ
Onset<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2</span>-JAN-2017_12:25:40.415
Onset<span class="w"> </span><span class="nb">type</span><span class="w"> </span>:<span class="w"> </span>emergent
Phase<span class="w"> </span>name<span class="w"> </span>:<span class="w"> </span>Pg
Event<span class="w"> </span>Type<span class="w"> </span>:<span class="w"> </span>mining<span class="w"> </span>event
Applied<span class="w"> </span>filter<span class="w"> </span>:<span class="w"> </span>SHM_BP_1HZ_25HZ_3
Component<span class="w"> </span>:<span class="w"> </span>Z
Quality<span class="w"> </span>number<span class="w"> </span>:<span class="w"> </span><span class="m">2</span>
Pick<span class="w"> </span>Type<span class="w"> </span>:<span class="w"> </span>manual
Weight<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>
Theo.<span class="w"> </span>Azimuth<span class="w"> </span><span class="o">(</span>deg<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">27</span>.29
Theo.<span class="w"> </span>Backazimuth<span class="w"> </span><span class="o">(</span>deg<span class="o">)</span>:<span class="w"> </span><span class="m">207</span>.36
Distance<span class="w"> </span><span class="o">(</span>deg<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">0</span>.122
Distance<span class="w"> </span><span class="o">(</span>km<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">13</span>.572
Magnitude<span class="w"> </span>ml<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.0
Phase<span class="w"> </span>Flags<span class="w"> </span>:<span class="w"> </span>L
---<span class="w"> </span>End<span class="w"> </span>of<span class="w"> </span>Phase<span class="w"> </span>---
Event<span class="w"> </span>ID<span class="w"> </span>:<span class="w"> </span><span class="m">1170102002</span>
Station<span class="w"> </span>code<span class="w"> </span>:<span class="w"> </span>WESF
Onset<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2</span>-JAN-2017_12:25:53.714
Onset<span class="w"> </span><span class="nb">type</span><span class="w"> </span>:<span class="w"> </span>emergent
Phase<span class="w"> </span>name<span class="w"> </span>:<span class="w"> </span>Pg
Event<span class="w"> </span>Type<span class="w"> </span>:<span class="w"> </span>mining<span class="w"> </span>event
Applied<span class="w"> </span>filter<span class="w"> </span>:<span class="w"> </span>SHM_BP_1HZ_25HZ_3
Component<span class="w"> </span>:<span class="w"> </span>Z
Quality<span class="w"> </span>number<span class="w"> </span>:<span class="w"> </span><span class="m">2</span>
Pick<span class="w"> </span>Type<span class="w"> </span>:<span class="w"> </span>manual
Weight<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>
Theo.<span class="w"> </span>Azimuth<span class="w"> </span><span class="o">(</span>deg<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">106</span>.98
Theo.<span class="w"> </span>Backazimuth<span class="w"> </span><span class="o">(</span>deg<span class="o">)</span>:<span class="w"> </span><span class="m">287</span>.91
Distance<span class="w"> </span><span class="o">(</span>deg<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">0</span>.807
Distance<span class="w"> </span><span class="o">(</span>km<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">89</span>.708
Magnitude<span class="w"> </span>ml<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.8
Mean<span class="w"> </span>Magnitude<span class="w"> </span>ml<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.1
Latitude<span class="w"> </span>:<span class="w"> </span>+50.779
Longitude<span class="w"> </span>:<span class="w"> </span>+10.003
Depth<span class="w"> </span><span class="o">(</span>km<span class="o">)</span><span class="w"> </span>:<span class="w"> </span><span class="m">0</span>.0
Depth<span class="w"> </span><span class="nb">type</span><span class="w"> </span>:<span class="w"> </span><span class="o">(</span>g<span class="o">)</span><span class="w"> </span>estimated
Origin<span class="w"> </span><span class="nb">time</span><span class="w"> </span>:<span class="w"> </span><span class="m">2</span>-JAN-2017_12:25:38.273
Region<span class="w"> </span>Table<span class="w"> </span>:<span class="w"> </span>GEO_REG
Region<span class="w"> </span>ID<span class="w"> </span>:<span class="w"> </span><span class="m">5326</span>
Source<span class="w"> </span>region<span class="w"> </span>:<span class="w"> </span>Tann,<span class="w"> </span>E<span class="w"> </span>of<span class="w"> </span>Fulda
Velocity<span class="w"> </span>Model<span class="w"> </span>:<span class="w"> </span>deu
Location<span class="w"> </span>Input<span class="w"> </span>Params<span class="w"> </span>:<span class="w"> </span><span class="m">20</span>
Reference<span class="w"> </span>Location<span class="w"> </span>Name:<span class="w"> </span>CENTRE
---<span class="w"> </span>End<span class="w"> </span>of<span class="w"> </span>Phase<span class="w"> </span>---
</pre></div>
</div>
</section>
<section id="module-configuration">
<span id="sh2proc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/sh2proc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/sh2proc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/sh2proc.cfg</span></code></div>
</div>
<p>sh2proc inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">sh2proc [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-h">
<span id="cmdoption-sh2proc-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-V">
<span id="cmdoption-sh2proc-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-config-file" title="Permalink to this definition"></a></dt>
<dd><p>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. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-D">
<span id="cmdoption-sh2proc-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>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).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set 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.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-v">
<span id="cmdoption-sh2proc-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-q">
<span id="cmdoption-sh2proc-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-s">
<span id="cmdoption-sh2proc-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-l">
<span id="cmdoption-sh2proc-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-u">
<span id="cmdoption-sh2proc-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-H">
<span id="cmdoption-sh2proc-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-t">
<span id="cmdoption-sh2proc-timeout"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-g">
<span id="cmdoption-sh2proc-primary-group"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-S">
<span id="cmdoption-sh2proc-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-d">
<span id="cmdoption-sh2proc-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sh2proc-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-sh2proc-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sh2proc-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">sh2proc</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#code-mapping">Code mapping</a></li>
<li><a class="reference internal" href="#event-parameters">Event parameters</a></li>
<li><a class="reference internal" href="#magnitudes">Magnitudes</a></li>
<li><a class="reference internal" href="#distance-calculations">Distance calculations</a></li>
<li><a class="reference internal" href="#beam-parameters">Beam parameters</a></li>
<li><a class="reference internal" href="#limitations">Limitations</a></li>
<li><a class="reference internal" href="#further-processing-in-seiscomp">Further processing in SeisComP</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#shm-evt-file-format">shm.evt file format</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="seiscomp.html"
title="previous chapter">seiscomp</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="slmon.html"
title="next chapter">slmon</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/sh2proc.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,633 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>slarchive &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="slinktool" href="slinktool.html" />
<link rel="prev" title="seedlink" href="seedlink.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">6.9.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="slinktool.html" title="slinktool"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="seedlink.html" title="seedlink"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="slarchive">
<span id="id1"></span><h1>slarchive<a class="headerlink" href="#slarchive" title="Permalink to this heading"></a></h1>
<p><strong>SeedLink client for data stream archiving</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>slarchive connects to a SeedLink server, requests data streams and writes received
packets into directory/file structures (archives). The precise layout
of the directories and files is defined in a format string.</p>
<p>The implemented layouts are:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#slarchive-section-sds"><span class="std std-ref">SDS</span></a>: The SeisComP Data Structure, default in <cite>SeisComP</cite></p></li>
<li><p>BUD: Buffer of Uniform Data structure</p></li>
<li><p>DLOG: The old SeisComP/datalog structure for backwards compatibility</p></li>
</ul>
<p>The duration for which the data are kept in archive is controlled by the bindings
parameter <a class="reference internal" href="#confval-keep"><code class="xref std std-confval docutils literal notranslate"><span class="pre">keep</span></code></a>. slarchive itself does not clean the archive. For removing
old data execute <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/var/lib/slarchive/purge_datafiles</span></code>. A
regular clean-up is suggested by</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>seiscomp print crontab
</pre></div>
</div>
<p>The resulting line, e.g.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>20 3 <span class="ge">* *</span> * /home/sysop/seiscomp/var/lib/slarchive/purge_datafiles &gt;/dev/null 2&gt;&amp;1
</pre></div>
</div>
<p>can be adjusted and added to crontab.</p>
</section>
<section id="background-execution">
<h2>Background Execution<a class="headerlink" href="#background-execution" title="Permalink to this heading"></a></h2>
<p>When starting slarchive in <cite>SeisComP</cite> as a daemon module in the background SDS is
considered and the packets are written without modification:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>$ seiscomp start slarchive
</pre></div>
</div>
</section>
<section id="command-line-execution">
<h2>Command-Line Execution<a class="headerlink" href="#command-line-execution" title="Permalink to this heading"></a></h2>
<p>Writing to <strong>other layouts</strong> or to <strong>multiple archives</strong> and other options are
supported when executing slarchive on the command line.
E.g. to write to more than one archive simply specify multiple format definitions
(or presets).</p>
<p>For more command-line option read the help:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>$ slarchive -h
</pre></div>
</div>
</section>
<section id="multiple-instances">
<h2>Multiple Instances<a class="headerlink" href="#multiple-instances" title="Permalink to this heading"></a></h2>
<p>slarchive allows generating aliases, e.g. for running in multiple instances with
different module and bindings configurations. For creating/removing aliases use the
<a class="reference internal" href="../base/management.html#sec-management-commands"><span class="std std-ref">seiscomp script</span></a>, e.g.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>$ seiscomp alias create slarchive2 slarchive
</pre></div>
</div>
</section>
<section id="sds-definition">
<span id="slarchive-section-sds"></span><h2>SDS definition<a class="headerlink" href="#sds-definition" title="Permalink to this heading"></a></h2>
<p>SDS is the basic directory and file layout in <cite>SeisComP</cite> for waveform archives. The
archive base directory is defined by <a class="reference internal" href="#confval-archive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">archive</span></code></a>. The SDS layout is defined
as:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>&lt;SDSdir&gt;
<span class="w"> </span>+<span class="w"> </span>year
<span class="w"> </span>+<span class="w"> </span>network<span class="w"> </span>code
<span class="w"> </span>+<span class="w"> </span>station<span class="w"> </span>code
<span class="w"> </span>+<span class="w"> </span>channel<span class="w"> </span>code
<span class="w"> </span>+<span class="w"> </span>one<span class="w"> </span>file<span class="w"> </span>per<span class="w"> </span>day<span class="w"> </span>and<span class="w"> </span>location,<span class="w"> </span>e.g.<span class="w"> </span>NET.STA.LOC.CHAN.D.YEAR.DOY
</pre></div>
</div>
<p>File example: <code class="file docutils literal notranslate"><span class="pre">&lt;SDSdir&gt;/Year/NET/STA/CHAN.TYPE/NET.STA.LOC.CHAN.TYPE.YEAR.DAY</span></code>.</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Field</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>SDSdir</p></td>
<td><p>Arbitrary base directory</p></td>
</tr>
<tr class="row-odd"><td><p>YEAR</p></td>
<td><p>4 digit YEAR</p></td>
</tr>
<tr class="row-even"><td><p>NET</p></td>
<td><p>Network code/identifier, 1-8 characters,
no spaces</p></td>
</tr>
<tr class="row-odd"><td><p>STA</p></td>
<td><p>Station code/identifier, 1-8 characters,
no spaces</p></td>
</tr>
<tr class="row-even"><td><p>CHAN</p></td>
<td><p>Channel code/identifier, 1-8 characters,
no spaces</p></td>
</tr>
<tr class="row-odd"><td><p>TYPE</p></td>
<td><p>1 character, indicating the data type,
provided types are:</p>
<div class="line-block">
<div class="line"><strong>D</strong> Waveform data</div>
<div class="line"><strong>E</strong> Detection data</div>
<div class="line"><strong>L</strong> Log data</div>
<div class="line"><strong>T</strong> Timing data</div>
<div class="line"><strong>C</strong> Calibration data</div>
<div class="line"><strong>R</strong> Response data</div>
<div class="line"><strong>O</strong> Opaque data</div>
</div>
</td>
</tr>
<tr class="row-even"><td><p>LOC</p></td>
<td><p>Location identifier, 1-8 characters,
no spaces</p></td>
</tr>
<tr class="row-odd"><td><p>DAY</p></td>
<td><p>3 digit day of year, padded with zeros</p></td>
</tr>
</tbody>
</table>
</section>
<section id="module-configuration">
<span id="slarchive-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>slarchive is a <a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> and does not inherit <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</div>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/slarchive.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/slarchive.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/slarchive.cfg</span></code></div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-address">
<span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#confval-address" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code></p>
<p>Type: <em>string</em></p>
<p>Host of the Seedlink server to connect to. If the acquisition
is running on one system nothing needs to be changed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-port">
<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#confval-port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18000</span></code></p>
<p>Type: <em>int</em></p>
<p>The port of the Seedlink server to connect to. If the acquisition
is running on one system this port must match the configured
local Seedlink port.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-archive">
<span class="sig-name descname"><span class="pre">archive</span></span><a class="headerlink" href="#confval-archive" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">var/lib/archive</span></code></p>
<p>Type: <em>string</em></p>
<p>Path to waveform archive where all data is stored. Relative paths
(as the default) are treated relative to the installation
directory ($SEISCOMP_ROOT).</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-buffer">
<span class="sig-name descname"><span class="pre">buffer</span></span><a class="headerlink" href="#confval-buffer" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
<p>Type: <em>int</em></p>
<p>Number of records (512 byte units) to buffer before flushing to
disk.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-delay">
<span class="sig-name descname"><span class="pre">delay</span></span><a class="headerlink" href="#confval-delay" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>The network reconnect delay (in seconds) for the connection
to the SeedLink server. If the connection breaks for any
reason this will govern how soon a reconnection should be
attempted. The default value is 30 seconds.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-networkTimeout">
<span class="sig-name descname"><span class="pre">networkTimeout</span></span><a class="headerlink" href="#confval-networkTimeout" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">900</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>The network timeout (in seconds) for the connection to the
SeedLink server. If no data [or keep alive packets?] are received
in this time range the connection is closed and re-established
(after the reconnect delay has expired). The default value is
600 seconds. A value of 0 disables the timeout.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-idleTimeout">
<span class="sig-name descname"><span class="pre">idleTimeout</span></span><a class="headerlink" href="#confval-idleTimeout" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>Timeout for closing idle data stream files in seconds. The idle
time of the data streams is only checked when some packets has
arrived. If no packets arrived no idle stream files will be
closed. There is no reason to change this parameter except for
the unusual cases where the process is running against an open
file number limit. Default is 300 seconds.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-keepalive">
<span class="sig-name descname"><span class="pre">keepalive</span></span><a class="headerlink" href="#confval-keepalive" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>s</em></p>
<p>Interval (in seconds) at which keepalive (heartbeat) packets
are sent to the server. Keepalive packets are only sent if
nothing is received within the interval. This requires a
Seedlink version &gt;= 3.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-validation.certs">
<span class="sig-name descname"><span class="pre">validation.certs</span></span><a class="headerlink" href="#confval-validation.certs" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">var/lib/certs</span></code></p>
<p>Type: <em>string</em></p>
<p>Path to cerificate store where all certificates and CRLs are stored. Relative
paths(as the default) are treated relative to the installation
directory ($SEISCOMP_ROOT).
If the signature check is enabled slarchive loads all files at start. The store
uses the OpenSSl store format. From the offical OpenSSL documentation:
&quot;The directory should contain one certificate or CRL per file in PEM format,
with a file name of the form hash.N for a certificate, or hash.rN for a CRL.
The .N or .rN suffix is a sequence number that starts at zero, and is incremented
consecutively for each certificate or CRL with the same hash value. Gaps in the
sequence numbers are not supported, it is assumed that there are no more objects
with the same hash beyond the first missing number in the sequence.The .N or .rN suffix
is a sequence number that starts at zero, and is incremented consecutively for
each certificate or CRL with the same hash value. Gaps in the sequence numbers
are not supported, it is assumed that there are no more objects with the same
hash beyond the first missing number in the sequence.&quot;
The hash value can be obtained as follows:</p>
<p>openssl x509 -hash -noout -in &lt;file&gt;</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-validation.mode">
<span class="sig-name descname"><span class="pre">validation.mode</span></span><a class="headerlink" href="#confval-validation.mode" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">ignore</span></code></p>
<p>Type: <em>string</em></p>
<p>Signatures are expected to be carried in blockette 2000
as opaque data. Modes:</p>
<p>ignore : Signatures will be ignored and no further actions
will be taken.
warning: Signatures will be checked and all received records
which do not carry a valid signature or no signature
at all will be logged with at warning level.
skip : All received records without a valid signature
will be ignored and will not be processed.</p>
</dd></dl>
</section>
<section id="bindings-parameters">
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-selectors">
<span class="sig-name descname"><span class="pre">selectors</span></span><a class="headerlink" href="#confval-selectors" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of stream selectors. If left empty all available
streams will be requested. See slarchive manpage for
more information.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-keep">
<span class="sig-name descname"><span class="pre">keep</span></span><a class="headerlink" href="#confval-keep" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
<p>Type: <em>int</em></p>
<p>Unit: <em>day</em></p>
<p>Number of days the data is kept in the archive. This
requires purge_datafile to be run as cronjob.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">slarchive [OPTION]... [host][:][port]</strong></p>
<p>Address ([host][:][port]) is a required argument. It specifies the address
of the SeedLink server in host:port format. Either the host, port or both
can be omitted. If host is omitted then localhost is assumed,
i.e. :18000 implies localhost:18000. If the port is omitted
then 18000 is assumed, i.e. localhost implies localhost:18000.
If only : is specified localhost:18000 is assumed.</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-V">
<span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-V" title="Permalink to this definition"></a></dt>
<dd><p>Print program version and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-h">
<span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-h" title="Permalink to this definition"></a></dt>
<dd><p>Print program usage and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-v">
<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-v" title="Permalink to this definition"></a></dt>
<dd><p>Be more verbose. This flag can be used multiple times (&quot;-v -v&quot; or &quot;-vv&quot;)
for more verbosity. One flag: report basic handshaking (link configuration) details and
briefly report each packet received. Two flags: report the details of the handshaking,
each packet received and detailed connection diagnostics.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-p">
<span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-p" title="Permalink to this definition"></a></dt>
<dd><p>Print details of received Mini-SEED data records. This flag can be used multiple times
(&quot;-p -p&quot; or &quot;-pp&quot;) for more detail. One flag: a single summary line
for each data packet received. Two flags: details of the Mini-SEED data records received,
including information from fixed header and 100/1000/1001 blockettes.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-nd">
<span class="sig-name descname"><span class="pre">-nd</span></span><span class="sig-prename descclassname"> <span class="pre">delay</span></span><a class="headerlink" href="#cmdoption-slarchive-nd" title="Permalink to this definition"></a></dt>
<dd><p>The network reconnect delay (in seconds) for the connection to the SeedLink server.
If the connection breaks for any reason this will govern how soon a reconnection should
be attempted. The default value is 30 seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-nt">
<span class="sig-name descname"><span class="pre">-nt</span></span><span class="sig-prename descclassname"> <span class="pre">timeout</span></span><a class="headerlink" href="#cmdoption-slarchive-nt" title="Permalink to this definition"></a></dt>
<dd><p>The network timeout (in seconds) for the connection to the SeedLink server. If no data
[or keep alive packets?] are received in this time range the connection is closed and
re-established (after the reconnect delay has expired). The default value is 600 seconds.
A value of 0 disables the timeout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-k">
<span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"> <span class="pre">keepalive</span></span><a class="headerlink" href="#cmdoption-slarchive-k" title="Permalink to this definition"></a></dt>
<dd><p>Interval (in seconds) at which keepalive (heartbeat) packets are sent to the server.
Keepalive packets are only sent if nothing is received within the interval. Requires SeedLink
version &gt;= 3.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-x">
<span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"> <span class="pre">statefile[:interval]</span></span><a class="headerlink" href="#cmdoption-slarchive-x" title="Permalink to this definition"></a></dt>
<dd><p>During client shutdown the last received sequence numbers and time stamps (start times)
for each data stream will be saved in this file. If this file exists upon startup the information
will be used to resume the data streams from the point at which they were stopped. In this way the
client can be stopped and started without data loss, assuming the data are still available on the
server. If an interval is specified the state will be saved every interval in that packets are
received. Otherwise the state will be saved only on normal program termination.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-i">
<span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"> <span class="pre">timeout</span></span><a class="headerlink" href="#cmdoption-slarchive-i" title="Permalink to this definition"></a></dt>
<dd><p>Timeout for closing idle data stream files in seconds. The idle time of the data streams is
only checked when some packets has arrived. If no packets arrived no idle stream files will be
closed. There is no reason to change this parameter except for the unusual cases where the
process is running against an open file number limit. Default is 300 seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-d">
<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-d" title="Permalink to this definition"></a></dt>
<dd><p>Configure the connection in &quot;dial-up&quot; mode. The remote server will close the connection when
it has sent all of the data in its buffers for the selected data streams. This is opposed to
the normal behavior of waiting indefinitely for data.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-b">
<span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-b" title="Permalink to this definition"></a></dt>
<dd><p>Configure the connection in &quot;batch&quot; mode.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-Fi-overlap">
<span class="sig-name descname"><span class="pre">-Fi[:overlap]</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-Fi-overlap" title="Permalink to this definition"></a></dt>
<dd><p>Future check initially. Check the last Mini-SEED data record in an existing archive file
and do not write new data to that file if it is older than a certain overlap. The default
overlap limit is 2 seconds; the overlap can be specified by appending a colon and the desired
overlap limit in seconds to the option. If the overlap is exceeded an error message will be
logged once for each time the file is opened. This option makes sense only for archive formats
where each unique data stream is written to a unique file (e.g. SDS format). If a data stream
is closed due to timeout (see option -i) the initial future check will be preformed when the
file is re-opened.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-Fc-overlap">
<span class="sig-name descname"><span class="pre">-Fc[:overlap]</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-Fc-overlap" title="Permalink to this definition"></a></dt>
<dd><p>Future check continuously. Available only for archive Mini-SEED data records. Check if the
first sample of the record is older than the last sample of the previous record for a given
archive file, within a certain overlap. The default overlap limit is 2 seconds; the overlap
can be specified by appending a colon and the desired overlap limit in seconds to the option.
If the overlap is exceeded an error message will be logged once until either a non-overlapping
packet is received or a new archive file is used. This option only makes sense for archive
formats where each unique data stream is written to a unique file (e.g. SDS format).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-A">
<span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"> <span class="pre">format</span></span><a class="headerlink" href="#cmdoption-slarchive-A" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received packets (Mini-SEED records) will be appended to a directory/file
structure defined by format. All directories implied in the format string will be created if
necessary. The option may be used multiple times to write received packets to multiple archives.
See the section &quot;archiving data&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-SDS">
<span class="sig-name descname"><span class="pre">-SDS</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-slarchive-SDS" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received packets (Mini-SEED records) will be saved into a Simple Data
Structure (SDS) dir/file structure starting at the specified directory. This directory and
all subdirectories will be created if necessary. This option is a preset of the -A option.
The SDS dir/file structure is:</p>
<p>&lt;SDSdir&gt;/&lt;YEAR&gt;/&lt;NET&gt;/&lt;STA&gt;/&lt;CHAN.TYPE&gt;/NET.STA.LOC.CHAN.TYPE.YEAR.DAY</p>
<p>Details are mentioned later on.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-BUD">
<span class="sig-name descname"><span class="pre">-BUD</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-slarchive-BUD" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received waveform data packets (Mini-SEED data records) will be saved into
a Buffer of Uniform Data (BUD) dir/file structure starting at the specified directory.
This directory and all subdirectories will be created if necessary. This option is a preset
of the -A option. The BUD dir/file structure is:</p>
<p>&lt;BUDdir&gt;/&lt;NET&gt;/&lt;STA&gt;/STA.NET.LOC.CHAN.YEAR.DAY</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-DLOG">
<span class="sig-name descname"><span class="pre">-DLOG</span></span><span class="sig-prename descclassname"> <span class="pre">DLOGdir</span></span><a class="headerlink" href="#cmdoption-slarchive-DLOG" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received packets (Mini-SEED data records) will be saved into an old style
SeisComP/datalog dir/file structure starting at the specified directory. This directory and
all subdirectories will be created if necessary. This option is a preset of the -A option.
The DLOG dir/file structure is:</p>
<p>&lt;DLOGdir&gt;/&lt;STA&gt;/[LOC.]&lt;CHAN&gt;.&lt;TYPE&gt;/STA.NET.CHAN.TYPE.YEAR.DAY.HHMM</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-l">
<span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"> <span class="pre">streamfile</span></span><a class="headerlink" href="#cmdoption-slarchive-l" title="Permalink to this definition"></a></dt>
<dd><p>The given file contains a list of streams. This option implies multi-station mode.
The format of the stream list file is given below in the section &quot;stream list file&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-s">
<span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"> <span class="pre">selectors</span></span><a class="headerlink" href="#cmdoption-slarchive-s" title="Permalink to this definition"></a></dt>
<dd><p>Defining default selectors. If no multi-station data streams are configured these selectors
will be used for uni-station mode. Otherwise these selectors will be used when no selectors
are specified for a given stream with the -S or -l options.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-S">
<span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"> <span class="pre">stream[:selectors]</span></span><a class="headerlink" href="#cmdoption-slarchive-S" title="Permalink to this definition"></a></dt>
<dd><p>The connection will be configured in multi-station mode with optional SeedLink selectors
for each station, see examples below. Stream should be provided in NET_STA format. If no
selectors are provided for a given stream, the default selectors will be used, if defined.</p>
<p>Requires SeedLink &gt;= 2.5.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slarchive-tw">
<span class="sig-name descname"><span class="pre">-tw</span></span><span class="sig-prename descclassname"> <span class="pre">start:[end]</span></span><a class="headerlink" href="#cmdoption-slarchive-tw" title="Permalink to this definition"></a></dt>
<dd><p>Specifying a time window for the data streams that is applied by the server. The format
for both times is year,month,day,hour,min,sec; for example: &quot;2002,08,05,14,00:2002,08,05,14,15,00&quot;.
The end time is optional but the colon must be present. If no end time is specified the
server will send data indefinitely. This option will override any saved state information.</p>
<p>Warning: time windowing might be disabled on the remote server.</p>
<p>Requires SeedLink &gt;= 3.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">slarchive</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#background-execution">Background Execution</a></li>
<li><a class="reference internal" href="#command-line-execution">Command-Line Execution</a></li>
<li><a class="reference internal" href="#multiple-instances">Multiple Instances</a></li>
<li><a class="reference internal" href="#sds-definition">SDS definition</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#bindings-parameters">Bindings Parameters</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="seedlink.html"
title="previous chapter">seedlink</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="slinktool.html"
title="next chapter">slinktool</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/slarchive.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,560 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>slinktool &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Inventory" href="../toc/inventory.html" />
<link rel="prev" title="slarchive" href="slarchive.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">6.9.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="../toc/inventory.html" title="Inventory"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="slarchive.html" title="slarchive"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="slinktool">
<span id="id1"></span><h1>slinktool<a class="headerlink" href="#slinktool" title="Permalink to this heading"></a></h1>
<p><strong>SeedLink query interface module</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>slinktool connects to a <a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> server and queries the server for information
or requests data using uni-station or multi-station mode and prints information
about the packets received. All received packets can optionally be dumped to a
single file or saved in custom directory and file layouts.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<section id="all-station-uni-station-mode">
<h3>All-station/Uni-station mode<a class="headerlink" href="#all-station-uni-station-mode" title="Permalink to this heading"></a></h3>
<p>The following would connect to a SeedLink server at slink.host.com port 18000 and
configure the link in all-station/uni-station mode, exactly which data are received
depends on the data being served by the SeedLink server on that particular port.
Additionally, all of the received packets are appended to the file data.mseed
and each packet received is reported on the standard output.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>slinktool -v -o data.mseed slink.host.com:18000
</pre></div>
</div>
<p>The -s argument could be used to indicate selectors to limit the type of packets
sent by the SeedLink server (without selectors all packet types are sent). The
following would limit this connection to BHZ channel waveform data with a location
code of 10 (see an explanation of SeedLink selectors below). Additionally another
verbose flag is given, causing slinktool to report detailed header information
from data records.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>slinktool -vv -s 10BHZ.D -o data.mseed slink.host.com:18000
</pre></div>
</div>
</section>
<section id="multi-station-mode">
<h3>Multi-station mode<a class="headerlink" href="#multi-station-mode" title="Permalink to this heading"></a></h3>
<p>The following example would connect to a SeedLink server on localhost port 18010
and configure the link in multi-station mode. Each station specified with the -S
argument will be requested, optionally specifying selectors for each station.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>slinktool -v -S GE\_WLF,MN\_AQU:00???,IU\_KONO:BHZ.D :18010
</pre></div>
</div>
<p>This would request all data from the GEOFON station WLF as no selectors were indicated,
MedNet station AQU with location code 00 and all streams and waveform data from the
IU network station KONO from stream BHZ.
A variety of different data selections can be made simultaneously.</p>
<p>Examples:</p>
<ul>
<li><p>Horizontal BH channels, data only:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>-s &#39;BHE.D BHN.D&#39; -S &#39;GE\_STU,GE\_MALT,GE\_WLF&#39;
</pre></div>
</div>
</li>
<li><p>Vertical channels only:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>-s BHZ -S GE\_STU,GE\_WLF,GE\_RUE,GE\_EIL
</pre></div>
</div>
</li>
</ul>
</section>
<section id="wildcarding-network-and-station-codes">
<h3>Wildcarding network and station codes<a class="headerlink" href="#wildcarding-network-and-station-codes" title="Permalink to this heading"></a></h3>
<p>Some SeedLink implementations support wildcarding of the network and station codes.
If this is the case, the only two wildcard characters recognized are * for
one or more characters and ? for any single character.</p>
<p>As an example, all US network data can be requested using the following syntax</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>-S &#39;US\_\*&#39;
</pre></div>
</div>
</section>
</section>
<section id="seedlink-selectors">
<h2>Seedlink Selectors<a class="headerlink" href="#seedlink-selectors" title="Permalink to this heading"></a></h2>
<p>SeedLink selectors are used to request specific types of data within a given data
stream, in effect limiting the default action of sending all data types.
A data packet is sent to the client if it matches any positive selector
(without leading “!”) and doesnt match any negative selectors (with a leading “!”).
The general format of selectors is LLSSS.T, where LL is location, SSS is channel
and T is type (one of [DECOTL] for Data, Event, Calibration, Blockette, Timing,
and Log records). “LL”, “.T”, and “LLSSS.” can be omitted, implying anything in
that field. It is also possible to use “?” in place of L and S as a single character
wildcard. Multiple selectors are separated by space(s).</p>
<p>Examples:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>BH? - BHZ, BHN, BHE (all record types)
00BH?.D - BHZ, BHN, BHE with location code &#39;00&#39; (data records)
BH? !E - BHZ, BHN, BHE (excluding detection records)
BH? E - BHZ, BHN, BHE &amp; detection records of all channels
!LCQ !LEP - exclude LCQ and LEP channels
!L !T - exclude log and timing records
</pre></div>
</div>
</section>
<section id="archiving-data">
<h2>Archiving Data<a class="headerlink" href="#archiving-data" title="Permalink to this heading"></a></h2>
<p>Using the -A format option received data can be saved in a custom directory and
file structure. The archive format argument is expanded for each packet processed
using the following flags:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>n : network code, white space removed
s : station code, white space removed
l : location code, white space removed
c : channel code, white space removed
Y : year, 4 digits
y : year, 2 digits zero padded
j : day of year, 3 digits zero padded
H : hour, 2 digits zero padded
M : minute, 2 digits zero padded
S : second, 2 digits zero padded
F : fractional seconds, 4 digits zero padded
% : the percent (%) character
# : the number (#) character
t : single character type code:
D - waveform data packet
E - detection packet
C - calibration packet
T - timing packet
L - log packet
O - opaque data packet
U - unknown/general packet
I - INFO packet
? - unidentifiable packet
</pre></div>
</div>
<p>The flags are prefaced with either the % or # modifier. The % modifier indicates
a defining flag while the # indicates a non-defining flag. All received packets
with the same set of defining flags will be saved to the same file. Non-defining
flags will be expanded using the values in the first packet received for the
resulting file name.</p>
<p>Time flags are based on the start time of the given packet.</p>
<p>For example, the format string:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/archive/%n/%s/%n.%s.%l.%c.%Y.%j
</pre></div>
</div>
<p>would be expanded to day length files named something like:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/archive/NL/HGN/NL.HGN..BHE.2003.055
</pre></div>
</div>
<p>Using non-defining flags the format string:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/data/%n.%s.%Y.%j.%H:#M:#S.miniseed
</pre></div>
</div>
<p>would be expanded to:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/data/NL.HGN.2003.044.14:17:54.miniseed
</pre></div>
</div>
<p>resulting in hour length files because the minute and second are specified with the non-defining modifier. The minute and second fields are from the first packet in the file.</p>
</section>
<section id="stream-list-file">
<h2>Stream List File<a class="headerlink" href="#stream-list-file" title="Permalink to this heading"></a></h2>
<p>The stream list file used with the -l option is expected to define a data stream
on each line. The format of each line is:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>Network Station [selectors]
</pre></div>
</div>
<p>The selectors are optional. If default selectors are also specified (with the -s option),
they they will be used when no selectors are specified for a given stream.</p>
<p>Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>---- Begin example file -----
# Comment lines begin with a &#39;#&#39; or &#39;\*&#39;
# Example stream list file for use with the -l argument of slclient or
# with the sl\_read\_streamlist() libslink function.
GE ISP BH?.D
NL HGN
MN AQU BH? HH?
---- End example file -----
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>All diagnostic output from slinktool is printed to standard error (stderr).
Exceptions are when</p>
<ul class="simple">
<li><p>Printing miniSEED packet details with the <em>-p</em> option.</p></li>
<li><p>Printing unpacked samples with the <em>-u</em> option.</p></li>
<li><p>Printing the raw or formatted responses to INFO requests.</p></li>
</ul>
</div>
</section>
<section id="author-of-slinktool">
<h2>Author of slinktool<a class="headerlink" href="#author-of-slinktool" title="Permalink to this heading"></a></h2>
<p>Chad Trabant</p>
<p>ORFEUS Data Center/EC-Project MEREDIAN</p>
<p>IRIS Data Management Center</p>
<p>Original source code: <a class="reference external" href="https://github.com/iris-edu/slinktool/tree/master/doc">https://github.com/iris-edu/slinktool/tree/master/doc</a></p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">slinktool [OPTION]... [host][:][port]</strong></p>
<p>Address ([host][:][port]) is a required argument. It specifies the address
of the SeedLink server in host:port format. Either the host, port or both
can be omitted. If host is omitted then localhost is assumed,
i.e. :18000 implies localhost:18000. If the port is omitted,
then 18000 is assumed, i.e. localhost implies localhost:18000.
If only : is specified, localhost:18000 is assumed.</p>
<section id="general-program-options">
<h3>General program options<a class="headerlink" href="#general-program-options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-V">
<span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-V" title="Permalink to this definition"></a></dt>
<dd><p>Print program version and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-h">
<span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-h" title="Permalink to this definition"></a></dt>
<dd><p>Print program usage and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-v">
<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-v" title="Permalink to this definition"></a></dt>
<dd><p>Be more verbose. This flag can be used multiple times (&quot;-v -v&quot; or &quot;-vv&quot;)
for more verbosity. One flag: report basic handshaking (link configuration) details and
briefly report each packet received. Two flags: report the details of the handshaking,
each packet received and detailed connection diagnostics.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-P">
<span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-P" title="Permalink to this definition"></a></dt>
<dd><p>Ping the server, report the server ID and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-p">
<span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-p" title="Permalink to this definition"></a></dt>
<dd><p>Print details of received Mini-SEED data records. This flag can be used multiple times
(&quot;-p -p&quot; or &quot;-pp&quot;) for more detail. One flag: a single summary line
for each data packet received. Two flags: details of the Mini-SEED data records received,
including information from fixed header and 100/1000/1001 blockettes.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-u">
<span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-u" title="Permalink to this definition"></a></dt>
<dd><p>Print unpacked samples of data packets.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-nd">
<span class="sig-name descname"><span class="pre">-nd</span></span><span class="sig-prename descclassname"> <span class="pre">delay</span></span><a class="headerlink" href="#cmdoption-slinktool-nd" title="Permalink to this definition"></a></dt>
<dd><p>The network reconnect delay for the connection to the SeedLink server.
If the connection breaks for any reason this will govern how soon a reconnection should
be attempted.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-nt">
<span class="sig-name descname"><span class="pre">-nt</span></span><span class="sig-prename descclassname"> <span class="pre">timeout</span></span><a class="headerlink" href="#cmdoption-slinktool-nt" title="Permalink to this definition"></a></dt>
<dd><p>The network timeout (in seconds) for the connection to the SeedLink server. If no data
[or keep alive packets?] are received in this time range the connection is closed and
re-established (after the reconnect delay has expired). The default value is 600 seconds.
A value of 0 disables the timeout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-k">
<span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"> <span class="pre">interval</span></span><a class="headerlink" href="#cmdoption-slinktool-k" title="Permalink to this definition"></a></dt>
<dd><p>Interval at which keepalive (heartbeat) packets are sent to the server.
Keepalive packets are only sent if nothing is received within the interval.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-x">
<span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"> <span class="pre">sfile[:interval]</span></span><a class="headerlink" href="#cmdoption-slinktool-x" title="Permalink to this definition"></a></dt>
<dd><p>Save/restore stream state information to this file.</p>
<p>During client shutdown the last received sequence numbers and time stamps (start times)
for each data stream will be saved in this file. If this file exists upon startup the information
will be used to resume the data streams from the point at which they were stopped. In this way the
client can be stopped and started without data loss, assuming the data are still available on the
server. If an interval is specified the state will be saved every interval in that packets are
received. Otherwise the state will be saved only on normal program termination.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-d">
<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-d" title="Permalink to this definition"></a></dt>
<dd><p>Configure the connection in &quot;dial-up&quot; mode. The remote server will close the connection when
it has sent all of the data in its buffers for the selected data streams. This is opposed to
the normal behavior of waiting indefinitely for data.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-b">
<span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-b" title="Permalink to this definition"></a></dt>
<dd><p>Configure the connection in &quot;batch&quot; mode.</p>
</dd></dl>
</section>
<section id="data-stream-selection">
<h3>Data stream selection<a class="headerlink" href="#data-stream-selection" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-s">
<span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"> <span class="pre">selector</span></span><a class="headerlink" href="#cmdoption-slinktool-s" title="Permalink to this definition"></a></dt>
<dd><p>Selectors for uni-station or default for multi-station mode</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-l">
<span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"> <span class="pre">listfile</span></span><a class="headerlink" href="#cmdoption-slinktool-l" title="Permalink to this definition"></a></dt>
<dd><p>Read a stream list from this file for multi-station mode</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-S">
<span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"> <span class="pre">streams</span></span><a class="headerlink" href="#cmdoption-slinktool-S" title="Permalink to this definition"></a></dt>
<dd><p>Define a stream list for multi-station mode.</p>
<p>streams = stream1[:selectors1],stream2[:selectors2],…’</p>
<p>stream is in NET_STA format, for example:</p>
<p>-S &quot;IU_KONO:BHE BHN,GE_WLF,MN_AQU:HH?.D&quot;</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-tw">
<span class="sig-name descname"><span class="pre">-tw</span></span><span class="sig-prename descclassname"> <span class="pre">begin:[end]</span></span><a class="headerlink" href="#cmdoption-slinktool-tw" title="Permalink to this definition"></a></dt>
<dd><p>Specify a time window in year,month,day,hour,min,sec format.</p>
<p>Example: -tw 2002,08,05,14,00,00:2002,08,05,14,15,00</p>
<p>The end time is optional, but the colon must be present.</p>
</dd></dl>
</section>
<section id="data-saving-options">
<h3>Data saving options<a class="headerlink" href="#data-saving-options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-o">
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">dumpfile</span></span><a class="headerlink" href="#cmdoption-slinktool-o" title="Permalink to this definition"></a></dt>
<dd><p>Write all received records to this file</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-A">
<span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"> <span class="pre">format</span></span><a class="headerlink" href="#cmdoption-slinktool-A" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received packets (Mini-SEED records) will be appended to a directory/file
structure defined by format. All directories implied in the format string will be created if
necessary.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-SDS">
<span class="sig-name descname"><span class="pre">-SDS</span></span><span class="sig-prename descclassname"> <span class="pre">SDSdir</span></span><a class="headerlink" href="#cmdoption-slinktool-SDS" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received packets (Mini-SEED records) will be saved into a Simple Data
Structure (SDS) dir/file structure starting at the specified directory. This directory and
all subdirectories will be created if necessary. This option is a preset of the -A option.
The SDS dir/file structure is:</p>
<p>&lt;SDSdir&gt;/&lt;YEAR&gt;/&lt;NET&gt;/&lt;STA&gt;/&lt;CHAN.TYPE&gt;/NET.STA.LOC.CHAN.TYPE.YEAR.DAY</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-BUD">
<span class="sig-name descname"><span class="pre">-BUD</span></span><span class="sig-prename descclassname"> <span class="pre">BUDdir</span></span><a class="headerlink" href="#cmdoption-slinktool-BUD" title="Permalink to this definition"></a></dt>
<dd><p>If specified, all received waveform data packets (Mini-SEED data records) will be saved into
a Buffer of Uniform Data (BUD) dir/file structure starting at the specified directory.
This directory and all subdirectories will be created if necessary. This option is a preset
of the -A option. The BUD dir/file structure is:</p>
<p>&lt;BUDdir&gt;/&lt;NET&gt;/&lt;STA&gt;/STA.NET.LOC.CHAN.YEAR.DAY</p>
</dd></dl>
</section>
<section id="data-server">
<h3>Data server<a class="headerlink" href="#data-server" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-i">
<span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"> <span class="pre">type</span></span><a class="headerlink" href="#cmdoption-slinktool-i" title="Permalink to this definition"></a></dt>
<dd><p>Send info request, type is one of the following:</p>
<p>ID, CAPABILITIES, STATIONS, STREAMS, GAPS, CONNECTIONS, ALL</p>
<p>The returned raw XML is displayed when using this option.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-I">
<span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-I" title="Permalink to this definition"></a></dt>
<dd><p>Print formatted server id and version</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-L">
<span class="sig-name descname"><span class="pre">-L</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-L" title="Permalink to this definition"></a></dt>
<dd><p>Print formatted station list (if supported by server)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-Q">
<span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-Q" title="Permalink to this definition"></a></dt>
<dd><p>Print formatted stream list (if supported by server)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-G">
<span class="sig-name descname"><span class="pre">-G</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-G" title="Permalink to this definition"></a></dt>
<dd><p>Print formatted gap list (if supported by server)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-slinktool-C">
<span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slinktool-C" title="Permalink to this definition"></a></dt>
<dd><p>Print formatted connection list (if supported by server)</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">slinktool</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#all-station-uni-station-mode">All-station/Uni-station mode</a></li>
<li><a class="reference internal" href="#multi-station-mode">Multi-station mode</a></li>
<li><a class="reference internal" href="#wildcarding-network-and-station-codes">Wildcarding network and station codes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#seedlink-selectors">Seedlink Selectors</a></li>
<li><a class="reference internal" href="#archiving-data">Archiving Data</a></li>
<li><a class="reference internal" href="#stream-list-file">Stream List File</a></li>
<li><a class="reference internal" href="#author-of-slinktool">Author of slinktool</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#general-program-options">General program options</a></li>
<li><a class="reference internal" href="#data-stream-selection">Data stream selection</a></li>
<li><a class="reference internal" href="#data-saving-options">Data saving options</a></li>
<li><a class="reference internal" href="#data-server">Data server</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="slarchive.html"
title="previous chapter">slarchive</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../toc/inventory.html"
title="next chapter">Inventory</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/slinktool.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,317 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>slmon &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Addon Modules" href="../base/addons.html" />
<link rel="prev" title="sh2proc" href="sh2proc.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">6.9.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="../base/addons.html" title="Addon Modules"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="sh2proc.html" title="sh2proc"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="slmon">
<span id="id1"></span><h1>slmon<a class="headerlink" href="#slmon" title="Permalink to this heading"></a></h1>
<p><strong>SeedLink monitor creating web pages</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>slmon</em> collects waveform QC parameters from a configured <a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> Server
and creates static HTML websites for their visualization. <a class="reference internal" href="#fig-slmon"><span class="std std-ref">Station summeries</span></a> and
<a class="reference internal" href="#fig-slmon-stat"><span class="std std-ref">per-station channels views</span></a> are available.</p>
</section>
<section id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Adjust the module configuration parameters of <em>slmon</em> to set the seedlink Server,
the output directory for the created webpages and other parameters.</p></li>
<li><p>Create and adjust binding profiles and station bindings for <em>slmon</em> to activate
the monitoring of the desired networks and stations.</p></li>
<li><p>Update the configuration of <em>slmon</em></p></li>
<li><p>Start <em>slmon</em>. This step reads the QC parameters and creates the static webpage.
The webpage is not automatically updated.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>update-config
seiscomp<span class="w"> </span>start<span class="w"> </span>slmon
</pre></div>
</div>
</li>
<li><p>Restart <em>slmon</em> in order to upate the webpage. The restart can be
performed by a the regular system check scheduled by a crontab entry.</p>
<p>The example below shows a crontab entry to update the webpage
generated by <em>slmon</em> every 3 minutes:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>*/3<span class="w"> </span>*<span class="w"> </span>*<span class="w"> </span>*<span class="w"> </span>*<span class="w"> </span>/home/sysop/seiscomp/bin/seiscomp<span class="w"> </span>check<span class="w"> </span>slmon<span class="w"> </span>&gt;/dev/null<span class="w"> </span><span class="m">2</span>&gt;<span class="p">&amp;</span><span class="m">1</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The crontab entry can be generated and added automatically
using the seiscomp script:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>print<span class="w"> </span>crontab<span class="w"> </span><span class="p">|</span><span class="w"> </span>crontab<span class="w"> </span>-
</pre></div>
</div>
</div>
</li>
</ol>
<p>A comprehensive example for monitoring many stations of a large number of networks
is provided by <a class="reference external" href="http://geofon.gfz-potsdam.de/waveform/status/">GEOFON</a> at
<a class="reference external" href="http://www.gfz-potsdam.de">GFZ Potsdam</a>, Germany. A simple example of a website
create by <em>slmon</em> is given in the <a class="reference internal" href="#fig-slmon"><span class="std std-ref">figures below</span></a>.</p>
<figure class="align-center" id="id2">
<span id="fig-slmon"></span><a class="reference internal image-reference" href="../_images/slmon.png"><img alt="../_images/slmon.png" src="../_images/slmon.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Example of a website with the station summary created by <em>slmon</em>.</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</figcaption>
</figure>
<figure class="align-center" id="id3">
<span id="fig-slmon-stat"></span><a class="reference internal image-reference" href="../_images/slmon-stat.png"><img alt="../_images/slmon-stat.png" src="../_images/slmon-stat.png" style="width: 16cm;" /></a>
<figcaption>
<p><span class="caption-text">Example of a website with a per-station channel view created by <em>slmon</em>.</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</figcaption>
</figure>
</section>
<section id="module-configuration">
<span id="slmon-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>slmon is a <a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> and does not inherit <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</div>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/slmon.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/slmon.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/slmon.cfg</span></code></div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-title">
<span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#confval-title" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&quot;SeedLink</span> <span class="pre">Monitor&quot;</span></code></p>
<p>Type: <em>string</em></p>
<p>Title of the web page used as heading.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-refresh">
<span class="sig-name descname"><span class="pre">refresh</span></span><a class="headerlink" href="#confval-refresh" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Refresh interval of the generated web page used by the browser.
The interval should be similar to the interval for starting slmon.
If empty, the web page must be manually refreshed from within
the browser.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-address">
<span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#confval-address" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code></p>
<p>Type: <em>string</em></p>
<p>Host of the Seedlink server to connect to. If the acquisition
is running on one system nothing needs to be changed.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-port">
<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#confval-port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18000</span></code></p>
<p>Type: <em>int</em></p>
<p>The port of the Seedlink server to connect to. If the acquisition
is running on one system this port must match the configured
local Seedlink port.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-email">
<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#confval-email" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>e-mail address added to web pages.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-wwwdir">
<span class="sig-name descname"><span class="pre">wwwdir</span></span><a class="headerlink" href="#confval-wwwdir" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/run/&#64;NAME&#64;</span></code></p>
<p>Type: <em>string</em></p>
<p>Output directory of the web pages.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-icon">
<span class="sig-name descname"><span class="pre">icon</span></span><a class="headerlink" href="#confval-icon" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://www.gfz-potsdam.de/favicon.ico</span></code></p>
<p>Type: <em>string</em></p>
<p>Favicon URL of the web pages. Not mandatory.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-linkname">
<span class="sig-name descname"><span class="pre">linkname</span></span><a class="headerlink" href="#confval-linkname" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">GEOFON</span></code></p>
<p>Type: <em>string</em></p>
<p>Name of Link shown in footer of web pages.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-linkurl">
<span class="sig-name descname"><span class="pre">linkurl</span></span><a class="headerlink" href="#confval-linkurl" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://www.gfz-potsdam.de/geofon/</span></code></p>
<p>Type: <em>string</em></p>
<p>URL referred to by linkname in footer of web pages.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-liveurl">
<span class="sig-name descname"><span class="pre">liveurl</span></span><a class="headerlink" href="#confval-liveurl" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://geofon.gfz-potsdam.de/waveform/liveseis.php?station=%s</span></code></p>
<p>Type: <em>string</em></p>
<p>URL to live seismograms. %s will be replaced by station name.
Not mandatory.</p>
</dd></dl>
</section>
<section id="bindings-parameters">
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-group">
<span class="sig-name descname"><span class="pre">group</span></span><a class="headerlink" href="#confval-group" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">local</span></code></p>
<p>Type: <em>string</em></p>
<p>Defines the group of the station that is monitored.</p>
</dd></dl>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">slmon</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#bindings-parameters">Bindings Parameters</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="sh2proc.html"
title="previous chapter">sh2proc</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../base/addons.html"
title="next chapter">Addon Modules</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/slmon.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,230 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>tab2inv &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="tabinvmodifier" href="tabinvmodifier.html" />
<link rel="prev" title="scinv" href="scinv.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">6.9.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="tabinvmodifier.html" title="tabinvmodifier"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scinv.html" title="scinv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="tab2inv">
<span id="id1"></span><h1>tab2inv<a class="headerlink" href="#tab2inv" title="Permalink to this heading"></a></h1>
<p><strong>tab to SeisComp3 inventory converter</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The tab2inv program is part of the nettab package distributed together with the
<cite>SeisComP</cite> package. The nettab is a text-based format developed inside the
GEOFON data center to describe seismological instruments responses information.
The tab2inv program can generate <cite>SeisComP</cite> inventory files by parsing
´´tab files´´ as described by in the nettab format.</p>
<p>This program can read a set of tab files in the nettab format,
verify their contents and generate inventory for the stations
described in them.</p>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">tab2inv [options] tab-file [more-tab-file]</strong></p>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-h">
<span id="cmdoption-tab2inv-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-h" title="Permalink to this definition"></a></dt>
<dd><p>Prints a small help message and exits.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-f">
<span id="cmdoption-tab2inv-filterf"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--filterf</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-f" title="Permalink to this definition"></a></dt>
<dd><p>Indicate the filter folder. The filter folder is where the program will search for the files indicated by the Ff and If lines.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-x">
<span id="cmdoption-tab2inv-xmlf"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--xmlf</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-x" title="Permalink to this definition"></a></dt>
<dd><p>Indicate a folder containing a set of XML files that contains the SeisComp3 inventory files that will be used to resolve the station groups. Normally this folder is seiscomp/etc/inventory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-D">
<span id="cmdoption-tab2inv-database"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-D" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-force">
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-force" title="Permalink to this definition"></a></dt>
<dd><p>Dont stop on errors of individual files. Try to perform the requested task even if some files contain formatting errors.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-g">
<span id="cmdoption-tab2inv-generate"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--generate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-g" title="Permalink to this definition"></a></dt>
<dd><p>This option instruct the program to generate the XML document in the end of processing. When you dont supply this option the file is just parsed and loaded into objects in the memory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-c">
<span id="cmdoption-tab2inv-check"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-c" title="Permalink to this definition"></a></dt>
<dd><p>Perform some tests after the files can be loaded. The tests include testing that the instruments all can be resolved and has no unused instruments supplied.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-d">
<span id="cmdoption-tab2inv-default"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--default</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-d" title="Permalink to this definition"></a></dt>
<dd><p>Use this option to indicate a default file. A default file is a file containing normally a set of rules for Network (Na), Stations (Sa) and Instruments (Ia) that are applied for every object created before the attributes specified in the file are applied. This option help sto set parameters that you want to be set on all objects.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-o">
<span id="cmdoption-tab2inv-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-o" title="Permalink to this definition"></a></dt>
<dd><p>Use this option to indicate the output filename for the XML file. If not indicated the program will write the output file to STDOUT.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tab2inv-i">
<span id="cmdoption-tab2inv-ip"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ip</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tab2inv-i" title="Permalink to this definition"></a></dt>
<dd><p>Allow prefixing of the instrument (Datalogger or Sensor) name attribute on the inventory generated by a prefix. This option is normally used when you want to convert many networks that share the same instrumentation in different calls of the program. In each call of the program you can supply the network code and year as padding to guarantee that the instruments generated in both runs of the program will have different name values that are used as Key on the SeisComp3 inventory.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">tab2inv</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scinv.html"
title="previous chapter">scinv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="tabinvmodifier.html"
title="next chapter">tabinvmodifier</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/tab2inv.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>

View File

@@ -0,0 +1,266 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>tabinvmodifier &#8212; 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/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Messaging" href="../toc/messaging.html" />
<link rel="prev" title="tab2inv" href="tab2inv.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">6.9.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="../toc/messaging.html" title="Messaging"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="tab2inv.html" title="tab2inv"
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="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/inventory.html" accesskey="U">Inventory</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="tabinvmodifier">
<span id="id1"></span><h1>tabinvmodifier<a class="headerlink" href="#tabinvmodifier" title="Permalink to this heading"></a></h1>
<p><strong>tab-based inventory modifier</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Sometimes small tweaks need to be made to inventory.
The tabinvmodifier program reads a <em>rules file</em> (a network tab file without any station lines) and applies network and station attributes to existing inventory. This method can be used to modify attributes in inventory that originate from dataless SEED or other sources. It can change inventory at the network, station, location, and channel level; it can also change sensor and datalogger attributes (Ia lines).
Currently (2016) changes to station groups (virtual networks) arent supported.</p>
<p>For details of what can go in a tab file, see
<a class="reference external" href="http://www.seiscomp.org/wiki/doc/special/nettabv2">NETTAB File Format Description</a>.</p>
<p>tabinvmodifier can either write directly to the inventory in an SC3 database, or dump its output as an XML file.
If output is as an XML file, typically this would then be moved to ~/seiscomp/etc/inventory, and then loaded into the database with <cite>seiscomp update-config</cite>.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ol class="arabic">
<li><p>Set network-level attributes. Suppose the file <cite>ge.rules</cite> contains</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Nw:<span class="w"> </span>GE<span class="w"> </span><span class="m">1993</span>/001
Na:<span class="w"> </span><span class="nv">Description</span><span class="o">=</span><span class="s2">&quot;GEOFON Program, GFZ Potsdam, Germany&quot;</span>
Na:<span class="w"> </span><span class="nv">Remark</span><span class="o">=</span><span class="s2">&quot;Access to Libyan stations and Spanish HH streams limited&quot;</span>
Na:<span class="w"> </span><span class="nv">Type</span><span class="o">=</span>VBB
</pre></div>
</div>
<p>The first line (Nw:) specifies the network, including its start date, that these rules apply to.
The following lines starting with Na: provide values for the description, remark, and type attributes to be written into the new inventory.
Note the capital letter on the attributes Description, Remark, Type, etc.</p>
<p>We can use this rules file to change attributes of the GE network:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Apply changes to database directly</span>
$<span class="w"> </span>tabinvmodifier<span class="w"> </span>-r<span class="w"> </span>ge.rules
<span class="c1"># Apply changes to XML file</span>
$<span class="w"> </span>tabinvmodifier<span class="w"> </span>-r<span class="w"> </span>ge.rules<span class="w"> </span>--inventory-db<span class="w"> </span>ge.xml<span class="w"> </span>-o<span class="w"> </span>ge-mod.xml
</pre></div>
</div>
<p>The resulting inventory now contains:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;network</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;Network#20130513163612.389203.2&quot;</span><span class="w"> </span><span class="na">code=</span><span class="s">&quot;GE&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;start&gt;</span>1993-01-01T00:00:00.0000Z<span class="nt">&lt;/start&gt;</span>
<span class="w"> </span><span class="nt">&lt;description&gt;</span>GEOFON<span class="w"> </span>Program,<span class="w"> </span>GFZ<span class="w"> </span>Potsdam,<span class="w"> </span>Germany<span class="nt">&lt;/description&gt;</span>
<span class="w"> </span><span class="nt">&lt;institutions&gt;</span>GFZ/partners<span class="nt">&lt;/institutions&gt;</span>
<span class="w"> </span><span class="nt">&lt;region&gt;</span>euromed<span class="w"> </span>global<span class="nt">&lt;/region&gt;</span>
<span class="w"> </span><span class="nt">&lt;type&gt;</span>VBB<span class="nt">&lt;/type&gt;</span>
<span class="w"> </span><span class="nt">&lt;netClass&gt;</span>p<span class="nt">&lt;/netClass&gt;</span>
<span class="w"> </span><span class="nt">&lt;archive&gt;</span>GFZ<span class="nt">&lt;/archive&gt;</span>
<span class="w"> </span><span class="nt">&lt;restricted&gt;</span>false<span class="nt">&lt;/restricted&gt;</span>
<span class="w"> </span><span class="nt">&lt;shared&gt;</span>true<span class="nt">&lt;/shared&gt;</span>
<span class="w"> </span><span class="nt">&lt;remark&gt;</span>access<span class="w"> </span>to<span class="w"> </span>Libyan<span class="w"> </span>stations<span class="w"> </span>and<span class="w"> </span>Spanish<span class="w"> </span>HH<span class="w"> </span>streams<span class="w"> </span>limited<span class="nt">&lt;/remark&gt;</span>
<span class="w"> </span><span class="nt">&lt;station</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;Station#20130620185450.488952.190&quot;</span><span class="w"> </span><span class="na">code=</span><span class="s">&quot;MSBI&quot;</span><span class="w"> </span><span class="na">archiveNetworkCode=</span><span class="s">&quot;GE&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;start&gt;</span>2013-06-16T00:00:00.0000Z<span class="nt">&lt;/start&gt;</span>
</pre></div>
</div>
<p>Other attributes present in inventory are left unchanged.</p>
</li>
<li><p>Changing location codes. (Thanks to Andres H. for this example.)
To replace an empty location code for station “KP.UPNV” with location code “00”, together with its description and place.
The rules file is:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Nw:<span class="w"> </span>KP<span class="w"> </span><span class="m">1980</span>/001
Sa:<span class="w"> </span><span class="nv">Description</span><span class="o">=</span><span class="s2">&quot;GLISN Station Upernavik, Greenland&quot;</span><span class="w"> </span>UPNV
Sa:<span class="w"> </span><span class="nv">Place</span><span class="o">=</span><span class="s2">&quot;Upernavik, Greenland&quot;</span><span class="w"> </span>UPNV
Sa:<span class="w"> </span><span class="nv">Code</span><span class="o">=</span><span class="s2">&quot;00&quot;</span><span class="w"> </span>UPNV,
</pre></div>
</div>
<p>The resulting inventory now contains:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;network</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;Network#20140603153203.17936.2&quot;</span><span class="w"> </span><span class="na">code=</span><span class="s">&quot;KP&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;start&gt;</span>1980-01-01T00:00:00.0000Z<span class="nt">&lt;/start&gt;</span>
<span class="w"> </span>...
<span class="w"> </span><span class="nt">&lt;station</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;Station#20140603153203.179738.3&quot;</span><span class="w"> </span><span class="na">code=</span><span class="s">&quot;UPNV&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;start&gt;</span>2013-08-01T00:00:00.0000Z<span class="nt">&lt;/start&gt;</span>
<span class="w"> </span><span class="nt">&lt;description&gt;</span>GLISN<span class="w"> </span>Station<span class="w"> </span>Upernavik,<span class="w"> </span>Greenland<span class="nt">&lt;/description&gt;</span>
<span class="w"> </span><span class="nt">&lt;latitude&gt;</span>72.7829<span class="nt">&lt;/latitude&gt;</span>
<span class="w"> </span><span class="nt">&lt;longitude&gt;</span>-56.1395<span class="nt">&lt;/longitude&gt;</span>
<span class="w"> </span><span class="nt">&lt;elevation&gt;</span>38<span class="nt">&lt;/elevation&gt;</span>
<span class="w"> </span><span class="nt">&lt;place&gt;</span>Upernavik,<span class="w"> </span>Greenland<span class="nt">&lt;/place&gt;</span>
<span class="w"> </span><span class="nt">&lt;affiliation&gt;</span>GLISN<span class="nt">&lt;/affiliation&gt;</span>
<span class="w"> </span>...
<span class="w"> </span><span class="nt">&lt;sensorLocation</span><span class="w"> </span><span class="na">publicID=</span><span class="s">&quot;SensorLocation#20140603153203.181119.4&quot;</span><span class="w"> </span><span class="na">code=</span><span class="s">&quot;00&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;start&gt;</span>2013-08-01T00:00:00.0000Z<span class="nt">&lt;/start&gt;</span>
<span class="w"> </span>...
<span class="w"> </span><span class="nt">&lt;/station&gt;</span>
<span class="w"> </span><span class="nt">&lt;/network&gt;</span>
</pre></div>
</div>
</li>
</ol>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">tabinvmodifier { -r | --rules } {rules file} [options]</strong></p>
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tabinvmodifier-r">
<span id="cmdoption-tabinvmodifier-rules"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--rules</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tabinvmodifier-r" title="Permalink to this definition"></a></dt>
<dd><p>Input filename of the rules file. A rules file is mandatory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tabinvmodifier-e">
<span id="cmdoption-tabinvmodifier-relaxed"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--relaxed</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tabinvmodifier-e" title="Permalink to this definition"></a></dt>
<dd><p>Relax rules for matching NSLC items</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tabinvmodifier-o">
<span id="cmdoption-tabinvmodifier-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tabinvmodifier-o" title="Permalink to this definition"></a></dt>
<dd><p>Output XML filename. Without an output file, tabinvmodifier will attempt to write to the local SeisComp3 database.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-tabinvmodifier-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tabinvmodifier-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Input file containing inventory. If this option is given, an output file must be provided with <cite>--output</cite>.</p>
</dd></dl>
</section>
</section>
</section>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">tabinvmodifier</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="tab2inv.html"
title="previous chapter">tab2inv</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="../toc/messaging.html"
title="next chapter">Messaging</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/tabinvmodifier.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>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>