.gitattributes

+*.gwf filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -28,4 +28,8 @@ configure
 */gnuscripts/missing
 */gnuscripts/py-compile
 */gnuscripts/test-driver
+*/tests/*.log
+*/tests/*.trs
 libtool
+.vscode
+.idea

.gitlab-ci.Dockerfile.e7-testing

+# This is a Dockerfile to build an EL7 MKL-optimized GstLAL 
+# runtime container. 
+
+FROM containers.ligo.org/alexander.pace/gstlal-dev/gstlal-dev:el7-testing
+
+# Labeling/packaging stuff:
+LABEL name="GstLAL Runtime Package, EL7 Testing" \
+      maintainer="Alexander Pace <alexander.pace@ligo.org>" \
+      date="2020-05-06" \
+      support="Reference Platform, EL7 (Testing)"
+
+USER root
+
+## Copy Optimized RPMs to container
+COPY rpms /rpms
+
+# Install Optimized RPMs, delete old RPMs
+RUN GLOBIGNORE="*calibration*" && \
+      yum makecache && \
+      yum -y localinstall /rpms/*.rpm && \
+      unset GLOBIGNORE
+
+# Update gstreamer registry cache:
+ENV GST_REGISTRY_1_0=/usr/share/gstreamer-1.0/.registry.bin
+RUN gst-inspect-1.0
+
+# Clean up and close-out
+
+#RUN rm -rf /rpms && \
+RUN yum clean all
+
+# Export MKL environment variables: 
+
+ENV MKL_INTERFACE_LAYER LP64
+ENV MKL_THREADING_LAYER SEQUENTIAL
+ENV GSTLAL_FIR_WHITEN 0
+ENV TMPDIR /tmp
+
+
+ENTRYPOINT bash
+

.gitlab-ci.Dockerfile.rl8

+ARG lalsuite_version_tag
+FROM containers.ligo.org/gstlal/gstlal-dev:$lalsuite_version_tag
+
+# Labeling/packaging stuff:
+LABEL name="GstLAL Runtime Package, RL8" \
+      maintainer="Alexander Pace <alexander.pace@ligo.org>" \
+      date="2022-05-03" \
+      support="Reference Platform, RL8"
+
+USER root
+
+## Copy Optimized RPMs to container
+COPY rpms /rpms
+
+# Install Optimized RPMs, delete old RPMs
+RUN sed -i "s|http://|https://|" /etc/yum.repos.d/*.repo
+RUN yum makecache && \
+    yum -y localinstall /rpms/*.rpm 
+
+# Update gstreamer registry cache:
+ENV GST_REGISTRY_1_0=/usr/share/gstreamer-1.0/.registry.bin
+RUN gst-inspect-1.0
+
+# Clean up and close-out
+
+RUN rm -rf /rpms && \
+    yum clean all
+
+# Export MKL environment variables: 
+
+ENV MKL_INTERFACE_LAYER LP64
+ENV MKL_THREADING_LAYER SEQUENTIAL
+ENV GSTLAL_FIR_WHITEN 0
+ENV TMPDIR /tmp
+
+ENTRYPOINT bash
+

.gitlab/CODEOWNERS

+#################################################################
+#                GstLAL Codeowners Specification                #
+#################################################################
+
+
+#################################################################
+#                    Repository-Level Files                     #
+#################################################################
+
+# Workflow files
+.gitignore @kipp.cannon @chad-hanna @alexander.pace @patrick.godwin
+.gitlab-ci.yml @kipp.cannon @chad-hanna @alexander.pace @patrick.godwin
+.gitlab/CODEOWNERS @kipp.cannon @chad-hanna @alexander.pace @patrick.godwin
+
+# Catch-all rule for repo (will be overridden by a more specific rule below)
+* @kipp.cannon @chad-hanna @alexander.pace @patrick.godwin
+
+
+#################################################################
+#                     GstLAL Package Files                      #
+#################################################################
+
+# Package catch-all
+gstlal/ @kipp.cannon @chad-hanna @alexander.pace @patrick.godwin
+
+# Specific modules
+gstlal/python/datasource.py @kipp.cannon @chad-hanna @alexander.pace @patrick.godwin @james.kennington
+
+
+#################################################################
+#                   GstLAL-Ugly Package Files                   #
+#################################################################
+
+# Package catch-all
+gstlal-ugly/ @kipp.cannon @chad-hanna @alexander.pace @leo.tsukada @cody.messick @patrick.godwin
+
+# GST Plugins
+gstlal-ugly/gst/framecpp/ @kipp.cannon @ed-maros
+gstlal-ugly/gst/gds/ @kipp.cannon @ed-maros
+gstlal-ugly/gst/nds/ @kipp.cannon @ed-maros
+
+
+#################################################################
+#                   GstLAL-Burst Package Files                  #
+#################################################################
+
+# Package catch-all
+gstlal-burst/ @patrick.godwin
+
+# Cosmic String
+gstlal-burst/gst/lal/gstlal_string_triggergen.* @daichi.tsuna
+gstlal-burst/python/string/ @daichi.tsuna
+
+
+#################################################################
+#                 GstLAL-Inspiral Package Files                 #
+#################################################################
+
+# Package catch-all
+gstlal-inspiral/ @kipp.cannon @chad-hanna @alexander.pace @leo.tsukada @cody.messick @patrick.godwin

Dockerfile.stretch

-# Start with the lalsuite nightly container:
-FROM containers.ligo.org/lscsoft/lalsuite/nightly:stretch
-
-# Labeling/packaging stuff:
-LABEL name="GstLAL Development Package, Debian" \
-      maintainer="Alexander Pace <alexander.pace@ligo.org>" \
-      date="20180625" \
-      support="Reference Platform, Stretch"
-
-# Set up the base user and build environment:
-# Note that I've had to install the following packages to get things to
-# work. Some duplication with the command line, but the list is clearer:
-#   * build-essential (gcc, etc.)
-#   * wget
-#   * vim
-#   * git
-#   * flex (from gobject-introspection)
-#   * bison (from gobject-introspection)
-#   * libffi-dev (from gobject-introspection)
-
-USER root
-
-# Define MKL version variables:
-ENV VERSION 2018
-ENV UPDATE 3
-ENV BUILD 051
-
-RUN apt-get update && apt-get install -y build-essential wget vim git flex bison libffi-dev git-lfs
-
-RUN wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS-2019.PUB && \
-    apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS-2019.PUB && \
-    sh -c 'echo deb https://apt.repos.intel.com/mkl all main > /etc/apt/sources.list.d/intel-mkl.list' && \
-    apt-get update && \
-    apt-get install -y intel-mkl-64bit-$VERSION.$UPDATE-$BUILD
-
-# Install system dependencies:
-RUN apt-get --assume-yes install gtk-doc-tools libfftw3-3 libfftw3-dev liborc-0.4-0 python-gobject-dev python-numpy python-scipy lscsoft-gds python-ligo-segments python3-ligo-segments
-
-# Set some environment variables. Hopefully these propagate to the
-# gitlab-ci environment. Possibly re-define and then just copy the stuff over.
-
-ENV GSTLAL_DIR /usr
-ENV PATH ${GSTLAL_DIR}/bin:${PATH}
-ENV PKG_CONFIG_PATH ${GSTLAL_DIR}/lib/pkgconfig:${GSTLAL_DIR}/lib64/pkgconfig:${PKG_CONFIG_PATH}
-ENV GI_TYPELIB_PATH ${GSTLAL_DIR}/lib/girepository-1.0:${GI_TYPELIB_PATH}
-ENV GST_PLUGIN_PATH ${GSTLAL_DIR}/lib/gstreamer-1.0:${GST_PLUGIN_PATH}
-ENV PYTHONPATH ${GSTLAL_DIR}/lib64/python2.7/site-packages:${GSTLAL_DIR}/lib/python2.7/site-packages:${PYTHONPATH}
-
-ENV MKLROOT=/opt/intel/compilers_and_libraries_2018.3.222/linux/mkl
-ENV LIBRARY_PATH=/opt/intel/compilers_and_libraries_2018.3.222/linux/tbb/lib/intel64_lin/gcc4.7:/opt/intel/compilers_and_libraries_2018.3.222/linux/compiler/lib/intel64_lin:/opt/intel/compilers_and_libraries_2018.3.222/linux/mkl/lib/intel64_lin
-ENV CPATH=/opt/intel/compilers_and_libraries_2018.3.222/linux/mkl/include
-ENV PATH=PATH=/opt/intel/compilers_and_libraries_2018.3.222/linux/bin/intel64:${PATH}
-ENV PKG_CONFIG_PATH /opt/intel/compilers_and_libraries_2018.3.222/linux/mkl/bin/pkgconfig:${PKG_CONFIG_PATH}
-ENV LD_LIBRARY_PATH /opt/intel/compilers_and_libraries_2018.3.222/linux/compiler/lib/intel64:/opt/intel/compilers_and_libraries_2018.3.222/linux/compiler/lib/intel64_lin:/opt/intel/compilers_and_libraries_2018.3.222/linux/tbb/lib/intel64_lin/gcc4.7:/opt/intel/compilers_and_libraries_2018.3.222/linux/compiler/lib/intel64_lin:/opt/intel/compilers_and_libraries_2018.3.222/linux/mkl/lib/intel64_lin
-
-# Set build variables:
-ENV CC gcc
-ENV CXX g++
-ENV CFLAGS "-O3 -fPIC -DMKL_ILP64 -m64 -I${MKLROOT}/include -I${GSTLAL_DIR}/include"
-ENV LDFLAGS "-L${MKLROOT}/lib/intel64 -Wl,--no-as-needed -lmkl_intel_ilp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl"
-
-# These are the packages to download. Use the same nomenclature as the optimized Makefile.
-
-ENV GSTPYTHON gst-python-1.4.0
-ENV GSTPLUGINSGOOD gst-plugins-good-1.4.5
-ENV GSTPLUGINSBASE gst-plugins-base-1.4.5
-ENV GSTREAMER gstreamer-1.4.5
-ENV PYGOBJECT pygobject-3.28.0
-ENV GINTRO gobject-introspection-1.50.0
-
-# Make a tar directory and download packages:
-RUN mkdir /tars
-RUN mkdir /src
-
-RUN wget --no-check-certificate http://gstreamer.freedesktop.org/src/gst-python/${GSTPYTHON}.tar.xz --directory-prefix=/tars -nc
-RUN wget --no-check-certificate http://gstreamer.freedesktop.org/src/gst-plugins-good/${GSTPLUGINSGOOD}.tar.xz --directory-prefix=/tars -nc
-RUN wget --no-check-certificate http://gstreamer.freedesktop.org/src/gst-plugins-base/${GSTPLUGINSBASE}.tar.xz --directory-prefix=/tars -nc
-RUN wget --no-check-certificate http://gstreamer.freedesktop.org/src/gstreamer/${GSTREAMER}.tar.xz --directory-prefix=/tars -nc
-RUN wget --no-check-certificate http://ftp.gnome.org/pub/GNOME/sources/pygobject/3.28/${PYGOBJECT}.tar.xz --directory-prefix=/tars -nc
-RUN wget --no-check-certificate http://ftp.gnome.org/pub/gnome/sources/gobject-introspection/1.50/${GINTRO}.tar.xz --directory-prefix=/tars -nc
-
-# Get glue git repo:
-RUN cd /src && \
-    git clone https://git.ligo.org/lscsoft/glue.git
-#    cd glue && \
-#    python setup.py install --prefix=${GSTLAL_DIR}
-
-# Install gobject-introspection:
-RUN tar -xf /tars/${GINTRO}.tar.xz -C /src && \
-    cd /src/${GINTRO} && \
-    ./configure --prefix=${GSTLAL_DIR} --disable-static --with-python=/usr/bin/python && \
-    make && \
-    make install
-
-# Install pygobject:
-RUN tar -xf /tars/${PYGOBJECT}.tar.xz -C /src && \
-    cd /src/${PYGOBJECT} && \
-    ./configure --prefix=${GSTLAL_DIR} --with-python=python2 --enable-cairo=no && \
-    make && \
-    make install
-
-# Install gstreamer:
-RUN tar -xf /tars/${GSTREAMER}.tar.xz -C /src && \
-    cd /src/${GSTREAMER} && \
-    ./configure --prefix=${GSTLAL_DIR}  && \
-    make && \
-    make install
-
-# Install gst-plugins-base:
-RUN tar -xf /tars/${GSTPLUGINSBASE}.tar.xz -C /src && \
-    cd /src/${GSTPLUGINSBASE} && \
-    ./configure --prefix=${GSTLAL_DIR}  && \
-    make && \
-    make install
-
-# Install gst-plugins-good:
-RUN tar -xf /tars/${GSTPLUGINSGOOD}.tar.xz -C /src && \
-    cd /src/${GSTPLUGINSGOOD} && \
-    ./configure --prefix=${GSTLAL_DIR}  && \
-    make && \
-    make install
-
-# Install gst-python:
-RUN tar -xf /tars/${GSTPYTHON}.tar.xz -C /src && \
-    cd /src/${GSTPYTHON} && \
-    #mkdir -p ${GSTLAL_DIR}/lib64/python2.7/site-packages/gi/overrides && \
-    ./configure --prefix=${GSTLAL_DIR} --exec-prefix=${GSTLAL_DIR} --with-libpython-dir=/usr/lib/python2.7/config-x86_64-linux-gnu --with-pygi-overrides-dir=${GSTLAL_DIR}/lib/python2.7/dist-packages/gi/overrides && \
-    make && \
-    make install
-
-# Install glue:
-RUN cd /src/glue &&  \
-    #python setup.py install
-    python setup.py install --prefix=${GSTLAL_DIR}
-
-# Install some stuff needed for documentation. I'm putting it as part of this
-# container because it takes for-freaking-ever to install in CI:
-
-RUN apt-get --assume-yes install doxygen graphviz python-matplotlib python3-matplotlib
-
-# Dumb hack to get ligolw_segments from the python-pylal package. I can't just install
-# python-pylal because it's been depreciated and because there are conflicts with files
-# that are coming from lalapps.
-
-RUN mkdir pylaltmp && \
-    apt-get install --download-only -o=dir::cache=./pylaltmp python-pylal && \
-    ls ./pylaltmp/* && \
-    dpkg-deb -x pylaltmp/archives/python-pylal*.deb pylaltmp && \
-    sed -i 's/pylal/glue/g' pylaltmp/usr/bin/ligolw_segments && \
-    cp pylaltmp/usr/bin/ligolw_segments /usr/bin && \
-    rm -r pylaltmp
-
-
-# Set up a random uid for the avahi user before starting the daemon.
-
-#RUN randuid=$(od -An -N1 -i /dev/random) && \
-#    adduser --uid $randuid avahi
-RUN apt-get --assume-yes install python-avahi avahi-daemon
-
-# Clean up and close-out
-
-RUN rm -rf /tars /src
-
-# Build gstreamer registry cache:
-
-RUN gst-inspect-1.0
-#ENV GST_REGISTRY_UPDATE=no
-
-ENTRYPOINT service dbus start && service avahi-daemon start && bash
\ No newline at end of file

README.md

-# GstLAL Project
+![gstlal](https://git.ligo.org/lscsoft/gstlal/raw/master/doc/source/_static/gstlal.png "gstlal")
 
-Welcome to the GstLAL project.  Please find doc pages here: https://lscsoft.docs.ligo.org/gstlal/
\ No newline at end of file
+GStreamer elements for gravitational-wave data analysis
+==================================================================
+
+[![pipeline status](https://git.ligo.org/lscsoft/gstlal/badges/master/pipeline.svg)](https://git.ligo.org/lscsoft/gstlal/commits/master)
+
+|                      | version  | source   |
+| :------------------: | :------: | :------: |
+| `gstlal`             | 1.9.0    | [gstlal-1.9.0.tar.gz](http://software.igwn.org/lscsoft/source/gstlal-1.9.0.tar.gz)  |
+| `gstlal-ugly`        | 1.9.1    | [gstlal-ugly-1.9.1.tar.gz](http://software.igwn.org/lscsoft/source/gstlal-ugly-1.9.1.tar.gz)  |
+| `gstlal-inspiral`    | 1.9.1    | [gstlal-inspiral-1.9.1.tar.gz](http://software.igwn.org/lscsoft/source/gstlal-inspiral-1.9.1.tar.gz)  |
+| `gstlal-burst`       | 0.3.1    | [gstlal-burst-0.3.1.tar.gz](http://software.igwn.org/lscsoft/source/gstlal-burst-0.3.1.tar.gz)  |
+
+Full documentation is provided [here](https://lscsoft.docs.ligo.org/gstlal/).
+
+**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 Ugly: An incubator project for gradual inclusion in the other packages.

doc/Makefile

+IS_CI ?= 0
+
 gstlal-modules :
 	# FIXME FIXME FIXME total hack to work around unique python packaging
-	#mv ../gstlal/python/__init__.py ../gstlal/python/__init__.py.bk
+	if [ $(IS_CI) = 0 ]; then \
+		mv ../gstlal/python/__init__.py ../gstlal/python/__init__.py.bk; \
+	fi
 	sphinx-apidoc -e -o source/gstlal/python-modules ../gstlal/python ../gstlal/python/misc.py ../gstlal/python/bottle.py ../gstlal/python/coherent_null.py ../gstlal/python/matplotlibhelper.py
-	#mv ../gstlal/python/__init__.py.bk ../gstlal/python/__init__.py
+	if [ $(IS_CI) = 0 ]; then \
+		mv ../gstlal/python/__init__.py.bk ../gstlal/python/__init__.py; \
+	fi
+	sed -i "1s/python/\`\`gstlal\`\`/" source/gstlal/python-modules/modules.rst
 
 gstlal-inspiral-modules :
 	sphinx-apidoc -e -o source/gstlal-inspiral/python-modules ../gstlal-inspiral/python ../gstlal-inspiral/python/cbc_template_iir.py ../gstlal-inspiral/python/spawaveform.py ../gstlal-inspiral/python/emcee.py ../gstlal-inspiral/python/spiirparts.py ../gstlal-inspiral/python/snglinspiraltable.py
-
-gstlal-calibration-modules :
-	sphinx-apidoc -e -o source/gstlal-calibration/python-modules ../gstlal-calibration/python
+	sed -i "1s/python/\`\`gstlal-inspiral\`\`/" source/gstlal-inspiral/python-modules/modules.rst
 
 gstlal-burst-modules :
 	sphinx-apidoc -e -o source/gstlal-burst/python-modules ../gstlal-burst/python ../gstlal-burst/python/excesspower ../gstlal-burst/python/fxtools/sngltriggertable.py
+	sed -i "1s/python/\`\`gstlal-burst\`\`/" source/gstlal-burst/python-modules/modules.rst
 
 gstlal-ugly-modules :
 	sphinx-apidoc -e -o source/gstlal-ugly/python-modules ../gstlal-ugly/python ../gstlal-ugly/python/gviz_api.py ../gstlal-ugly/python/coherent_inspiral_metric.py  ../gstlal-ugly/python/coherent_inspiral_metric_plots.py ../gstlal-ugly/python/coherent_inspiral_metric_detector_details.py ../gstlal-ugly/python/aggregator.py 
+	sed -i "1s/python/\`\`gstlal-ugly\`\`/" source/gstlal-ugly/python-modules/modules.rst
 
 gstlal-bin :
 	./sphinx-bindoc source/gstlal/bin ../gstlal/bin gstlal_ligo_data_find_check
+	sed -i "1s/bin/\`\`gstlal\`\`/" source/gstlal/bin/bin.rst
 
 gstlal-inspiral-bin :
-	./sphinx-bindoc source/gstlal-inspiral/bin ../gstlal-inspiral/bin gstlal_inspiral_flopulator gstlal_inspiral_lvalert_omegascan gstlal_ll_inspiral_calculate_range gstlal_ll_inspiral_daily_page_online gstlal_iir_inspiral gstlal_inspiral_iir_bank_pipe gstlal_ll_inspiral_save_state gstlal_inspiral_marginalize_likelihoods_online gstlal_inspiral_plot_extrinsic_params gstlal_ll_inspiral_get_urls gstlal_inspiral_plot_svd_bank gstlal_inspiral_lvalert_background_plotter 
-
-gstlal-calibration-bin :
-	./sphinx-bindoc source/gstlal-calibration/bin ../gstlal-calibration/bin
+	./sphinx-bindoc source/gstlal-inspiral/bin ../gstlal-inspiral/bin gstlal_inspiral_flopulator gstlal_inspiral_lvalert_omegascan gstlal_ll_inspiral_calculate_range gstlal_ll_inspiral_daily_page_online gstlal_iir_inspiral gstlal_inspiral_iir_bank_pipe gstlal_ll_inspiral_save_state gstlal_inspiral_marginalize_likelihoods_online gstlal_inspiral_plot_extrinsic_params gstlal_ll_inspiral_get_urls gstlal_inspiral_plot_svd_bank gstlal_inspiral_lvalert_background_plotter gstlal_inspiral_add_p_of_ifos_given_horizon gstlal_inspiral_add_dt_dphi_snr_ratio_pdfs 
+	sed -i "1s/bin/\`\`gstlal-inspiral\`\`/" source/gstlal-inspiral/bin/bin.rst
 
 gstlal-burst-bin :
 	./sphinx-bindoc source/gstlal-burst/bin ../gstlal-burst/bin gstlal_excesspower gstlal_excesspower_trigvis
+	sed -i "1s/bin/\`\`gstlal-burst\`\`/" source/gstlal-burst/bin/bin.rst
 
 gstlal-ugly-bin :
 	./sphinx-bindoc source/gstlal-ugly/bin ../gstlal-ugly/bin gstlal_h1h2_coh_frames gstlal_geo_player gstlal_ll_inspiral_daily_summary_page gstlal_cache_to_segments gstlal_inspiral_plot_efficiency gstlal_burst_injections_by_rate_plot gstlal_display_from_logs gstlal_inspiral_bankviz gstlal_ll_inspiral_regen_reg_from_condor_q gstlal_cbc_sensitivity_vs_flow_at_fixed_computational_cost gstlal_inspiral_check_livetimes gstlal_rds_gen gstlal_injections_by_local_rate_plot gstlal_ninja_smooth_reference_psd gstlal_shift_frames 
+	sed -i "1s/bin/\`\`gstlal-ugly\`\`/" source/gstlal-ugly/bin/bin.rst
 
-html : gstlal-modules gstlal-inspiral-modules gstlal-calibration-modules gstlal-ugly-modules gstlal-burst-modules gstlal-bin gstlal-inspiral-bin gstlal-calibration-bin gstlal-ugly-bin gstlal-burst-bin
+html : gstlal-modules gstlal-inspiral-modules gstlal-ugly-modules gstlal-burst-modules gstlal-bin gstlal-inspiral-bin gstlal-ugly-bin gstlal-burst-bin
 	sphinx-build -b html source _build
 
 clean :

doc/source/_static/css/my_theme.css

+/* Uses skorch docs theme from https://skorch.readthedocs.io */
+
+.wy-side-nav-search {
+    background-color: #ffffff;
+
+}
+
+.wy-side-nav-search > div.version {
+    color: black;
+}
+
+.wy-side-nav-search > a {
+    color: black;
+}
+
+/* Adds logo in header for mobile */
+
+.wy-nav-top {
+    background-color: #ffffff;
+    background-image: url('../logo.svg');
+    background-repeat: no-repeat;
+    background-position: bottom;
+    padding: 0;
+    margin: 0.4045em 0.809em;
+    color: #333;
+}
+
+.wy-nav-top > a {
+    display: none;
+}