GstLAL documentation

GstLAL provides a suite of GStreamer elements that expose gravitational-wave data analysis tools from the LALSuite library for use in GStreamer signal-processing pipelines.

Examples include an element to add simulated gravitational waves to an h(t) stream, and a source element to provide the contents of .gwf frame files to a GStreamer pipeline.

Overview

The GstLAL software package is used for the following activities:

• gstlal provides core Gstreamer plugins for signal processing workflows with LIGO data and core python bindings for constructing such workflows.

• gstlal-inspiral provides additional signal processing plugins that are specific for LIGO / Virgo searches for compact binaries as well as a substantial amount of python code for post-processing raw signal processing results into gravitational wave candidate lists. Several publications about the methodology and workflow exist, see Publications

• gstlal-burst provides additional signal processing plugins for use in astrophysical and noise transient burst searches.

• gstlal-ugly is an incubator project for gradual inclusion in the other packages.

Getting Started

• Installation
  • Installing the latest release
  • IGWN distributions of GstLAL
  • Building from source
  • Math-optimized Libraries
• Quickstart
• Tutorials
  • Tutorial: Generation of simulated data
  • Running an online compact binary coalescence analysis
  • Running an offline compact binary coalescence analysis

User Guide

• CBC Analysis (Offline)
  • Running Workflows
  • Configuration
  • Installing Custom Site Profiles
• PSD Generation
• Simulated Data
• Workflow Configuration
• Publications

Developer Guide

• Local Development Environment
  • Creating the environment
  • Activating the environment
  • Using Developer Tools
  • Launching Applications
• Container Development Environment
  • Create a writable container
  • Check out gstlal
  • Develop
  • Build a component
  • Run your code
• Contributing Workflow
  • Git Branching
  • Merge Requests
• Contributing Documentation
  • Writing Documentation

API Reference

• Executables
  • gstlal
  • gstlal-inspiral
  • gstlal-burst
  • gstlal-ugly
• GstLAL API
  • gstlal
  • gstlal-inspiral
  • gstlal-burst
  • gstlal-ugly

Build/Test Results

Results pages for the Offline Tutorial Test are generated automatically and are located here:

• gstlal_offline_tutorial test dag

• gstlal_offline_tutorial test dag lite

Indices and tables

• Index

• Module Index

• Search Page