.. highlight:: rst .. _vortex: ###### vortex ###### **Volcano observation application** Description =========== Volcano Observation and Response Module Configuration ==================== | :file:`etc/defaults/global.cfg` | :file:`etc/defaults/vortex.cfg` | :file:`etc/global.cfg` | :file:`etc/vortex.cfg` | :file:`~/.seiscomp/global.cfg` | :file:`~/.seiscomp/vortex.cfg` vortex inherits :ref:`global options`. .. 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:: bufferSize Default: ``3600`` Unit: *s* Type: *int* Sets the size of the waveform buffer in seconds. Note: For buffer sizes larger than 36000 seconds the data will be downsampled to 1Hz and waveforms will be disabled. .. confval:: endTime Default: ``GMT`` Type: *string* Sets the end time of data acquisition. Options: GMT: current time, dynamic end time other times: static end time, e.g.: '2019\-09\-15 12:00:00' .. note:: **streams.\*** *Data stream configuration* .. confval:: streams.codes Default: ``*`` Type: *list:string* Comma\-separated list of stream codes to use. Wild cards supported. This list acts as an additional filter to the stream selection configured in the VORTEX binding. Example: NET.STA.LOC.CHA .. note:: **spec.\*** *Spectrum configuration* .. confval:: spec.length Default: ``20.0`` Unit: *s* Type: *float* Length of the spectrum time window .. confval:: spec.overlap Default: ``0.8`` Type: *float* Overlap factor for time windows relative to their length. Value range: [0\-1]. A value of 0.8 means an overlap of 80 percent. Hence 20 percent of new data is used for each new spectrum. .. confval:: spec.samples Default: ``800`` Type: *int* Number of samples points for each spectrum. This parameter is used to reduce the numeric complexity in case of high sampled data. Note: The number of samples is limited to: ceil\(log_2\(spec.length \* nyquist frequency\)\). .. confval:: spec.gradient Default: ``0:ff50ff, 0.2:5050ff, 0.4:50ffff, 0.6:50ff50, 0.8:ffff50, 1.0:ff5050`` Type: *list:string* Gradient configuration for a custom color gradient. The format is a comma\-separated list of form 'value:color'. .. note:: **spec.range.\*** *Range configuration for various offset modes. The format* *is a comma-seperated pair of values in the form 'lower,upper'.* .. confval:: spec.range.none Default: ``5.0,9.0`` Type: *list:double* Range for the 'None' offset mode .. confval:: spec.range.min Type: *list:double* Range for the 'Minimum' offset mode .. confval:: spec.range.max Type: *list:double* Range for the 'Maximum' offset mode .. confval:: spec.range.midRange Type: *list:double* Range for the 'Mid Range' offset mode .. confval:: spec.range.mean Type: *list:double* Range for the 'Mean' offset mode .. confval:: spec.range.mode Type: *list:double* Range for the 'Mode \(Binning\)' offset mode .. confval:: spec.range.etmMedian Type: *list:double* Range for the 'Estimated Median' offset mode .. note:: **trace.\*** *Trace configuration* .. confval:: trace.updateinterval Default: ``1.0`` Unit: *s* Type: *double* Update interval of data to show in trace widgets. .. note:: **trace.overview.\*** *Parameters controlling the Overview tab.* .. confval:: trace.overview.matrixLayout Default: ``3x3`` Type: *string* Matrix layout specified as string of form: COLSxROWS, e.g. 4x3. Maxium 5 columns and rows are supported. .. note:: **event.\*** *Event configuration* .. confval:: event.autoUpdate Default: ``false`` Type: *boolean* Automatically load new events, that are created in the seiscomp system. .. confval:: event.ignoreRejected Default: ``true`` Type: *boolean* Do not import events that have the rejected state. .. confval:: event.scripts Type: *list:string* Registration of the script profiles. .. note:: **script.\*** *Configuration of additional scripts that can be run from the event list.* *The events will be passed to the script over stdin, in the FDSN event text standard* *"EventID|Time|Latitude|Longitude|..."* *(https://www.fdsn.org/webservices/fdsnws-event-1.2.pdf)* .. note:: **script.$name.\*** *Script details:* $name is a placeholder for the name to be used and needs to be added to :confval:`event.scripts` to become active. .. code-block:: sh event.scripts = a,b script.a.value1 = ... script.b.value1 = ... # c is not active because it has not been added # to the list of event.scripts script.c.value1 = ... .. confval:: script.$name.path Default: ``myscript.py`` Type: *string* The script filename or full path. Supported types are python \(.py\) and bash \(.sh\) scripts. Scripts are expected in ROOTDIR\/lib\/python\/vortex\/ But absolute paths are also supported. Bindings Parameters =================== .. confval:: streams Type: *list:string* Comma\-separated list of location and channel codes to use as primary streams, e.g. BH or BH? or BHZ,BHN,BHE or 00.ENZ,00.EHN. .. confval:: gainMultiplier Default: ``-6`` Type: *int* Exponent of the gain multiplier \(10\^value\), e.g. 3 \(kilo\), \-3 \(milli\), \-6 \(micro\). .. note:: **videoStreams.\*** *Video stream configurations.* .. confval:: videoStreams.videoURL Type: *string* Host and \(optional\) port of the CAPS server providing video data, e.g. gempa.de:18002. If omitted the record stream URL is used if it points to a CAPS server. .. confval:: videoStreams.videoStreamID Type: *string* Stream ID containing video data. The network and station code may be omitted, e.g. '.CAM', 'LOC.CAM', 'NET.STA.LOC.CAM'. .. confval:: videoStreams.liveVideo Type: *string* Link to a web\-video livestream \(e.g. youtube\). .. note:: **auxStream1.\*** *First auxiliary stream.* .. confval:: auxStream1.stream Type: *string* *No description available* .. confval:: auxStream1.gainMultiplier Default: ``0`` Type: *int* Exponent of the gain multiplier \(10\^value\), e.g. 3 \(kilo\), \-3 \(milli\), \-6 \(micro\). .. note:: **auxStream2.\*** *Second auxiliary stream.* .. confval:: auxStream2.stream Type: *string* *No description available* .. confval:: auxStream2.gainMultiplier Default: ``0`` Type: *int* Exponent of the gain multiplier \(10\^value\), e.g. 3 \(kilo\), \-3 \(milli\), \-6 \(micro\). .. note:: **auxStream3.\*** *Third auxiliary stream.* .. confval:: auxStream3.stream Type: *string* *No description available* .. confval:: auxStream3.gainMultiplier Default: ``0`` Type: *int* Exponent of the gain multiplier \(10\^value\), e.g. 3 \(kilo\), \-3 \(milli\), \-6 \(micro\). Command-Line 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. .. option:: --inventory-db arg Load the inventory from the given database or file, format: [service:\/\/]location . .. option:: --config-db arg Load the configuration from the given database or file, format: [service:\/\/]location . Records ------- .. option:: --record-driver-list List all supported record stream drivers. .. option:: -I, --record-url arg The recordstream source URL, format: [service:\/\/]location[#type]. \"service\" is the name of the recordstream driver which can be queried with \"\-\-record\-driver\-list\". If \"service\" is not given, \"file:\/\/\" is used. .. option:: --record-file arg Specify a file as record source. .. option:: --record-type arg Specify a type for the records being read. Mode ---- .. option:: --offline Do not connect to a messaging server. The database connection must be provided explicitly. .. option:: -S, --streams arg Overrides configuration parameter :confval:`streams.codes`. .. option:: --buffer-size arg Overrides configuration parameter :confval:`bufferSize`. .. option:: --end-time arg Overrides configuration parameter :confval:`endTime`. .. option:: --threads arg Use the specified number of RecordStreamThreads for data aquisition. This is usefull for a large amount of streams or a large bufferSize. The default is 1.