vortex¶

Volcano observation application

Description¶

Volcano Observation and Response

Module Configuration¶

etc/defaults/global.cfg
etc/defaults/vortex.cfg
etc/global.cfg
etc/vortex.cfg
~/.seiscomp/global.cfg
~/.seiscomp/vortex.cfg

vortex inherits global options.

Note

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

gempa.licensePath = @CONFIGDIR@/licenses

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.

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

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

spec.length¶

Default: 20.0

Unit: s

Type: float

Length of the spectrum time window

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.

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

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

spec.range.none¶

Default: 5.0,9.0

Type: list:double

Range for the ‘None’ offset mode

spec.range.min¶

Type: list:double

Range for the ‘Minimum’ offset mode

spec.range.max¶

Type: list:double

Range for the ‘Maximum’ offset mode

spec.range.midRange¶

Type: list:double

Range for the ‘Mid Range’ offset mode

spec.range.mean¶

Type: list:double

Range for the ‘Mean’ offset mode

spec.range.mode¶

Type: list:double

Range for the ‘Mode (Binning)’ offset mode

spec.range.etmMedian¶

Type: list:double

Range for the ‘Estimated Median’ offset mode

Note

trace.* Trace configuration

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.

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

event.autoUpdate¶

Default: false

Type: boolean

Automatically load new events, that are created in the seiscomp system.

event.ignoreRejected¶

Default: true

Type: boolean

Do not import events that have the rejected state.

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 event.scripts to become active.

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

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¶

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.

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.

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.

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

videoStreams.liveVideo¶

Type: string

Link to a web-video livestream (e.g. youtube).

Note

auxStream1.* First auxiliary stream.

auxStream1.stream¶

Type: string

No description available

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.

auxStream2.stream¶

Type: string

No description available

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.

auxStream3.stream¶

Type: string

No description available

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¶

-h, --help¶: Show help message.

-V, --version¶: Show version information.

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

--plugins arg¶: Load given plugins.

-D, --daemon¶: Run as daemon. This means the application will fork itself and doesn’t need to be started with &.

Verbosity¶

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

-v, --v¶: Increase verbosity level (may be repeated, eg. -vv).

-q, --quiet¶: Quiet mode: no logging output.

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

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

-s, --syslog¶: Use syslog logging backend. The output usually goes to /var/lib/messages.

-l, --lockfile arg¶: Path to lock file.

--console arg¶: Send log output to stdout.

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

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

--log-file arg¶: Use alternative log file.

Messaging¶

-u, --user arg¶: Overrides configuration parameter connection.username.

-H, --host arg¶: Overrides configuration parameter connection.server.

-t, --timeout arg¶: Overrides configuration parameter connection.timeout.

-g, --primary-group arg¶: Overrides configuration parameter connection.primaryGroup.

-S, --subscribe-group arg¶: A group to subscribe to. This option can be given more than once.

--start-stop-msg arg¶

Default: 0

Set sending of a start and a stop message.

Database¶

--db-driver-list¶: List all supported database drivers.

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

--config-module arg¶: The config module to use.

--inventory-db arg¶: Load the inventory from the given database or file, format: [service://]location .

--config-db arg¶: Load the configuration from the given database or file, format: [service://]location .

Records¶

--record-driver-list¶: List all supported record stream drivers.

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

--record-file arg¶: Specify a file as record source.

--record-type arg¶: Specify a type for the records being read.

Mode¶

--offline¶: Do not connect to a messaging server. The database connection must be provided explicitly.

-S, --streams arg¶: Overrides configuration parameter streams.codes.

--buffer-size arg¶: Overrides configuration parameter bufferSize.

--end-time arg¶: Overrides configuration parameter endTime.

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

vortex¶

Description¶

Module Configuration¶

Bindings Parameters¶

Command-Line Options¶

Generic¶

Verbosity¶

Messaging¶

Database¶

Records¶

Mode¶

Table of Contents

Previous topic

Next topic

This Page