[installation] Init with inital config for global
This commit is contained in:
459
share/doc/caps/html/apps/capstool.html
Normal file
459
share/doc/caps/html/apps/capstool.html
Normal file
@ -0,0 +1,459 @@
|
||||
<!doctype html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>capstool — CAPS: Common Acquisition Protocol Server documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||||
<script type="text/javascript" src="../_static/gempa.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=b3ba4146"></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" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="container">
|
||||
<img class="background" src="../_static/icon.png"/>
|
||||
<div class="content">
|
||||
<span class="title">CAPS: Common Acquisition Protocol Server </span>
|
||||
<span class="version">2025.254#f0c77b29e</span></h1>
|
||||
</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="nav-item nav-item-0">
|
||||
<a href="../index.html">Home</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="capstool">
|
||||
<span id="id1"></span><h1>capstool<a class="headerlink" href="#capstool" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>CAPS command-line interface (CLI) client.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p>capstool is a CAPS client application for retrieving data and listing available
|
||||
streams from an operational CAPS server.</p>
|
||||
</section>
|
||||
<section id="applications">
|
||||
<h2>Applications<a class="headerlink" href="#applications" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Connectivity test to a CAPS server (<a class="reference internal" href="caps.html#cmdoption-P"><code class="xref std std-option docutils literal notranslate"><span class="pre">-P</span></code></a>).</p></li>
|
||||
<li><p>Request of available streams (<a class="reference internal" href="#cmdoption-Q"><code class="xref std std-option docutils literal notranslate"><span class="pre">-Q</span></code></a>, <a class="reference internal" href="caps2caps.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate"><span class="pre">-I</span></code></a>). The result set may
|
||||
vary depending on the client’s IP address or the user name used for the
|
||||
connection.</p></li>
|
||||
<li><p>Data retrieval to stdout or individual files (<a class="reference internal" href="capssds.html#cmdoption-o"><code class="xref std std-option docutils literal notranslate"><span class="pre">-o</span></code></a>). Data may be
|
||||
requested in order of sampling time or time of arrival (<a class="reference internal" href="#cmdoption-ooo"><code class="xref std std-option docutils literal notranslate"><span class="pre">--ooo</span></code></a>). It may
|
||||
also be retrieved downsampled to 1Hz (<a class="reference internal" href="#cmdoption-D"><code class="xref std std-option docutils literal notranslate"><span class="pre">--heli</span></code></a>).</p></li>
|
||||
<li><p>Data quality control by listing gaps (<a class="reference internal" href="#cmdoption-G"><code class="xref std std-option docutils literal notranslate"><span class="pre">-G</span></code></a>), continous data segments
|
||||
(<a class="reference internal" href="#cmdoption-S"><code class="xref std std-option docutils literal notranslate"><span class="pre">-S</span></code></a>) or record arrival times (<a class="reference internal" href="#cmdoption-M"><code class="xref std std-option docutils literal notranslate"><span class="pre">-M</span></code></a>).</p></li>
|
||||
<li><p>Data cleanup on the server side (<a class="reference internal" href="#cmdoption-purge"><code class="xref std std-option docutils literal notranslate"><span class="pre">--purge</span></code></a>).</p></li>
|
||||
<li><p>Retrieval of server statistics (<a class="reference internal" href="#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span></code></a>).</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="input">
|
||||
<h2>Input<a class="headerlink" href="#input" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The program reads requests from file or from standard input if no file is specified.
|
||||
The request format is defined as follows:</p>
|
||||
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>YYYY,MM,DD,HH,MM,SS YYYY,MM,DD,HH,MM,SS Network Station [Location] Channel
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Each request line contains a start and an end time followed by a stream id. The
|
||||
fields Network, Station, Channel and Location support wild cards (*). The latter
|
||||
one is optional. For matching all locations please use the ‘*’ symbol, if empty
|
||||
it assumes that only empty locations are being requested.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The request lines can be generated for a particular event using
|
||||
<span id="id2"><em>scevtstreams</em> [<a class="reference internal" href="../base/references.html#id256" title="scevtstreams. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scevtstreams.html.">15</a>]</span> as of the SeisComP3 release Jakarta-2018.xxx.</p>
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>2010,02,18,12,00,00 2010,02,18,12,10,00 GE WLF BH*
|
||||
2010,02,18,12,00,00 2010,02,18,12,10,00 GE VSU 00 BH*
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="output">
|
||||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The output format differs by record type. Below is an overview of the available
|
||||
formats.</p>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 50.0%" />
|
||||
<col style="width: 50.0%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Record type</p></th>
|
||||
<th class="head"><p>Output data format</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>RAW</p></td>
|
||||
<td><p>ASCII SLIST</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>MSEED</p></td>
|
||||
<td><p>MSEED</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>ANY</p></td>
|
||||
<td><p>Stored data format</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>When retrieving miniSEED data the records are not necessarily sorted by time.
|
||||
However, sorting by time is required, e.g., for processing in playbacks.
|
||||
Use <span id="id3"><em>scmssort</em> [<a class="reference internal" href="../base/references.html#id266" title="scmssort. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scmssort.html.">16</a>]</span> for sorting the records by time. Example:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmssort<span class="w"> </span>-E<span class="w"> </span>-u<span class="w"> </span>data.mseed<span class="w"> </span>><span class="w"> </span>data_sorted.mseed
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<ul>
|
||||
<li><p><strong>List available streams:</strong></p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>capstool<span class="w"> </span>-H<span class="w"> </span>localhost:18002<span class="w"> </span>-Q
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><strong>Secured connection:</strong></p>
|
||||
<p>Connect via Secure Sockets Layer (SSL) and supply credentials for
|
||||
authentication.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>capstool<span class="w"> </span>-H<span class="w"> </span>localhost:18002<span class="w"> </span>-s<span class="w"> </span>-c<span class="w"> </span>user:password<span class="w"> </span>-Q
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><strong>Time-based request without request file:</strong></p>
|
||||
<p>Request file to load miniSEED data for some GE stations:</p>
|
||||
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>2010,02,18,12,00,00 2010,02,18,12,10,00 GE WLF BH*
|
||||
2010,02,18,12,00,00 2010,02,18,12,10,00 GE VSU BH*
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Submit the request in <code class="file docutils literal notranslate"><span class="pre">req.txt</span></code> to the CAPS server, and download miniSEED
|
||||
data to the file <code class="file docutils literal notranslate"><span class="pre">data.mseed</span></code>.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>capstool<span class="w"> </span>-H<span class="w"> </span>localhost:18002<span class="w"> </span>-o<span class="w"> </span>data.mseed<span class="w"> </span>req.txt
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><strong>Time-based request without request file:</strong></p>
|
||||
<p>Request miniSEED data from a CAPS server. Provide request parameters from
|
||||
standard input. Write the miniSEED data to standard output. Re-direct the
|
||||
output and append it to a file, e.g., <code class="file docutils literal notranslate"><span class="pre">data.mseed</span></code>:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s2">"2015,11,08,10,47,00 2015,11,08,11,00,00 * * BH?"</span><span class="w"> </span><span class="p">|</span><span class="se">\</span>
|
||||
capstool<span class="w"> </span>-H<span class="w"> </span>localhost:18002<span class="w"> </span>>><span class="w"> </span>data.mseed
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><strong>Event-based request:</strong></p>
|
||||
<p>Request miniSEED data from a CAPS server for a particular event with ID <eventID>.
|
||||
Provide the request file using <span id="id4"><em>scevtstreams</em> [<a class="reference internal" href="../base/references.html#id256" title="scevtstreams. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scevtstreams.html.">15</a>]</span>. Write the miniSEED data
|
||||
to standard output. Re-direct the output to a file, e.g., <code class="file docutils literal notranslate"><span class="pre"><eventID>.mseed</span></code>.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scevtstreams<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>-E<span class="w"> </span><eventID><span class="w"> </span>--caps<span class="w"> </span>><span class="w"> </span>req.txt
|
||||
capstool<span class="w"> </span>-H<span class="w"> </span>localhost:18002<span class="w"> </span>req.txt<span class="w"> </span>><span class="w"> </span><eventID>.mseed
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><strong>Video data:</strong></p>
|
||||
<p>Request to load video data from Station HILO. Request file:</p>
|
||||
<div class="highlight-params notranslate"><div class="highlight"><pre><span></span>2013,08,01,00,00,00 2013,08,01,00,30,00 VZ HILO WLS CAM
|
||||
2013,08,01,00,00,00 2013,08,01,00,30,00 VZ HILO WLS CAM
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Submit the request in <code class="file docutils literal notranslate"><span class="pre">req.txt</span></code> to the CAPS server, and download the video data
|
||||
to files using the given pattern:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>capstool<span class="w"> </span>-H<span class="w"> </span>localhost:18002<span class="w"> </span>-o<span class="w"> </span><span class="s2">"%H%M%S.%f"</span><span class="w"> </span>req.txt
|
||||
</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">capstool [options]</strong></p>
|
||||
<section id="options">
|
||||
<span id="id5"></span><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-h">
|
||||
<span id="cmdoption-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-h" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show a help message and exit.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-H">
|
||||
<span id="cmdoption-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">HOST[:PORT]</span></span><a class="headerlink" href="#cmdoption-H" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">localhost:18002</span></code></p>
|
||||
<p>Host and optionally port of the CAPS server (default is localhost:18002).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-s">
|
||||
<span id="cmdoption-ssl"></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">--ssl</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use secure socket layer (SSL).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-c">
|
||||
<span id="cmdoption-credentials"></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">--credentials</span></span><span class="sig-prename descclassname"> <span class="pre">USER[:PASSWORD]</span></span><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Authentication credentials. If the password is omitted, it is asked for on command-line.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-P">
|
||||
<span id="cmdoption-ping"></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">--ping</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-P" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve server version information and exit.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-Q">
|
||||
<span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-Q" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print availability extents of all data streams.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-I">
|
||||
<span id="cmdoption-info-streams"></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">--info-streams</span></span><span class="sig-prename descclassname"> <span class="pre">FILTER</span></span><a class="headerlink" href="#cmdoption-I" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Like -Q but with a use a regular filter expression for the requested streams, e.g., AM.*.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-filter-list">
|
||||
<span class="sig-name descname"><span class="pre">--filter-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-filter-list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Identical to -I.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-mtime">
|
||||
<span class="sig-name descname"><span class="pre">--mtime</span></span><span class="sig-prename descclassname"> <span class="pre">[start]:[end]</span></span><a class="headerlink" href="#cmdoption-mtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Restrict request to record modification time window. Time format:
|
||||
%Y,%m,%d[,%H[,%M[,%S[,%f]]]]</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-X">
|
||||
<span id="cmdoption-info-server"></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">--info-server</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-X" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request server statistics in JSON format.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-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-modified-after" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Limit server statistics request to data modified after specific time. Time format:
|
||||
%Y,%m,%d[,%H[,%M[,%S[,%f]]]]</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-force">
|
||||
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-force" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Disable any confirmation prompts.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="options-request-file-no-data-download">
|
||||
<span id="id6"></span><h3>Options (request file, no data download)<a class="headerlink" href="#options-request-file-no-data-download" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-G">
|
||||
<span id="cmdoption-print-gaps"></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">--print-gaps</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-G" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request list of data gaps.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-S">
|
||||
<span id="cmdoption-print-segments"></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">--print-segments</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-S" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request list of continuous data segments.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-tolerance">
|
||||
<span class="sig-name descname"><span class="pre">--tolerance</span></span><span class="sig-prename descclassname"> <span class="pre">SECONDS</span></span><a class="headerlink" href="#cmdoption-tolerance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Threshold in seconds defining a data gap (decimal point, microsecond precision).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-R">
|
||||
<span id="cmdoption-Resolution"></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">--Resolution</span></span><span class="sig-prename descclassname"> <span class="pre">DAYS</span></span><a class="headerlink" href="#cmdoption-R" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>The resolution in multiple of days of the returned data segments or gaps. A value of 0 returns
|
||||
segments based on stored data records. A value larger than zero will return the minimum and
|
||||
maximum data time of one, two or more days. Consecutive segments will be merged if end and start
|
||||
time are within the tolerance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-print-stat">
|
||||
<span class="sig-name descname"><span class="pre">--print-stat</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-print-stat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request storage information with a granularity of one day.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-purge">
|
||||
<span class="sig-name descname"><span class="pre">--purge</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-purge" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes data from CAPS archive with a granularity of one
|
||||
day. Any data file intersecting with the time window
|
||||
will be purged. The user requires the purge permission.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="options-request-file-and-data-download">
|
||||
<span id="id7"></span><h3>Options (request file and data download)<a class="headerlink" href="#options-request-file-and-data-download" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-o">
|
||||
<span id="cmdoption-output-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">--output-file</span></span><span class="sig-prename descclassname"> <span class="pre">FILE</span></span><a class="headerlink" href="#cmdoption-o" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Output file for received data (default: -). The file name is used as a prefix with the
|
||||
extension added based on the record type (MSEED, RAW, ANY, META, HELI). Multiple files are
|
||||
created if mixed data types are received. For ‘ANY’ records the file name may contain the
|
||||
following format controls: %Y - year, %j - day of year, %H - hour, %M - minute, %S - second, %F
|
||||
- format.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-any-date-format">
|
||||
<span class="sig-name descname"><span class="pre">--any-date-format</span></span><span class="sig-prename descclassname"> <span class="pre">FORMAT</span></span><a class="headerlink" href="#cmdoption-any-date-format" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">%Y%m%d_%H%M%S</span></code></p>
|
||||
<p>Date format to use for any files, see ‘man strftime’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-t">
|
||||
<span id="cmdoption-temp-file"></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">--temp-file</span></span><span class="sig-prename descclassname"> <span class="pre">FILE</span></span><a class="headerlink" href="#cmdoption-t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use temporary file to store data. On success move to output-file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-rt">
|
||||
<span class="sig-name descname"><span class="pre">--rt</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-rt" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable real time mode.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-ooo">
|
||||
<span class="sig-name descname"><span class="pre">--ooo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ooo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request data in order of transmission time instead of sampling time.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-out-of-order">
|
||||
<span class="sig-name descname"><span class="pre">--out-of-order</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-out-of-order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Identical to --ooo.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-D">
|
||||
<span id="cmdoption-heli"></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">--heli</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-D" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request down-sampled data (1Hz). The server will taper, bandpass filter and re-sample the data.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-itaper">
|
||||
<span class="sig-name descname"><span class="pre">--itaper</span></span><span class="sig-prename descclassname"> <span class="pre">SECONDS</span></span><a class="headerlink" href="#cmdoption-itaper" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Timespan in SECONDS for the one-sided cosine taper.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-bandpass">
|
||||
<span class="sig-name descname"><span class="pre">--bandpass</span></span><span class="sig-prename descclassname"> <span class="pre">RANGE</span></span><a class="headerlink" href="#cmdoption-bandpass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Corner frequency RANGE of the bandpass filter, e.g., 1.0:4.0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-M">
|
||||
<span id="cmdoption-meta"></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">--meta</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-M" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request record meta data only.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-v">
|
||||
<span id="cmdoption-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 class="pre">VERSION</span></span><a class="headerlink" href="#cmdoption-v" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Request a specific format version. Currently only supported in meta requests.</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="#">capstool</a><ul>
|
||||
<li><a class="reference internal" href="#description">Description</a></li>
|
||||
<li><a class="reference internal" href="#applications">Applications</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="#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>
|
||||
<li><a class="reference internal" href="#options-request-file-no-data-download">Options (request file, no data download)</a></li>
|
||||
<li><a class="reference internal" href="#options-request-file-and-data-download">Options (request file and data download)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/capstool.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
Release <b></b> version <b>2025.254#f0c77b29e</b>
|
||||
<div class="copyright">
|
||||
© Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user