User programs

The VetoPerf package comes with a collection of user programs using VetoPerf libraries:

vp-makeperf.cc: this is the main program to measure the performance of time-domain vetoes against a set of triggers.
dq-print.cc: this program prints information about online data quality channels (active channels and time segments)

Install VetoPerf (conda)

Install VetoPerf from the conda-forge channel:

conda create -c conda-forge --name vetoperf vetoperf

Simply activate your vetoperf environment to use VetoPerf libraries and programs:

conda activate vetoperf

Build VetoPerf from sources

First, define your source and installation directories. For example:

export VETOPERF_SRCDIR=${HOME}/src
export VETOPERF_INSTALLDIR=${HOME}/opt/VetoPerf
mkdir -p ${VETOPERF_SRCDIR} ${VETOPERF_INSTALLDIR}

You can download the VetoPerf source tarball from gitlab:

 cd ${VETOPERF_SRCDIR}
 wget https://git.ligo.org/virgo/virgoapp/VetoPerf/-/archive/[X.Y.Z]/VetoPerf-[X.Y.Z].tar.gz
 tar -xzf VetoPerf-[X.Y.Z].tar.gz

where [X.Y.Z] is the VetoPerf version of your choice.

Alternatively, you can get a development copy of the VetoPerf software using git and select a release tag:

 cd ${VETOPERF_SRCDIR}
 git clone https://git.ligo.org/virgo/virgoapp/VetoPerf.git
 cd VetoPerf/
 git checkout [X.Y.Z]

The VetoPerf package relies on several external packages which you must install on your machine:

Omicron libraries offer many analysis tools needed by VetoPerf.
CMake is used to build VetoPerf.
Doxygen is used to build the VetoPerf documentation. This package is optional.

Here, we give step-by-step instructions to build VetoPerf for UNIX (bash/sh) systems.

# go to the source directory
cd ${VETOPERF_SRCDIR}/VetoPerf/

# create the build directory
mkdir ./build/; cd ./build/

# configure VetoPerf
cmake -DCMAKE_INSTALL_PREFIX=${VETOPERF_INSTALLDIR} ${VETOPERF_SRCDIR}/VetoPerf

# compile VetoPerf
make

# install VetoPerf
make install

An environment script has been generated. It must be sourced before using VetoPerf:

source ${VETOPERF_INSTALLDIR}/etc/vetoperf.env.sh

You can test that VetoPerf is correctly installed by typing:

vp-makeperf version

If you have the Doxygen software installed in your machine, you can access VetoPerf documentation with a web browser at file://${VETOPERF_INSTALLDIR}/share/doc/VetoPerf/html/index.html.

Documentation and links

General

VetoPerf gitlab page: this is the code repository.
VetoPerf issue tracker: use this link to report bugs, request new features...
Laboratoire de Physique des 2 infinis Irène Joliot-Curie (IJCLab)

Authors

Florent Robinet - Laboratoire de Physique des 2 Infinis Irène Joliot-Curie (IJCLab) Orsay, France - contact