.. include:: images.rst 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"/"containerized" environment: you can freely choose between cWB `VirtualBox image `__ and cWB `Docker container `__. Instructions on how to run cWB on VirtualBox and Docker are reported in the FAQs, `here `__ and `here `__, repectively. The ensemble of the following two Dockerfiles, i.e. `Dockerfile1 `__ and `Dockerfile2 `__, from the cWB public container project can be regarded as a step-by-step procedure to install a complete cWB environment on a Debian Bullseye (i.e. 11.X) system. Before installing cWB, all the needed `auxiliary libraries `__ have to be already installed. |LVK| : cWB libraries are already pre-installed on the LIGO-Virgo clusters together with the auxiliary libraries. In case you want to compile a specific version or make some changes to the code, you can use the pre-installed auxiliary libraries and go directly to `cWB install <#how-to-install-the-cwb-libraries>`__. .. attention:: cWB libraries have been tested mainly on Scientific Linux (CentOS) 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.9 (Nitrogen) it is possible to download a tgz file with all pre-compiled auxiliary libraries from this link: `cWB_Auxiliary_Libraries_SL79_64bit_v1.tgz `__ or from CIT cluster |LVK| : `cWB_Auxiliary_Libraries_SL79_64bit_v1.tgz `__ First, the directories where the packages will be imstalled must be created: .. code-block:: bash setenv HOME_LIBS "user libraries path" mkdir $HOME_LIBS cd $HOME_LIBS mkdir ROOT FRAMELIB HEALPix CFITSIO BAUDLINE LAL CVODE SKYMAP WAT #. **ROOT** is an object oriented framework for large scale data analysis #. **HEALPix** is an acronym for Hierarchical Equal Area isoLatitude Pixelization of a sphere #. **CFITSIO** is a library of C and Fortran subroutines for reading and writing data files in FITS (Flexible Image Transport System) data format #. **FRAMELIB** is a software (Frame Library) dedicated to the frame manipulation including file input/output #. **Baudline** is a time-frequency browser designed for scientific visualization of the spectral domain. #. **LAL** is a package including various gravitational wave data analysis routines #. **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: .. toctree:: :hidden: :maxdepth: 1 :caption: Auxiliary-Libraries install/root install/framelib install/healpix install/cfitsio install/lal install/cvode install/skymap +-------------------------------------------------------------+------------+----------------------------+ | `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: .. toctree:: :hidden: :maxdepth: 1 :caption: cWB-Libraries install/cwb #. **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 #. **The user wants to perform an analysis with the libraries already installed in the LVK computing clusters** |LVK| .. 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**): .. code-block:: bash 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: .. code-block:: bash CIT: /home/waveburst/SOFT CNAF: /opt/exp_software/virgo/virgoDev/waveburst/SOFT | For the **tcsh shell**, replace \*_watenv.sh with \*_watenv.csh.