gstlal_snax_generate

Command line options

Usage: gstlal_snax_generate [--options]

an executable to generate synthetic low-latency features

Options:
  -h, --help            show this help message and exit
  --processing-cadence=PROCESSING_CADENCE
                        Rate at which the generator processes data. Default =
                        0.1 seconds.
  --output-topic=string
                        Sets the output kafka topic name. Required.
  --target-channel=string
                        Sets the target channel name. Required.

  Generator Options:
    General settings for configuring the generator.

    -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.
    --instrument=string
                        Sets the instrument for files written to disk. Default
                        = H1
    --tag=string        Sets the name of the tag used. Default = 'test'
    --sample-rate=Hz    Set the sample rate for feature timeseries output,
                        must be a power of 2. Default = 1 Hz.
    --kafka-server=string
                        Sets the server url that the kafka topic is hosted on.
                        Required.

  Channel Options:
    Settings used for deciding which auxiliary channels to generate.

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