|appname| documentation
=======================

This is the documentation for the Common Acquisition Protocol Server (|appname|)
package in version |version|.

.. raw:: html

   <div class="four column layout">

.. figure:: base/media/architecture.png
   :alt: architecture

   |appname| receives data in many formats from external sources for storage and distribution.

.. figure:: base/media/deployment.png
   :alt: deployment

   |appname| provides redundancy and flexible access to data sources or different kinds.

.. figure:: base/media/web_streams_1.png
   :alt: web interface with metrics

   The |appname| web interface shows server metrics and data availability.

.. figure:: base/media/web_streams_2.png
   :alt: web interface with data

   The |appname| web interface shows waveforms.
.. raw:: html

   </div>

.. note::

   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.

   While this change should be transparent to the user, initially it can cause
   temporary performance impacts. Please read :ref:`sec-caps-upgrading`.


About
#####

.. toctree::
   :maxdepth: 2

   /base/introduction
   /base/upgrading
   /base/glossary
   /base/references


Data Server, Acquisition, Retrieval
###################################

.. toctree::
   :maxdepth: 2

   /base/server
   /base/plugins
   /base/data-retrieval
   /base/examples


Software History
################

.. toctree::
   :maxdepth: 1

   CAPS server </base/changelog-server>

Plugins
-------

.. toctree::
   :maxdepth: 1

   rs2caps</base/changelog-rs2caps>
   caps2caps</base/changelog-caps2caps>
   slink2caps</base/changelog-slink2caps>
   sproc2caps</base/changelog-sproc2caps>
   Python </base/changelog-python>