.. highlight:: rst

.. _ew2sc:

#####
ew2sc
#####

**Earthworm hypo2000_arc messages importer**

.. _ew2sc_configuration:

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

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

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



.. confval:: ew2sc3.configPath

   Type: *string*

   Folder to store logs and achives of hypo2000_arc files from Earthworm export_genericer


.. confval:: ew2sc3.senderPort

   Type: *int*

   Earthworm export_generic's socket to listen to


.. confval:: ew2sc3.modID

   Type: *int*

   Expected Earthworm Module ID \(ew2sc3 will read the message only if its ModID is correct\).
   Set to 0 \(MOD_WILDCARD\) to accept any Earthworm Module ID.


.. confval:: ew2sc3.instID

   Type: *int*

   Expected Earthworm Institute ID \(ew2sc3 will read the message only if its InstID is correct\)
   Set to 0 \(INST_WILDCARD\) to accept any Earthworm Institute ID.


.. confval:: ew2sc3.customAgencyID

   Type: *string*

   Institute name to use when storing origin into database.
   If blank, the origin will have the system AgencyID. If specified, the origin will have the given AgencyID.


.. confval:: ew2sc3.author

   Type: *string*

   Author name to use when storing origin into database.


.. confval:: ew2sc3.hostname

   Type: *string*

   Earthworm export_generic IP address to connect to


.. confval:: ew2sc3.defaultLatitude

   Type: *string*

   Default event latitude to use if hypo2000_arc location is null \(space filled\)


.. confval:: ew2sc3.defaultLongitude

   Type: *string*

   Default event longitude to use if hypo2000_arc location is null \(space filled\)


.. confval:: ew2sc3.locatorProfile

   Type: *string*

   Name of the earth model used by Earthworm location process


.. confval:: ew2sc3.enableArchiving

   Type: *boolean*

   Enable\/Disable hypo2000_arc message file archiving \(usefull for troobleshooting\)


.. confval:: ew2sc3.myAliveInt

   Type: *int*

   Time interval \(in sec\) between two heartbeats messages sent by SeisComP.
   This parameter should be lower than Earthworm export_generic RcvAliveInt parameter


.. confval:: ew2sc3.senderTimeout

   Type: *int*

   Maximum time \(in millisecond\) before the connection to Earthworm export_generic times out.
   This parameter has to be set accordingly to Earthworm export_generic parameters


.. confval:: ew2sc3.maxMsgSize

   Type: *int*

   Maximum message size \(in char\) between the Earthworm export_generic and ew2sc3.
   This parameter has to be set accordingly to Earthworm export_generic MaxMsgSize parameter


.. confval:: ew2sc3.myAliveString

   Type: *string*

   Alive string to send to Earthworm export_generic in order to keep the connection alive.
   This string should be identical as Earthworm export_generic RcvAliveText string


.. confval:: ew2sc3.senderAliveString

   Type: *string*

   Alive string expected from Earthworm export_generic in order to keep the connection alive.
   This string should be identical as Earthworm export_generic SendAliveText string


.. confval:: ew2sc3.enableUncertainties

   Type: *boolean*

   Enable\/Disable uncertainties conversions.
   Earthworm doesn't have uncertainties but weight from 0 to 4.
   If enabled, ew2sc3 will convert pick weight to uncertainties followind a simple mapping between weight and pickerUncertainties list.


.. confval:: ew2sc3.pickerUncertainties

   Type: *list:double*

   Uncertainty values \(in sec\) to use when enableUncertainties is enabled.
   Refer to scolv document for syntax.


.. confval:: ew2sc3.maxUncertainty

   Type: *double*

   Maximum weight value from Earthworm corresponding to maximum uncertainty



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

.. program:: ew2sc


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 \&.

.. option:: --auto-shutdown arg

   Enable\/disable self\-shutdown because a master module shutdown.
   This only works when messaging is enabled and the master
   module sends a shutdown message \(enabled with \-\-start\-stop\-msg
   for the master module\).

.. option:: --shutdown-master-module arg

   Set the name of the master\-module used for auto\-shutdown.
   This is the application name of the module actually
   started. If symlinks are used, then it is the name of
   the symlinked application.

.. option:: --shutdown-master-username arg

   Set the name of the master\-username of the messaging
   used for auto\-shutdown. If \"shutdown\-master\-module\" is
   given as well, this parameter is ignored.


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:: --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:: --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:: --content-type arg

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

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

   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.

.. option:: --inventory-db arg

   Load the inventory from the given database or file, format:
   [service:\/\/]location .

.. option:: --db-disable

   Do not use the database at all

