Usage: gstlal_snax_sink [--options]
an executable to dump streaming data to disk via hdf5
Options:
-h, --help show this help message and exit
File Sink Options:
General settings for configuring the file sink.
-v, --verbose Print to stdout in addition to writing to
automatically generated log.
--log-level=LOG_LEVEL
Sets the verbosity of logging. Default = 10.
--rootdir=path Sets the root directory where logs and metadata are
stored.
--features-path=path
Write features to this path. Default = .
--instrument=string
Sets the instrument for files written to disk. Default
= H1
--tag=string Sets the name of the tag used. Default = 'test'
--waveform=WAVEFORM
Set the waveform used for producing features. Default
= sine_gaussian.
--sample-rate=Hz Set the sample rate for feature timeseries output,
must be a power of 2. Default = 1 Hz.
--write-cadence=WRITE_CADENCE
Rate at which the feature data is written to disk.
Default = 100 seconds.
--persist-cadence=PERSIST_CADENCE
Rate at which new hdf5 files are written to disk.
Default = 10000 seconds.
--processing-cadence=PROCESSING_CADENCE
Rate at which the synchronizer acquires and processes
data. Default = 0.1 seconds.
--request-timeout=REQUEST_TIMEOUT
Timeout for requesting messages from a topic. Default
= 0.2 seconds.
--kafka-server=string
Sets the server url that the kafka topic is hosted on.
Required.
--input-topic-basename=string
Sets the input kafka topic basename. Required.
Channel Options:
Settings used for deciding which auxiliary channels to process.
--channel-list=name
Set the list of the channels to process. Command given
as --channel-list=location/to/file
--channel-name=name
Set the name of the channels to process. Can be given
multiple times as --channel-name=IFO:AUX-CHANNEL-
NAME:RATE
--section-include=SECTION_INCLUDE
Set the channel sections to be included from the INI
file. Can be given multiple times. Pass in spaces as
underscores instead. If not specified, assumed to
include all sections
--safety-include=SAFETY_INCLUDE
Set the safety values for channels to be included from
the INI file. Can be given multiple times. Default =
'safe'.
--fidelity-exclude=FIDELITY_EXCLUDE
Set the fidelity values for channels to be excluded
from the INI file. Can supply multiple values by
repeating this argument. Each must be on of (add here)
--safe-channel-include=SAFE_CHANNEL_INCLUDE
Include this channel when reading the INI file
(requires exact match). Can be repeated. If not
specified, assume to include all channels.
--unsafe-channel-include=UNSAFE_CHANNEL_INCLUDE
Include this channel when reading the INI file,
disregarding safety information (requires exact
match). Can be repeated.