246 lines
13 KiB
HTML
246 lines
13 KiB
HTML
<!doctype html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>CAPS documentation — 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="Introduction" href="base/introduction.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="base/introduction.html" title="Introduction"
|
|
accesskey="N">
|
|
next
|
|
</a>
|
|
</li>
|
|
<li class="nav-item nav-item-0">
|
|
<a href="#">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="appname-documentation">
|
|
<h1><cite>CAPS</cite> documentation<a class="headerlink" href="#appname-documentation" title="Permalink to this heading">¶</a></h1>
|
|
<p>This is the documentation for the Common Acquisition Protocol Server (<cite>CAPS</cite>)
|
|
package in version 2025.254#f0c77b29e.</p>
|
|
<div class="four column layout"><figure class="align-default" id="id1">
|
|
<img alt="architecture" src="_images/architecture.png" />
|
|
<figcaption>
|
|
<p><span class="caption-text"><cite>CAPS</cite> receives data in many formats from external sources for storage and distribution.</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
|
</figcaption>
|
|
</figure>
|
|
<figure class="align-default" id="id2">
|
|
<img alt="deployment" src="_images/deployment.png" />
|
|
<figcaption>
|
|
<p><span class="caption-text"><cite>CAPS</cite> provides redundancy and flexible access to data sources or different kinds.</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
|
</figcaption>
|
|
</figure>
|
|
<figure class="align-default" id="id3">
|
|
<img alt="web interface with metrics" src="_images/web_streams_1.png" />
|
|
<figcaption>
|
|
<p><span class="caption-text">The <cite>CAPS</cite> web interface shows server metrics and data availability.</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
|
</figcaption>
|
|
</figure>
|
|
<figure class="align-default" id="id4">
|
|
<img alt="web interface with data" src="_images/web_streams_2.png" />
|
|
<figcaption>
|
|
<p><span class="caption-text">The <cite>CAPS</cite> web interface shows waveforms.</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
|
</figcaption>
|
|
</figure>
|
|
</div><div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>This version of CAPS introduces a different data file storage format eventually
|
|
increasing the performance of CAPS. The change affects all version after 2021.048.</p>
|
|
<p>While this change should be transparent to the user, initially it can cause
|
|
temporary performance impacts. Please read <a class="reference internal" href="base/upgrading.html#sec-caps-upgrading"><span class="std std-ref">Upgrading</span></a>.</p>
|
|
</div>
|
|
<section id="about">
|
|
<h2>About<a class="headerlink" href="#about" title="Permalink to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/introduction.html">Introduction</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/introduction.html#features">Features</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/introduction.html#architecture">Architecture</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/introduction.html#deployment">Deployment</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/upgrading.html">Upgrading</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/upgrading.html#new-file-format">New file format</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/upgrading.html#rationale">Rationale</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/upgrading.html#manual-archive-conversion">Manual archive conversion</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/glossary.html">Glossary</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/glossary.html#seiscomp-terms">SeisComP terms</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/glossary.html#scientific-and-technical-terms">Scientific and technical terms</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/references.html">References</a></li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="data-server-acquisition-retrieval">
|
|
<h2>Data Server, Acquisition, Retrieval<a class="headerlink" href="#data-server-acquisition-retrieval" title="Permalink to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/server.html">CAPS Server Application</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/archive.html">Data Management</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/configuration.html">Execution and Automatic Startup</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/configuration.html#file-system-tuning">File System Tuning</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/configuration.html#security-and-access-control">Security and Access Control</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/configuration.html#module-configuration">Module Configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/configuration.html#command-line-options">Command-Line Options</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/interfaces.html">Server Interfaces</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/server-testing.html">Server and File Testing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/redundancy.html">Data Redundancy</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/plugins.html">Data Acquisition and Manipulation by Plugins</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/plugins.html#appname-plugins"><cite>CAPS</cite> plugins</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/plugins.html#integration-of-seedlink-plugins">Integration of Seedlink plugins</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/plugins.html#configuration-of-appname-plugins">Configuration of <cite>CAPS</cite> plugins</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/data-retrieval.html">Access Data on a CAPS Server</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#recordstream-caps-capss">RecordStream: caps/capss</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#caps-command-line-interface-cli-client-capstool">CAPS command-line interface (CLI) client: capstool</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#data-file-access-rifftool-capssds">Data file access: rifftool/capssds</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#synchronize-with-another-caps-server-caps2caps">Synchronize with another CAPS server: caps2caps</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#connect-from-seedlink-caps-plugin">Connect from SeedLink: caps_plugin</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#web-interface">Web interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#built-in-fdsnws">Built-in FDSNWS</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#built-in-winston-waveform-server">Built-in Winston waveform server</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/data-retrieval.html#data-availability-information">Data availability information</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/examples.html">Examples and Recipes</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/examples.html#retrieve-real-time-data-from-a-caps-server">Retrieve real-time data from a CAPS server</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/examples.html#import-data-into-a-caps-server">Import data into a CAPS server</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="base/examples.html#real-time-playbacks">Real-time playbacks</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="software-history">
|
|
<h2>Software History<a class="headerlink" href="#software-history" title="Permalink to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/changelog-server.html">CAPS server</a></li>
|
|
</ul>
|
|
</div>
|
|
<section id="plugins">
|
|
<h3>Plugins<a class="headerlink" href="#plugins" title="Permalink to this heading">¶</a></h3>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/changelog-rs2caps.html">rs2caps</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/changelog-caps2caps.html">caps2caps</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/changelog-slink2caps.html">slink2caps</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/changelog-sproc2caps.html">sproc2caps</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="base/changelog-python.html">Python</a></li>
|
|
</ul>
|
|
</div>
|
|
</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="#">Table of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#"><cite>CAPS</cite> documentation</a><ul>
|
|
<li><a class="reference internal" href="#about">About</a></li>
|
|
<li><a class="reference internal" href="#data-server-acquisition-retrieval">Data Server, Acquisition, Retrieval</a></li>
|
|
<li><a class="reference internal" href="#software-history">Software History</a><ul>
|
|
<li><a class="reference internal" href="#plugins">Plugins</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="base/introduction.html"
|
|
title="next chapter">Introduction</a></p>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/index.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> |