.. highlight:: rst

.. _gnssneu2caps:

############
gnssneu2caps
############

**Reads GNSS displacement data products in the "NEU" format from URL and pushes it to a CAPS server.**


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

Reads data in the "NEU" format from a website and pushes it into a CAPS server.

.. note:: 
   
   This module is currently tailored to only load data from :cite:t:`gnss-data`
   
   For other servers a modification are required. Please contact us at info@gempa.de.

Use the :confval:`input.streamsFile` to select which stations data to load.

.. code-block:: properties

   # Comments and empty lines are ignored

   GNSS.GEVK
   GNSS.GOLA
   GNSS.ORFC
   GNSS.SENG


This will fetch the data files

``GEVK-plate.NEU``, ``GOLA-plate.NEU``, and so on.

The network code can be chosen freely, but has to match the inventory.

By setting the :confval:`output.northChannel`, :confval:`output.eastChannel` and
:confval:`output.upChannel` options, the channel names can be freely defined 
to match inventory. This matches the ``N`` (north), ``E`` (east) and ``U`` (up) components 
to the defined channel codes.



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

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

gnssneu2caps 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://cdn.vedur.is/gps/timeseries/data/post-processing/timeseries/``

   Type: *string*

   Directory to monitor for incoming files


.. confval:: input.streamsFile

   Default: ``@ROOTDIR@/share/gnssneu2caps/streammap``

   Type: *directory*

   Streams configuration file.


.. confval:: input.pollInterval

   Default: ``86400``

   Unit: *s*

   Type: *string*

   Polling interval in seconds.


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

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

   Type: *string*

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


.. confval:: output.northChannel

   Default: ``PXN``

   Type: *string*

   The channel code for the north component.


.. confval:: output.eastChannel

   Default: ``PXE``

   Type: *string*

   The channel code for the east component.


.. confval:: output.upChannel

   Default: ``PXZ``

   Type: *string*

   The channel code for the vertical component.


.. confval:: output.storeUncertainties

   Default: ``true``

   Type: *boolean*

   Store uncertainty values for each channel if present in the raw data.
   Additional channels with the postfix \"d\" will be added. \(eg. PXEd\)


.. _journal:


.. confval:: journal.file

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

   Type: *string*

   File for storing the state of processed data


.. confval:: journal.force

   Default: ``false``

   Type: *boolean*

   Force reprocessing of all fetched data and ignore the journal.




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.