SCRUG-NA/2025
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[installation] Change to nightly

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
share/doc/seiscomp/html/apps/screloc.html
View File

@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>screloc &#8212; SeisComP Release documentation</title>
<title>screloc &#8212; SeisComP Development 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" />
@ -12,7 +12,7 @@
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=744d344a"></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" />
@ -25,8 +25,8 @@
<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>
<!-- span class="title">SeisComP Development</span -->
<span class="version">7.0.0</span>
</div>
</div>
</div>
@ -164,24 +164,35 @@ NonLinLoc.profile.global.controlFile<span class="w"> </span><span class="o">=</s
<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>
<li><p>Relocate all origins given in an <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> file according to the
configuration of <strong class="program">screloc</strong>. Write all output to unformatted SCML.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>screloc<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--ep<span class="w"> </span>origins.xml<span class="w"> </span>&gt;<span class="w"> </span>origins_screloc.xml
</pre></div>
</div>
</li>
<li><p>Relocate the previously preferred origins of all events (<a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a>)
within some period of time using a specific <a class="reference internal" href="../base/concepts/locators.html#concepts-locators"><span class="std std-ref">locator</span></a>
and locator profile.
Use some userID and authorID for uniquely recognizing the relocation.
Configuring the ref:<cite>scevent</cite> parameter <a class="reference internal" href="scevent.html#confval-eventAssociation.priorities"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.priorities</span></code></a>
to TIME_AUTOMATIC before running the example will prefer the latest origin
(which will be created by screloc) for the event the new origin is associated
to. The new origins are automatically sent to the messaging.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</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="c1"># locator type</span>
<span class="nv">locator</span><span class="o">=[</span>your_locator<span class="o">]</span>
<span class="c1"># locator profile</span>
<span class="nv">profile</span><span class="o">=[</span>your_profile<span class="o">]</span>
<span class="c1"># set some userID</span>
<span class="nv">userID</span><span class="o">=[</span>your_user<span class="o">]</span>
<span class="c1"># set some authorID</span>
<span class="nv">authorID</span><span class="o">=[</span>screloc<span class="o">]</span>
<span class="nv">IFS</span><span class="o">=</span><span class="s1">&#39;,&#39;</span><span class="w"> </span><span class="nb">read</span><span class="w"> </span>-ra<span class="w"> </span>events<span class="w"> </span><span class="o">&lt;&lt;&lt;</span><span class="w"> </span><span class="sb">`</span>scevtls<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-p<span class="w"> </span>-D<span class="w"> </span>,<span class="w"> </span>--begin<span class="w"> </span><span class="m">2025</span>-01-01<span class="w"> </span>--end<span class="w"> </span><span class="m">2025</span>-02-01<span class="sb">`</span>
<span class="k">for</span><span class="w"> </span>event<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">events</span><span class="p">[@]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">;</span><span class="w"> </span><span class="k">do</span>
<span class="w"> </span><span class="nv">preferredOrigin</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span><span class="w"> </span><span class="nv">$event</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>awk<span class="w"> </span><span class="s1">&#39;{print $2}&#39;</span><span class="k">)</span>
<span class="w"> </span>screloc<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-O<span class="w"> </span><span class="nv">$preferredOrigin</span><span class="w"> </span>--locator<span class="w"> </span><span class="nv">$locator</span><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>--author<span class="o">=</span><span class="nv">$authorID</span>
<span class="k">done</span>
</pre></div>
</div>
@ -293,6 +304,25 @@ However, new publicIDs are unrelated to the time of creation.
If not defined, a new publicID will be generated automatically.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>picks.*</strong>
<em>Parameters specific to picks.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-picks.streamsSetUnused">
<span class="sig-name descname"><span class="pre">picks.streamsSetUnused</span></span><a class="headerlink" href="#confval-picks.streamsSetUnused" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of streams from which picks are set to unsed by their
referencing arrivals before locating. The concerned arrivals
are kept but the picks will not be used for locating.
Streams take the format NET.STA.LOC.CHA. Wildcards * and ?
are supported.</p>
<p>Example:</p>
<p>GE.MOX.*.HH? : All arrivals on any HH stream of station MOX
will be kept but not used for locating.</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>
@ -459,12 +489,14 @@ This option can be given more than once.</p>
<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>
<p>Default: <code class="docutils literal notranslate"><span class="pre">binary</span></code></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><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
@ -507,46 +539,65 @@ can be queried with &quot;--db-driver-list&quot;.</p>
</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-dump">
<span class="sig-name descname"><span class="pre">--dump</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-dump" title="Permalink to this definition"></a></dt>
<dd><p>Dump processed origins as XML to stdout. Use in combination
with -O.</p>
</dd></dl>
<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><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><p>Overrides configuration parameter <a class="reference internal" href="#confval-reloc.locator"><code class="xref std std-confval docutils literal notranslate"><span class="pre">reloc.locator</span></code></a>.</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>
<dt class="sig sig-object std" id="cmdoption-screloc-profile">
<span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-profile" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-reloc.profile"><code class="xref std std-confval docutils literal notranslate"><span class="pre">reloc.profile</span></code></a>.</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>
<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-screloc-ep" title="Permalink to this definition"></a></dt>
<dd><p>Event parameters XML file for offline processing of all
contained origins. This option should not be mixed with
--dump.</p>
</dd></dl>
<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-use-weight">
<span class="sig-name descname"><span class="pre">--use-weight</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-use-weight" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-reloc.useWeight"><code class="xref std std-confval docutils literal notranslate"><span class="pre">reloc.useWeight</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-streams-set-unused">
<span class="sig-name descname"><span class="pre">--streams-set-unused</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-screloc-streams-set-unused" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-picks.streamsSetUnused"><code class="xref std std-confval docutils literal notranslate"><span class="pre">picks.streamsSetUnused</span></code></a>.</p>
<p>Type: <em>list:string</em></p>
<p>List of streams from which picks are set to unsed by their
referencing arrivals before locating. The concerned arrivals
are kept but the picks will not be used for locating.
Streams take the format NET.STA.LOC.CHA. Wildcards * and ?
are supported.</p>
</dd></dl>
<dl class="std option">
@ -558,6 +609,28 @@ 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="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-screloc-evaluation-mode">
<span class="sig-name descname"><span class="pre">--evaluation-mode</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-evaluation-mode" title="Permalink to this definition"></a></dt>
<dd><p>Evaluation mode of the new origin (AUTOMATIC or MANUAL).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-f">
<span id="cmdoption-screloc-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-screloc-f" title="Permalink to this definition"></a></dt>
<dd><p>Use formatted XML output. Otherwise XML is unformatted.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-screloc-origin-id-suffix">
<span class="sig-name descname"><span class="pre">--origin-id-suffix</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-screloc-origin-id-suffix" title="Permalink to this definition"></a></dt>
<dd><p>Create origin ID from that of the input origin plus the
specfied suffix.</p>
</dd></dl>
</section>
<section id="profiling">
<h3>Profiling<a class="headerlink" href="#profiling" title="Permalink to this heading"></a></h3>
@ -570,7 +643,9 @@ NonLinLoc origins out. All other objects are passed through.</p>
<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><p>Improve measurement of relocation time by running each
relocation multiple times. Specify the number of relocations,
e.g. 100.</p>
</dd></dl>
</section>
@ -609,6 +684,7 @@ NonLinLoc origins out. All other objects are passed through.</p>
<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="#output">Output</a></li>
<li><a class="reference internal" href="#profiling">Profiling</a></li>
</ul>
</li>
@ -646,7 +722,7 @@ NonLinLoc origins out. All other objects are passed through.</p>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>6.9.0</b> Release
Version <b>7.0.0</b> Development
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.