[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,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>