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

110
share/doc/seiscomp/html/apps/invextr.html
View File

@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>invextr &#8212; SeisComP Release documentation</title>
<title>invextr &#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,21 +12,21 @@
<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" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scinv" href="scinv.html" />
<link rel="prev" title="inv2dlsv" href="inv2dlsv.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>
<!-- span class="title">SeisComP Development</span -->
<span class="version">7.0.0</span>
</div>
</div>
</div>
@ -49,7 +49,7 @@
</a>
</li>
<li class="right">
<a href="inv2dlsv.html" title="inv2dlsv"
<a href="import_inv.html" title="import_inv"
accesskey="P">
previous
</a>
@ -74,41 +74,49 @@
<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>
<p><strong>Extract and clean or remove streams 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>
<li><p>Extract or remove networks, stations, sensor locations and channels based on</p>
<ul class="simple">
<li><p>stream 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>
<li><p>Clean inventories from unreferenced objects such as data loggers, sensors or
instrument responses when extracting.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Cleaning inventory may also be achieved by merging inventories with
<a class="reference internal" href="scinv.html#scinv"><span class="std std-ref">scinv</span></a>.</p>
</div>
</li>
</ul>
<p>The important parameters are:</p>
<ul class="simple">
<li><p>Channel ID list (required)</p></li>
<li><p>Stream ID list (<code class="xref std std-option docutils literal notranslate"><span class="pre">--chans</span></code>, <code class="xref std std-option docutils literal notranslate"><span class="pre">--nslc</span></code>). Without a stream ID,
only unreferenced objects are removed when extracting.</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>
<li><p>Output file (<code class="xref std std-option docutils literal notranslate"><span class="pre">--output</span></code>) or stdout</p></li>
<li><p>Region bounding box (<code class="xref std std-option docutils literal notranslate"><span class="pre">--region</span></code>, optional)</p></li>
</ul>
<p>whereas the output file defaults to stdout and the input file to
<p>where the output XML 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
<p>A stream ID is a simple string that is matched against the final stream ID
in the inventory. This final stream 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>
<p>Suppose an inventory with network GE, a station MORC with one sensor locations
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>__
@ -121,15 +129,21 @@ channel.</p>
</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
<li><p>Just clean inventory from unreferenced objects such as data loggers, sensors
or instrument responses.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>invextr<span class="w"> </span>inventory.xml<span class="w"> </span>-o<span class="w"> </span>inventory-cleaned.xml
</pre></div>
</div>
</li>
<li><p>The IDs are matched against streams passed with <code class="xref std std-option docutils literal notranslate"><span class="pre">--chans</span></code>:</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>inventory.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
<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>inventory.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.
@ -137,29 +151,28 @@ region<span class="w"> </span>bounding<span class="w"> </span>box.
</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
<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>inventory.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
<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>inventory.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
<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>inventory.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
<li><p>To extract BHN and LHZ, 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;*BHN,*LHZ&quot;</span><span class="w"> </span>inventory.xml
</pre></div>
</div>
<ul>
</li>
<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
<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>inventory.xml
</pre></div>
</div>
</li>
@ -316,10 +329,14 @@ that time will be ignored.</p>
<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><p>A comma separated list of streams to extract or remove (--rm)
which can contain wildcards. Avoiding confusion with files
names due to SHELL extension requires to enclose stream codes
by quotes. Default: *.*.*.* meaning all streams. Unreferenced
sensors, data loggers and resonses are removed when extracting.
A comma separated list of channel IDs to extract which may
contain wildcards. Default: *.*.*.* meaning all streams.</p>
<p>Example: invextr --chans &quot;GE.*.*.BHZ,GE.MORC.*.*&quot; inventory.xml</p>
</dd></dl>
<dl class="std option">
@ -333,7 +350,7 @@ Wildcards can be used. --chans is ignored.</p>
<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>
&quot;South,West,North,East&quot;. Region is unused by default.</p>
</dd></dl>
<dl class="std option">
@ -344,10 +361,20 @@ extracting them.</p>
<p>Example: invextr --rm --chans &quot;GE.*&quot; inv.xml</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-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><p>Enable formatted XML output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-invextr-o">
<span id="cmdoption-invextr-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-invextr-o" title="Permalink to this definition"></a></dt>
<dd><p>Name of output file. If not given or ‘-’, output is sent to
stdout.</p>
</dd></dl>
</section>
@ -384,6 +411,7 @@ extracting them.</p>
<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>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
@ -393,8 +421,8 @@ extracting them.</p>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="inv2dlsv.html"
title="previous chapter">inv2dlsv</a></p>
<p class="topless"><a href="import_inv.html"
title="previous chapter">import_inv</a></p>
</div>
<div>
<h4>Next topic</h4>
@ -420,7 +448,7 @@ extracting them.</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.