[installation] Init with inital config for global
This commit is contained in:
481
share/doc/caps/html/base/data-retrieval.html
Normal file
481
share/doc/caps/html/base/data-retrieval.html
Normal file
@ -0,0 +1,481 @@
|
||||
<!doctype html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>Access Data on a CAPS Server — 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" />
|
||||
<link rel="next" title="Examples and Recipes" href="examples.html" />
|
||||
<link rel="prev" title="win2caps" href="../apps/win2caps.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="right">
|
||||
<a href="examples.html" title="Examples and Recipes"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="../apps/win2caps.html" title="win2caps"
|
||||
accesskey="P">
|
||||
previous
|
||||
</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="access-data-on-a-caps-server">
|
||||
<span id="sec-caps-retrieval"></span><h1>Access Data on a CAPS Server<a class="headerlink" href="#access-data-on-a-caps-server" title="Permalink to this heading">¶</a></h1>
|
||||
<p>A range of tools is available to access data and information on a CAPS server.</p>
|
||||
<table class="docutils align-default">
|
||||
<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>Name</p></th>
|
||||
<th class="head"><p>SW Package</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#sec-caps-capstool"><span class="std std-ref">capstool</span></a></p></td>
|
||||
<td><p>caps-tools</p></td>
|
||||
<td><p>A command-line tool for retrieving data and meta information from a CAPS server</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#sec-caps-file"><span class="std std-ref">rifftool</span></a></p></td>
|
||||
<td><p>caps-tools</p></td>
|
||||
<td><p>A command-line tool for data inspection and extraction from individual CAPS data files (RIFF), e.g., in a CAPS archive</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#sec-caps-file"><span class="std std-ref">capssds</span></a></p></td>
|
||||
<td><p>caps-tools</p></td>
|
||||
<td><p>A virtual overlay file system presenting a CAPS archive directory as a read-only SDS archive with no extra disk space requirement.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#sec-caps-seedlink"><span class="std std-ref">caps_plugin</span></a></p></td>
|
||||
<td><p>seiscomp</p></td>
|
||||
<td><p>The plugin fetches miniSEED and <a class="reference internal" href="archive.html#sec-pt-raw"><span class="std std-ref">RAW</span></a> data from a CAPS server and provides the data to <strong class="program">seedlink</strong></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#sec-caps-recstream"><span class="std std-ref">caps / capss</span></a></p></td>
|
||||
<td><p>seiscomp</p></td>
|
||||
<td><p>The RecordStream implementations for <cite>CAPS</cite></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#sec-caps2caps"><span class="std std-ref">cap2caps</span></a></p></td>
|
||||
<td><p>caps-plugins</p></td>
|
||||
<td><p>Automatic or interactive synchronization of two CAPS servers</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#sec-caps-web"><span class="std std-ref">web interface</span></a></p></td>
|
||||
<td><p>caps-server</p></td>
|
||||
<td><p>The web interface provided by the CAPS server</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#sec-caps-fdsnws"><span class="std std-ref">FDSNWS</span></a></p></td>
|
||||
<td><p>caps-server</p></td>
|
||||
<td><p>FDSNWS dataselect interface provided by the CAPS server</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#sec-caps-wws"><span class="std std-ref">WWS</span></a></p></td>
|
||||
<td><p>caps-server</p></td>
|
||||
<td><p>Winston Waveform Server interface provided by the CAPS server</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#sec-caps-dataavailability"><span class="std std-ref">scardac</span></a></p></td>
|
||||
<td><p>seiscomp</p></td>
|
||||
<td><p>A command-line tool for generating availability information from CAPS archive</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="recordstream-caps-capss">
|
||||
<span id="sec-caps-recstream"></span><h2>RecordStream: caps/capss<a class="headerlink" href="#recordstream-caps-capss" title="Permalink to this heading">¶</a></h2>
|
||||
<p><cite>SeisComP</cite> applications access waveform data through the
|
||||
<a class="reference internal" href="glossary.html#term-RecordStream"><span class="xref std std-term">RecordStream</span></a> interface.
|
||||
To fetch data from a CAPS server specific RecordStream implementations may be used:</p>
|
||||
<ul class="simple">
|
||||
<li><p><em>caps</em>: regular RecordStream implementation to access the CAPS server,</p></li>
|
||||
<li><p><em>capss</em>: RecordStream implementation to access the CAPS server secured by SSL,
|
||||
user name and password. Similar to <em>https</em>, <em>capss</em> will establish a Secure Socket
|
||||
Layer (SSL) communication.</p></li>
|
||||
</ul>
|
||||
<section id="configuration">
|
||||
<span id="sec-caps-rs-config"></span><h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading">¶</a></h3>
|
||||
<p>In order to make use of the <em>caps</em> or the <em>capss</em> RecordStream configure the
|
||||
RecordStream URL in <a class="reference internal" href="../apps/global.html#confval-recordstream"><code class="xref std std-confval docutils literal notranslate"><span class="pre">recordstream</span></code></a>. Let it point to the CAPS server
|
||||
providing the data. Examples for <em>caps</em> and <em>capss</em>:</p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">recordstream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">caps://server:18002</span>
|
||||
<span class="na">recordstream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">capss://foo:bar@server:18022</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><a class="reference internal" href="#sec-caps-opt-params"><span class="std std-ref">Optional parameters</span></a> are available for
|
||||
<em>caps</em>/<em>capss</em>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>While the <em>caps</em>/<em>capss</em> <a class="reference internal" href="glossary.html#term-RecordStream"><span class="xref std std-term">RecordStream</span></a> provides data in real time
|
||||
and from archive, some modules, e.g., <span id="id1"><em>scart</em> [<a class="reference internal" href="references.html#id241" title="scart. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scart.html.">14</a>]</span>, <span id="id2"><em>fdsnws</em> [<a class="reference internal" href="references.html#id139" title="fdsnws. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/fdsnws.html.">11</a>]</span> or
|
||||
<span id="id3"><em>GIS</em> [<a class="reference internal" href="references.html#id152" title="GIS. gempa Image Server. URL: https://docs.gempa.de/gis/current/index.html.">5</a>]</span> should be strictly limited to reading from archive only by
|
||||
the option <code class="docutils literal notranslate"><span class="pre">arch</span></code>:</p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">recordstream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">caps://server:18002?arch</span>
|
||||
<span class="na">recordstream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">capss://foo:bar@server:18022?arch</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Otherwise requests attempting to fetch missing data may hang forever.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="optional-parameters">
|
||||
<span id="sec-caps-opt-params"></span><h3>Optional Parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Optional RecordStream parameters which can be combined:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">arch</span></code> - read from CAPS archive only,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">ooo</span></code> - out of order, data are fetched and provided in the order of their arrival in the CAPS server, useful for analysing if data have arrived out of order,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pass</span></code> - password if server requires authentication,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">request-file</span></code> - file specifying the streams to be requested. One stream per line. Per line: net sta loc stream startTime endTime,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">timeout</span></code> - timeout of acquisition in seconds. Data acquisition will be restarted,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">user</span></code> - user name if server requires authentication.</p></li>
|
||||
</ul>
|
||||
<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>caps://server:18002?arch</p></td>
|
||||
<td><p>Read data from CAPS archive. Stop data acquisition when all available waveforms are fetched.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>caps://server:18002?ooo</p></td>
|
||||
<td><p>Fetch data in the original order of arrival.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>caps://server:18002?request-file=request.txt</p></td>
|
||||
<td><p>Request only streams in time intervals given in request.txt</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>caps://server:18002?timeout=5</p></td>
|
||||
<td><p>Apply a timeout of 5 seconds.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>capss://server:18022?user=foo&pass=bar</p></td>
|
||||
<td><p>Use secure protocol (SSL) with user
|
||||
name and password. Read the section on <a class="reference internal" href="configuration.html#sec-conf-access-auth"><span class="std std-ref">Authentication by user name and password (shadow file)</span></a> for details
|
||||
on the generation of user names and passwords.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="combination-with-other-recordstream-interfaces">
|
||||
<h3>Combination with other RecordStream interfaces<a class="headerlink" href="#combination-with-other-recordstream-interfaces" title="Permalink to this heading">¶</a></h3>
|
||||
<p>The caps and the capss RecordStream may be combined with other
|
||||
<a class="reference internal" href="glossary.html#term-RecordStream"><span class="xref std std-term">RecordStream</span></a> interfaces.</p>
|
||||
<p>Examples:</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Decimation</p>
|
||||
<p>Use the decimation <a class="reference internal" href="glossary.html#term-RecordStream"><span class="xref std std-term">RecordStream</span></a> <span id="id4">[<a class="reference internal" href="references.html#id225" title="RecordStream. SeisComP interface. URL: https://docs.gempa.de/seiscomp/current/apps/global_recordstream.html.">6</a>]</span>
|
||||
interface to fetch data from a CAPS server running on localhost decimated to
|
||||
1 sample per second.</p>
|
||||
<p><em>global configuration:</em></p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">recordstream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dec://caps/localhost:18002?rate<span class="o">=</span><span class="m">1</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><em>command line parameter:</em></p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>-I<span class="w"> </span>dec://caps/localhost:18002?rate<span class="o">=</span><span class="m">1</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Resample</p>
|
||||
<p>Use the resample <a class="reference internal" href="glossary.html#term-RecordStream"><span class="xref std std-term">RecordStream</span></a> <span id="id5">[<a class="reference internal" href="references.html#id225" title="RecordStream. SeisComP interface. URL: https://docs.gempa.de/seiscomp/current/apps/global_recordstream.html.">6</a>]</span>
|
||||
interface to fetch data from a CAPS server running on localhost resampled to
|
||||
16 samples per second.</p>
|
||||
<p><em>global configuration:</em></p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">recordstream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>resample://caps/localhost:18002?rate<span class="o">=</span><span class="m">16</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><em>command line parameter:</em></p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>-I<span class="w"> </span>resample://caps/localhost:18002?rate<span class="o">=</span><span class="m">16</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
</section>
|
||||
<section id="caps-command-line-interface-cli-client-capstool">
|
||||
<span id="sec-caps-capstool"></span><h2>CAPS command-line interface (CLI) client: capstool<a class="headerlink" href="#caps-command-line-interface-cli-client-capstool" title="Permalink to this heading">¶</a></h2>
|
||||
<p><a class="reference internal" href="../apps/capstool.html#capstool"><span class="std std-ref">capstool</span></a> is a CAPS client application for retrieving data and listing
|
||||
available streams from an operational CAPS server. The CAPS server may run
|
||||
locally or remotely as all communication is performed over the network
|
||||
(option:<cite>-H</cite>).</p>
|
||||
<p>Data requests are based on time windows and stream IDs. The data is provided in
|
||||
its origin format on stdout or, with <a class="reference internal" href="../apps/capssds.html#cmdoption-o"><code class="xref std std-option docutils literal notranslate"><span class="pre">-o</span></code></a> as a single file. In
|
||||
particular capstool may be used to fetch miniSEED data and create miniSEED
|
||||
files.</p>
|
||||
<p><a class="reference internal" href="../apps/capstool.html#capstool"><span class="std std-ref">capstool</span></a> can also be used for <a class="reference internal" href="server-testing.html#sec-caps-server-testing"><span class="std std-ref">testing the server</span></a> as it provides information on available streams with
|
||||
their time window (<a class="reference internal" href="../apps/capstool.html#cmdoption-Q"><code class="xref std std-option docutils literal notranslate"><span class="pre">-Q</span></code></a>, <a class="reference internal" href="../apps/caps2caps.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate"><span class="pre">-I</span></code></a>).</p>
|
||||
</section>
|
||||
<section id="data-file-access-rifftool-capssds">
|
||||
<span id="sec-caps-file"></span><h2>Data file access: rifftool/capssds<a class="headerlink" href="#data-file-access-rifftool-capssds" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The data files in the CAPS archive contain a small additional header describing
|
||||
the data format and implementing an index for fast and in-order data retrieval.
|
||||
Read the <a class="reference internal" href="archive.html#sec-packet-types"><span class="std std-ref">format documentation</span></a> for more details. In
|
||||
contrast to miniSEED files in <a class="reference internal" href="glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archives created, e.g., by
|
||||
<span id="id6"><em>slarchive</em> [<a class="reference internal" href="references.html#id298" title="slarchive. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/slarchive.html.">20</a>]</span> or <span id="id7"><em>scart</em> [<a class="reference internal" href="references.html#id241" title="scart. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scart.html.">14</a>]</span>, the original miniSEED files stored in
|
||||
the CAPS archive cannot be directly read by common seismological applications.</p>
|
||||
<p>You may access data files directly:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Test and retrieve data files using <a class="reference internal" href="../apps/rifftool.html#rifftool"><span class="std std-ref">rifftool</span></a>. rifftool addresses
|
||||
individual files directly and does not require the CAPS server to be running.</p></li>
|
||||
<li><p>Run <a class="reference internal" href="../apps/capssds.html#capssds"><span class="std std-ref">capssds</span></a> to create a virtual overlay file system presenting a CAPS
|
||||
archive directory as a read-only <a class="reference internal" href="glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive with no extra disk space
|
||||
requirement. The CAPS archive directory and file names are mapped. An
|
||||
application reading from a file will only see <a class="reference internal" href="glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> records ordered
|
||||
by record start time. You may connect to the virtual SDS archive using the
|
||||
RecordStream SDS or directly read the single <a class="reference internal" href="glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> file. Other
|
||||
seismological software such as ObsPy or Seisan may read directly from the SDS
|
||||
archive of the files therein.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="synchronize-with-another-caps-server-caps2caps">
|
||||
<span id="sec-caps2caps"></span><h2>Synchronize with another CAPS server: caps2caps<a class="headerlink" href="#synchronize-with-another-caps-server-caps2caps" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Use <a class="reference internal" href="../apps/caps2caps.html#caps2caps"><span class="std std-ref">caps2caps</span></a> to synchronize your CAPS server with another one. You may push
|
||||
or pull data on either side. In contrast to the generation of regular <a class="reference internal" href="glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a>
|
||||
archives, e.g., by <strong class="program">scart</strong>, the CAPS server will not generate duplicate
|
||||
data records if executing <a class="reference internal" href="../apps/caps2caps.html#caps2caps"><span class="std std-ref">caps2caps</span></a> multiple times. While synchronizing
|
||||
observe the <a class="reference internal" href="interfaces.html#sec-caps-web-interface"><span class="std std-ref">web interface</span></a> for the statistics of
|
||||
received, written or rejected data packages.</p>
|
||||
</section>
|
||||
<section id="connect-from-seedlink-caps-plugin">
|
||||
<span id="sec-caps-seedlink"></span><h2>Connect from SeedLink: caps_plugin<a class="headerlink" href="#connect-from-seedlink-caps-plugin" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The <a class="reference internal" href="../apps/caps_plugin.html#caps-plugin"><span class="std std-ref">caps_plugin</span></a> plugin fetches data from a CAPS server and provides the
|
||||
data to <strong class="program">seedlink</strong>. The plugin can be configured and started as any
|
||||
other plugin for <strong class="program">seedlink</strong> or executed on demand. Select <em>caps</em> when
|
||||
choosing the plugin in the seedlink binding configuration.</p>
|
||||
<p><strong>Examples:</strong></p>
|
||||
<ul>
|
||||
<li><p>Fetch data from a remote CAPS server and make them available in your <strong class="program">seedlink</strong> instance:</p>
|
||||
<ol class="arabic">
|
||||
<li><p>configure the <a class="reference internal" href="../apps/caps_plugin.html#caps-plugin"><span class="std std-ref">caps_plugin</span></a> plugin in the bindings configuration of your
|
||||
<strong class="program">seedlink</strong> instance pointing to the remote CAPS server</p></li>
|
||||
<li><p>enable and start <strong class="program">seedlink</strong></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>seedlink
|
||||
seiscomp<span class="w"> </span>start<span class="w"> </span>seedlink
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p>Provide data from a CAPS server by seedlink on the same machine to external clients:</p>
|
||||
<ol class="arabic">
|
||||
<li><p>create another seedlink instance, e.g., <strong class="program">seedlinkP</strong>:</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>seedlinkP<span class="w"> </span>seedlink
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>configure the <a class="reference internal" href="../apps/caps_plugin.html#caps-plugin"><span class="std std-ref">caps_plugin</span></a> in the bindings configuration of <strong class="program">seedlinkP</strong>
|
||||
pointing to the local CAPS server.</p></li>
|
||||
<li><p>enable and start <strong class="program">seedlinkP</strong>:</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>seedlinkP
|
||||
seiscomp<span class="w"> </span>start<span class="w"> </span>seedlinkP
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="web-interface">
|
||||
<span id="sec-caps-web"></span><h2>Web interface<a class="headerlink" href="#web-interface" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The CAPS server ships with a <a class="reference internal" href="interfaces.html#sec-caps-web-interface"><span class="std std-ref">web interface</span></a>.
|
||||
Beside allowing you to view server statistics, data stored stored on the server
|
||||
can be downloaded for any time if the original format is <a class="reference internal" href="glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a>.</p>
|
||||
<p>For downloading miniSEED data</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Select the stream(s) of interest.</p></li>
|
||||
<li><p>Zoom in to the period of interest. Zooming in and out in time works by
|
||||
right-mouse button actions just like in other <cite>SeisComP</cite> GUI applications like
|
||||
<span id="id8"><em>scrttv</em> [<a class="reference internal" href="references.html#id276" title="scrttv. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scrttv.html.">17</a>]</span>.</p></li>
|
||||
<li><p>Click on the download button to download the miniSEED file. An error message
|
||||
will be printed in case the original format is not miniSEED.</p></li>
|
||||
</ol>
|
||||
<figure class="align-default" id="id18">
|
||||
<span id="fig-web-streams-download"></span><a class="reference internal image-reference" href="../_images/web_streams_download.png"><img alt="../_images/web_streams_download.png" src="../_images/web_streams_download.png" style="width: 18cm;" /></a>
|
||||
<figcaption>
|
||||
<p><span class="caption-text">Stream perspective of <a class="reference internal" href="glossary.html#term-CAPS"><span class="xref std std-term">CAPS</span></a> Web interface allowing to download miniSEED
|
||||
data for selected streams.</span><a class="headerlink" href="#id18" title="Permalink to this image">¶</a></p>
|
||||
</figcaption>
|
||||
</figure>
|
||||
</section>
|
||||
<section id="built-in-fdsnws">
|
||||
<span id="sec-caps-fdsnws"></span><h2>Built-in FDSNWS<a class="headerlink" href="#built-in-fdsnws" title="Permalink to this heading">¶</a></h2>
|
||||
<p><cite>CAPS</cite> speaks natively FDSN Web Services, FDSNWS <span id="id9">[<a class="reference internal" href="references.html#id136" title="FDSNWS. International Federation of Digital Seismograph Networks. URL: http://www.fdsn.org/webservices/.">1</a>]</span> providing
|
||||
waveform data via dataselect. Information on events and stations are
|
||||
not delivered. The waveform data will be delivered through the port configured in
|
||||
<a class="reference internal" href="configuration.html#confval-AS.http.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.http.port</span></code></a> or the port configured by your Apache server, if available.
|
||||
Contact your system administrator for information on the Apache server.
|
||||
Read the documentation of the <a class="reference internal" href="configuration.html#sec-caps-config"><span class="std std-ref">CAPS server</span></a> for the configuration.</p>
|
||||
</section>
|
||||
<section id="built-in-winston-waveform-server">
|
||||
<span id="sec-caps-wws"></span><h2>Built-in Winston waveform server<a class="headerlink" href="#built-in-winston-waveform-server" title="Permalink to this heading">¶</a></h2>
|
||||
<p><cite>CAPS</cite> speeks natively Winston Waveform Server protocol, WWS, <span id="id10">[<a class="reference internal" href="references.html#id326" title="Winston Wave Server. USGS. URL: https://github.com/usgs/winston/blob/master/src/main/resources/docs/WWS.md.">9</a>]</span>,
|
||||
e.g., to <span id="id11"><em>SWARM</em> [<a class="reference internal" href="references.html#id308" title="SWARM. USGS. URL: https://volcanoes.usgs.gov/software/swarm/.">7</a>]</span> by USGS. Read the documentation of the
|
||||
<a class="reference internal" href="configuration.html#sec-caps-config"><span class="std std-ref">CAPS server</span></a> for the configuration.</p>
|
||||
</section>
|
||||
<section id="data-availability-information">
|
||||
<span id="sec-caps-dataavailability"></span><h2>Data availability information<a class="headerlink" href="#data-availability-information" title="Permalink to this heading">¶</a></h2>
|
||||
<section id="id12">
|
||||
<h3>Web interface<a class="headerlink" href="#id12" title="Permalink to this heading">¶</a></h3>
|
||||
<p>The <a class="reference internal" href="#sec-caps-web"><span class="std std-ref">Channels perspective of the CAPS web interface</span></a>
|
||||
indicates periods of availability and of gaps on level of network, station,
|
||||
sensor location and channel. The resolution of colors and percentages is linked
|
||||
to the granularity of the data detection which increases with shorter time
|
||||
windows in order to optimize the speed of the calculation.</p>
|
||||
</section>
|
||||
<section id="capstool">
|
||||
<h3>capstool<a class="headerlink" href="#capstool" title="Permalink to this heading">¶</a></h3>
|
||||
<p>The CAPS server stores information on received data segments
|
||||
including their start and end times. Information on resulting gaps can be
|
||||
retrieved by <a class="reference internal" href="../apps/capstool.html#capstool"><span class="std std-ref">capstool</span></a>. Example:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s2">"2023,05,01,12,00,00 2023,05,03,00,00,00 NET * * *"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>capstool<span class="w"> </span>-G<span class="w"> </span>--tolerance<span class="o">=</span><span class="m">0</span>.5<span class="w"> </span>-H<span class="w"> </span>localhost
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="scardac">
|
||||
<h3>scardac<a class="headerlink" href="#scardac" title="Permalink to this heading">¶</a></h3>
|
||||
<p>The availability of data in the caps archive can be analyzed and written to the
|
||||
<cite>SeisComP</cite> database by the <cite>SeisComP</cite> module <span id="id13"><em>scardac</em> [<a class="reference internal" href="references.html#id240" title="scardac. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scardac.html.">13</a>]</span>. For availability analysis
|
||||
add the plugin <em>daccaps</em> to the list of <a class="reference internal" href="../apps/global.html#confval-plugins"><code class="xref std std-confval docutils literal notranslate"><span class="pre">plugins</span></code></a> and URL of the caps
|
||||
archive to the archive configuration of <span id="id14"><em>scardac</em> [<a class="reference internal" href="references.html#id240" title="scardac. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scardac.html.">13</a>]</span>. The <em>daccaps</em> plugin
|
||||
ships with the gempa package <em>caps-server</em>.</p>
|
||||
<p>Example configuration of <span id="id15"><em>scardac</em> [<a class="reference internal" href="references.html#id240" title="scardac. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scardac.html.">13</a>]</span> (<code class="file docutils literal notranslate"><span class="pre">scardac.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}, daccaps</span>
|
||||
<span class="na">archive</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">caps:///home/data/archive/caps/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Example call:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scardac<span class="w"> </span>--plugins<span class="o">=</span><span class="s2">"daccaps, dbmysql"</span><span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>-a<span class="w"> </span>caps:///home/data/archive/caps/<span class="w"> </span>--debug
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>As of SeisComP in version 6, scardac has received significant optimization.
|
||||
Instead of scanning the full archive, only files which have changed since the
|
||||
last scan will be examined. This means that when scanning the entire archive,
|
||||
the first run may be more time consuming than subsequent ones when executed
|
||||
within reasonable intervals.</p>
|
||||
</div>
|
||||
<p>The data availability information can be retrieved from the database, e.g.,
|
||||
using <span id="id16"><em>fdsnws</em> [<a class="reference internal" href="references.html#id139" title="fdsnws. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/fdsnws.html.">11</a>]</span> or <span id="id17"><em>scxmldump</em> [<a class="reference internal" href="references.html#id284" title="scxmldump. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scxmldump.html.">18</a>]</span>.</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="#">Access Data on a CAPS Server</a><ul>
|
||||
<li><a class="reference internal" href="#recordstream-caps-capss">RecordStream: caps/capss</a><ul>
|
||||
<li><a class="reference internal" href="#configuration">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#optional-parameters">Optional Parameters</a></li>
|
||||
<li><a class="reference internal" href="#combination-with-other-recordstream-interfaces">Combination with other RecordStream interfaces</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#caps-command-line-interface-cli-client-capstool">CAPS command-line interface (CLI) client: capstool</a></li>
|
||||
<li><a class="reference internal" href="#data-file-access-rifftool-capssds">Data file access: rifftool/capssds</a></li>
|
||||
<li><a class="reference internal" href="#synchronize-with-another-caps-server-caps2caps">Synchronize with another CAPS server: caps2caps</a></li>
|
||||
<li><a class="reference internal" href="#connect-from-seedlink-caps-plugin">Connect from SeedLink: caps_plugin</a></li>
|
||||
<li><a class="reference internal" href="#web-interface">Web interface</a></li>
|
||||
<li><a class="reference internal" href="#built-in-fdsnws">Built-in FDSNWS</a></li>
|
||||
<li><a class="reference internal" href="#built-in-winston-waveform-server">Built-in Winston waveform server</a></li>
|
||||
<li><a class="reference internal" href="#data-availability-information">Data availability information</a><ul>
|
||||
<li><a class="reference internal" href="#id12">Web interface</a></li>
|
||||
<li><a class="reference internal" href="#capstool">capstool</a></li>
|
||||
<li><a class="reference internal" href="#scardac">scardac</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../apps/win2caps.html"
|
||||
title="previous chapter">win2caps</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="examples.html"
|
||||
title="next chapter">Examples and Recipes</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/base/data-retrieval.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