# Installation¶

This page provides a guide to the installation of the cWB pipeline.

Note

The easiest way to start using cWB on your computer is to install an “image” of cWB within a “virtualized” environment: you can freely choose between the cWB VirtualBox image and the cWB Docker container. Instructions on how to run cWB on VirtualBox and Docker are reported in the cWB User Manual, here and here, repectively.

Before the installation of cWB, it is necessary to install the auxiliary libraries needed to run an analysis with cWB. In case the user makes use of the cWB libraries on the LIGO-Virgo clusters, the pre-installed auxiliary libraries can be considered, in case go to cWB install. In case the user wants to install the cWB libraries on his/her local computer, the auxiliary libraries must be present on the same machine.

Attention

The cWB libraries have been tested mainly on Scientific Linux and Debian Linux distributions (though we don’t expect major problems from installing cWB on different Linux distributions). cWB can also be installed on Mac OS X (with some minor modifications).

## How to install the auxiliary libraries¶

Note

For Scientific Linux 7.6 (Nitrogen) it is possible to download a tgz file with all pre-compiled auxiliary libraries from this link: cWB_Auxiliary_Libraries_SL76_64bit_v3.tgz or from CIT cluster : cWB_Auxiliary_Libraries_SL76_64bit_v3.tgz

First, the directories where the packages will be imstalled must be created:

setenv HOME_LIBS "user libraries path"
mkdir $HOME_LIBS cd$HOME_LIBS
mkdir ROOT FRAMELIB HEALPix CFITSIO BAUDLINE LAL CVODE SKYMAP WAT

1. ROOT is an object oriented framework for large scale data analysis
2. HEALPix is an acronym for Hierarchical Equal Area isoLatitude Pixelization of a sphere
3. CFITSIO is a library of C and Fortran subroutines for reading and writing data files in FITS (Flexible Image Transport System) data format
4. FRAMELIB is a software (Frame Library) dedicated to the frame manipulation including file input/output
5. Baudline is a time-frequency browser designed for scientific visualization of the spectral domain.
6. LAL is a package including various gravitational wave data analysis routines
7. CVODE (used by eBBH) solves initial value problems for ordinary differential equation (ODE) systems

The following table reports the list of the auxiliary libraries and their instructions:

 ROOT mandatory FRAMELIB mandatory HEALPix mandatory CFITSIO mandatory needed by HEALPix Baudline optional time-frequency display LAL optional nedeed for CBC simulation CVODE optional needed by eBBH simulation SKYMAP optional produce skymap-display

## How to install the cWB libraries¶

Two scenarios are considered:

1. The user wants to perform an analysis with a local copy of the cWB libraries: Installing a local copy of the cWB libraries.

Note

recommended for users willing to use a specific version and/or customize the libraries

2. The user wants to perform an analysis with the libraries already installed in the LVC computing clusters

Attention

Pre-installed Librares could be outdated and may be changed without any notice. If you need a specific version you have to install a local copy of the cWB library

The CWB libraries are available in the following computing clusters: CIT and CNAF. The pre-installed libraries can be used by running the cWB configuration file. The environment is set up as follows (assuming bash shell):

source $HOME_LIBS/GIT/cWB/library/[cit/cnaf]_watenv.sh cp$HOME_LIBS/GIT/cWB/library/tools/cwb/cwb.rootrc ~/.rootrc


The \$HOME_LIBS path depends on the cluster:

CIT:  /home/waveburst/SOFT
CNAF: /opt/exp_software/virgo/virgoDev/waveburst/SOFT

For the tcsh shell, replace *_watenv.sh with *_watenv.csh.