.. highlight:: rst

.. _licsar2caps:

###########
licsar2caps
###########

**Reads LICSAR data products from URL and pushes it to a CAPS server.**


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

Reads LICSAR data products from URL and pushes it to a CAPS server.

.. note::

   This module is currently tailored to only load data from :cite:t:`jasmin-data`

   For other servers a modification are required. Please contact us at info@gempa.de.


The :confval:`input.streamsFile` is used to select which products to load.

For example:

.. code-block:: properties

   ## Iceland
   155D_02484_191814
   009D_02504_202119
   111D_02490_152021

The :confval:`input.products` determines what types of products are actually fetched
and matches them to a channel code.

For example:

.. code-block:: properties

   geo.unw.tif:UNW
   geo.cc.tif:CC



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

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

licsar2caps 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



.. _input:


.. confval:: input.baseUrl

   Default: ``https://gws-access.jasmin.ac.uk/public/nceo_geohazards/LiCSAR_products/``

   Type: *string*

   Directory to monitor for incoming files


.. confval:: input.streamsFile

   Type: *string*

   Streams configuration file


.. confval:: input.products

   Default: ``geo.unw.tif:UNW``

   Type: *string:list*

   Selects which products are fetched from the web page. Each entry
   defines a mapping between file extension and channel code.


.. confval:: input.pollInterval

   Default: ``60``

   Unit: *s*

   Type: *string*

   Polling interval in seconds.


.. confval:: input.reprocess

   Default: ``false``

   Type: *boolean*

   Forces reprocessing of the last received grid at start.


.. confval:: input.processLatestOnly

   Default: ``false``

   Type: *boolean*

   Fetch and process last grid of the selcted time
   window only.


.. confval:: input.startTime

   Type: *string*

   Sets the start time for the data acquistion. The default
   start time is the current time. The following time formats
   are supported: \"%F\", \"%F %T\", \"%F %T.%Z\", \"%FT%T\"
   and \"%FT%T.%Z\", e.g., 2023\-11\-01 or 2023\-11\-01 00:00:00.


.. _output:


.. confval:: output.addr

   Default: ``caps://localhost:18003``

   Type: *string*

   Data output URL [[caps\|capss]:\/\/][user:pass\@]host[:port].


.. confval:: output.directory

   Type: *string*

   Data output directory.


.. _filter:


.. confval:: filter.enabled

   Default: ``false``

   Type: *boolean*

   Enable\/disable grid filtering


.. confval:: filter.threshold

   Type: *double*

   Threshold for the definition of significant displacement based on
   the configured percentile calculation. If the computed value is less
   or equal the computed value the grid is not taken into account.


.. confval:: filter.percentile

   Default: ``99.9``

   Type: *double*

   Percentile of the absolute values of the displacement grid for the
   definition of the threshold


.. _journal:


.. confval:: journal.file

   Default: ``@ROOTDIR@/var/run/licsar2caps/journal``

   Type: *string*

   File for storing the state of processed data




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


.. _Generic:


Generic
-------

.. option:: -h, --help

   Show help message.

.. option:: -V, --version

   Show version information.

.. option:: --config-file file

   The alternative module configuration file. When this option
   is used, the module configuration is only read from the
   given file and no other configuration stage is considered.
   Therefore, all configuration including the definition of
   plugins must be contained in that file or given along with
   other command\-line options such as \-\-plugins.

.. 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:


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, e.g., \-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.