Getting Started¶

The configuration parameters are described in the technical description. Read below for the details. VORTEX also requires bindings.

Minimum Configuration¶

Use the module and bindings configuration of VORTEX to set the required configuration parameters. A minimum VORTEX configuration includes:

The data source is configured to the global parameters of the VORTEX module configuration (vortex.cfg).

Stations and streams are primarily configured by VORTEX bindings.

Create VORTEX bindings to all stations which shall be considered by VORTEX. Consider binding profiles for sharing identical parameters for a set of stations and station bindings for unique configurations.
In the bindings configuration set the streams parameter to define location and the stream of a station. You may use wildcards and define multiple streams in a comma-separated list. Example:
```
# 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.
streams = 00.BH?,HH?
```
Hint

The definition of streams can be further narrowed by the module configuration parameters streams.codes or on the command line, e.g.
```
vortex --streams.codes=IU.*.00.BHZ
```

Apply further module configurations in vortex.cfg.

Streams: While the stations and streams to be considered are set in the bindings, the streams can be further filtered by configuring streams.codes.
Duration: By default, VORTEX loads and display 1 hour data until current time (GMT). Adjust bufferSize to alter the duration.
End time: Adjust endTime to control the end of the time window. Use the usual time format for SeisComP. Example:
```
endTime = "2021-05-01 12:00:00"
```

VORTEX allows to create artificial origins which can be processed in other GUIs.

Interaction: Configure the global parameter commands.target allowing to send artificial origins by VORTEX and to receive them by other GUIs:
```
commands.target = ".*$"
```

The widget layout of the Overview tab can be configured.

Rows and columns: Adjust the number of rows and columns by trace.overview.matrixLayout, e.g. for 3 columns and 2 rows:
```
trace.overview.matrixLayout = "3x2"
```

In the spec section the time window parameters for computing the spectrograms as well as a custom gradient can be configured.

Spectrograms: Configure length (spec.length), overlap (spec.overlap) and number of samples (spec.samples) of time windows:
```
spec.length = 5
spec.overlap = 0.5
spec.samples = 512
```

After configuring the gradient, they can be adjusted interactively in the Overview and the Detail tabs.

A variety of pre-defined gradients is available by default.

In binding profiles or station bindings configure also:

Gain multipliers: Convert the gain-corrected data values from the fundamental SI units to another derived unit, e.g. m to km, Pa to hPa. Set gainMultiplier to the respective power of 10, e.g. 3 for units of km.
```
gainMultiplier = 3
```
Video data source and stream ID: Set videoStreams.videoURL and videoStreams.videoStreamID. Video streams can be served by a CAPS server [1]:
```
videoStreams.videoURL = video.agency.de:18008
videoStreams.videoStreamID = NZ.RUAP.NORTH.CAM
```
Set videoStreams.liveVideo to any web-video source like youtube:
```
videoStreams.liveVideo = https://www.youtube.com/embed/Q5M-5XFplo0?autoplay=1&modestbranding=1
```
Note

The whole website will be displayed.

For the purpose of embedding videos, youtube for example, has options like embed, modestbranding and autoplay.

Other web players may have similar options.
Auxiliary streams: Up to 3 auxiliary streams, e.g. non-seismic data like air pressure can be fetched from the configured RecordStream. Non-miniSEED auxiliary streams can be served by a CAPS server [1]. Example:
```
auxStream1.stream = 30.HDF
auxStream1.gainMultiplier = 2
```