User programs

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

upv.cc: this is the main program to measure noise correlations and optimize time-domain vetoes for transient gravitational-wave searches.
upv-workflow-ccin2p3.cc: this program is used to build a UPV analysis workflow for the CCIN2P3 cluster.

Install UPV (conda)

Install UPV from the conda-forge channel:

conda create -c conda-forge --name upv upv

Simply activate your upv environment to use UPV libraries and programs:

conda activate upv

Build UPV from sources

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

export UPV_SRCDIR=${HOME}/src
export UPV_INSTALLDIR=${HOME}/opt/UPV
mkdir -p ${UPV_SRCDIR} ${UPV_INSTALLDIR}

You can download the UPV source tarball from gitlab:

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

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

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

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

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

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

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

# go to the source directory
cd ${UPV_SRCDIR}/UPV/

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

# configure UPV
cmake -DCMAKE_INSTALL_PREFIX=${UPV_INSTALLDIR} ${UPV_SRCDIR}/UPV

# compile UPV
make

# install UPV
make install

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

source ${UPV_INSTALLDIR}/etc/upv.env.sh

You can test that UPV is correctly installed by typing:

upv version

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

Documentation and links

General

UPV gitlab page: this is the code repository.
UPV issue tracker: use this link to report bugs, request new features...
Original UPV paper
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

Contributors:

Tomoki Isogai - Physics and Astronomy, Carleton College, Northfield, MN 55057, USA
Nelson Christensen - Observatoire de la cote d'Azur (Artemis) Nice, France