.. highlight:: rst

.. _sc2ql:

#####
sc2ql
#####

**Import SeisComP event objects into a QuakeLink server.**


Description
===========

sc2ql is an application to export SeisComP objects, e.g. event parameters, from
|scname| to a QuakeLink server in real time. sc2ql is part of the QuakeLink
suite/software package.

The application is demonstrated in the :ref:`examples <quakelink-examples>`.

Please read the command-line help for the options:

.. code-block:: sh

   sc2ql -h



Module Configuration
====================

| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/sc2ql.cfg`
| :file:`etc/global.cfg`
| :file:`etc/sc2ql.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/sc2ql.cfg`

sc2ql inherits :ref:`global options<global-configuration>`.

.. note::

   Modules/plugins may require a license file. The default path to license
   files is :file:`@DATADIR@/licenses/` which can be overridden by global
   configuration of the parameter :confval:`gempa.licensePath`. Example: ::

      gempa.licensePath = @CONFIGDIR@/licenses



.. confval:: QL.server

   Default: ``localhost:18011``

   Type: *string*

   QuakeLink server to push data to


.. confval:: QL.compression

   Default: ``false``

   Type: *boolean*

   Compress messages pushed to QuakeLink with gzip


.. confval:: QL.binary

   Default: ``false``

   Type: *boolean*

   Encode messages in SeisComP binary format instead of SCML


.. confval:: QL.fetchAllAmplitudes

   Default: ``false``

   Type: *boolean*

   If enabled, then all amplitudes which reference an arrival of the
   preferred origin are included regardless of being referenced by a
   magnitude.
   Otherwise only the amplitudes are included which are referenced
   by the available station magnitudes.


.. confval:: QL.onlyPublishedEvents

   Default: ``false``

   Type: *boolean*

   An event is only forwarded to QuakeLink if the preferred
   origin contains a comment with text \"OriginPublished\".


.. confval:: QL.indentation

   Default: ``false``

   Type: *boolean*

   Use indentation for SCML encoding


.. confval:: QL.bufferSize

   Default: ``128``

   Type: *int*

   Buffer size in megabytes. If the QuakeLink server is not
   reachable buffer messages up to X mb in a ring buffer.
   If the server is reachable again all buffered messages
   will be sent first.




Command-Line Options
====================

:program:`sc2ql [options]`

Generic
-------

.. option:: -h, --help

   Show help message.

.. option:: -V, --version

   Show version information.

.. option:: --config-file arg

   Use alternative configuration file. When this option is
   used the loading of all stages is disabled. Only the
   given configuration file is parsed and used. To use
   another name for the configuration create a symbolic
   link of the application or copy it. Example:
   scautopick \-> scautopick2.

.. option:: --plugins arg

   Load given plugins.

.. option:: -D, --daemon

   Run as daemon. This means the application will fork itself
   and doesn't need to be started with \&.


Verbosity
---------

.. option:: --verbosity arg

   Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
   4:debug.

.. option:: -v, --v

   Increase verbosity level \(may be repeated, eg. \-vv\).

.. option:: -q, --quiet

   Quiet mode: no logging output.

.. option:: --print-component arg

   For each log entry print the component right after the
   log level. By default the component output is enabled
   for file output but disabled for console output.

.. option:: --component arg

   Limit the logging to a certain component. This option can
   be given more than once.

.. option:: -s, --syslog

   Use syslog logging backend. The output usually goes to
   \/var\/lib\/messages.

.. option:: -l, --lockfile arg

   Path to lock file.

.. option:: --console arg

   Send log output to stdout.

.. option:: --debug

   Execute in debug mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 .

.. option:: --trace

   Execute in trace mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1
   \-\-print\-context\=1 .

.. option:: --log-file arg

   Use alternative log file.


Messaging
---------

.. option:: -u, --user arg

   Overrides configuration parameter :confval:`connection.username`.


.. option:: -H, --host arg

   Overrides configuration parameter :confval:`connection.server`.


.. option:: -t, --timeout arg

   Overrides configuration parameter :confval:`connection.timeout`.


.. option:: -g, --primary-group arg

   Overrides configuration parameter :confval:`connection.primaryGroup`.


.. option:: -S, --subscribe-group arg

   A group to subscribe to.
   This option can be given more than once.

.. option:: --start-stop-msg arg

   Default: ``0``

   Set sending of a start and a stop message.


Database
--------

.. option:: --db-driver-list

   List all supported database drivers.

.. option:: -d, --database arg

   The database connection string, format:
   service:\/\/user:pwd\@host\/database.
   \"service\" is the name of the database driver which
   can be queried with \"\-\-db\-driver\-list\".

.. option:: --config-module arg

   The config module to use.


Sink
----

.. option:: --test

   Test output and read SCML from stdin.

.. option:: --server arg

   Overrides configuration parameter :confval:`QL.server`.


.. option:: -z, --gzip arg

   Overrides configuration parameter :confval:`QL.compression`.


.. option:: --bin arg

   Overrides configuration parameter :confval:`QL.binary`.


.. option:: -p, --pretty-print arg

   Overrides configuration parameter :confval:`QL.indentation`.


.. option:: --end-buffer arg

   Overrides configuration parameter :confval:`QL.bufferSize`.