Usage: gstlal_ll_inspiral_event_uploader [--options]
an executable to aggregate and upload GraceDB events from gstlal_inspiral jobs
Options:
-h, --help show this help message and exit
-v, --verbose Be verbose.
--rootdir=path Sets the root directory where logs and metadata are
stored.
--num-jobs=NUM_JOBS number of jobs to listen to
--tag=string Sets the name of the tag used. Default = 'test'
--max-event-time=MAX_EVENT_TIME
Maximum time to keep around an event. Default = 2
hours.
--upload-cadence-type=string
Choose the method [geometric|linear] in which the
cadence of subsequent uploads are done. Default =
geometric.
--upload-cadence-factor=UPLOAD_CADENCE_FACTOR
Cadence factor T for sending out subsequent events for
the same event window. For geometric cadence, first
event gets sent T seconds later, second event gets
sent T^2 seconds later, etc. For linear cadence,
subsequent events get sent T seconds later. Default =
4.0.
--selection-criteria=SELECTION_CRITERIA
Choose method for determining favored event. Select
one of the following: 1. MAXSNR - upload highest SNR
candidate *below* public alert threshold (default). 2.
MINFAR - upload lowest FAR candidate. 3. COMPOSITE -
upload composite event by assigning the minimum FAR to
the highest SNR candidate.
--far-threshold=FAR_THRESHOLD
FAR threshold considered for an event to be public,
not including a trials factor. Default = 1 / month
--far-trials-factor=FAR_TRIALS_FACTOR
Trials factor for number of CBC pipelines uploading
events to GraceDB. Default = 1.
--processing-cadence=PROCESSING_CADENCE
Rate at which the event uploader 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=string Sets the input kafka topic. Required.
--gracedb-group=name Gracedb group to which to upload events (default is
Test).
--gracedb-pipeline=name
Name of pipeline to provide in GracedB uploads
(default is gstlal).
--gracedb-search=name
Name of search to provide in GracedB uploads (default
is LowMass).
--gracedb-service-url=url
Override default GracedB service url (optional,
default is https://gracedb.ligo.org/api/).
--scald-config=path sets ligo-scald options based on yaml configuration.