.. include:: ../images.rst Installing a local copy of the cWB libraries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. important:: Before the installation of cWB it is necessary to install the `auxiliary libraries <../install.html#how-to-install-the-auxiliary-libraries>`__ **$HOME_LIB** is the enviromental variable pointing to the auxiliary libraries path The cWB pipeline is implemented in the **cWB library** which contains the algorithms and the pipeline infrastructure. The pipeline uses the **cWB config** which contains the configurations files and the search procedures. The following table reports the list of of steps to be executed to install the cWB pipeline: +--------------------------------------------------------------+------------------------------------------------------+ | `1 - cWB config installation <#cwb-config-installation>`__ | the configurations-files and search-procedures | +--------------------------------------------------------------+------------------------------------------------------+ | `2 - cWB library installation <#cwb-library-installation>`__ | the algorithm-library and pipeline-infrastructure | +--------------------------------------------------------------+------------------------------------------------------+ | `3 - cWB www files setting <#cwb-www-setup>`__ | html, javascripts and images used by CEDs & reports | +--------------------------------------------------------------+------------------------------------------------------+ | `4 - cWB test installation <#test-cwb-installation>`__ | quick tests to check the cWB installation | +--------------------------------------------------------------+------------------------------------------------------+ | 1 - cWB config installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ **What is**: configuration files used by the cWB pipeline to perform the analysis .. note:: We provide two git repositories: - |PUBLIC| https://gitlab.com/gwburst/public/config.git The public release contains the configuration files and the search procedures used for the production and post-production analysis. It includes also specific procedures and instructions to permit the analysis of the `DATA `__ released in the `Gravitational Wave Open Science Center ( GWOSC ) `__. | - |LVK| https://git.ligo.org/cWB/config_o3.git It includes all features of the public version + the specific procedures and instructions to permit the analysis of data available in the CIT cluster Such files are stored in an orphan branch named **LVC** of the config_o3 project. It contains the frame lists, data quality and xml files used for O1/O2/O3 analysis. **Installation:** 1. Download cWB config from GIT Repository The suggested local directory where to download the repository is **$HOME/git/cWB** .. code-block:: bash - Go into the cloned git library directory cd $HOME/git/cWB For each specific case there is a dedicated DATA directory. - PUBLIC git repository Only GWOSC is included in the public config repository, such directory refer to the GWOSC public data. To set such DATA for analysis do: git clone https://gitlab.com/gwburst/public/config.git cd config git lfs install --skip-smudge git lfs pull -I XTALKS/wdmXTalk then, to use O3a run do: make DATA=GWOSC O3=O3a or for O3b run: make DATA=GWOSC O3=O3b - LIGO git repository For LVK collaboration (private) there is a specific DATA repository. To install and set such DATA for analysis do: git clone git@git.ligo.org:cWB/config_o3.git cd config_o3 git lfs install --skip-smudge git lfs pull -I XTALKS/wdmXTalk see 'Installation of LVC config data' By default the downloaded software is the last available version, if you need a specific version then use the following insructions: .. code-block:: bash - Go into the cloned git library directory and list the availables tags: git tag - then select a suitable TAG and do (suggested tag: cWB-6.3.0): git checkout TAG git checkout -b TAG 2. |LVK| Installation of LVC config data: .. code-block:: bash - after the config installation do: cd config_o3 git clone -b LVC git@git.ligo.org:cWB/config_o3.git LVC cd LVC git lfs install --skip-smudge - alternately to select a specific TAG (suggested tag: LVC-cWB-OfflineO3-v8) do: git clone -b 'TAG' --single-branch --depth 1 git@git.ligo.org:cWB/config_o3.git --branch LVC --tag LVC cd LVC git lfs install --skip-smudge git checkout -b TAG - lastly creates in config the symbolic links to LVK data to use O3a run do: make DATA=LVC O3=O3a or for O3b run: make DATA=LVC O3=O3b |LVK| At CIT the tagged versions are available in the following directory: /home/waveburst/SOFT/cWB/tags/config | 2 - cWB library installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **What is**: gravitational wave burst analysis software: algorithm library and pipeline infrastructure .. note:: We provide two git repositories: - |PUBLIC| https://gitlab.com/gwburst/public/library.git The public release of cWB ( cWB-6.4.0 version ) is compatible with the version used for the analysis of the LIGO and Virgo data collected during the Third Observational run O3. | - |LVK| https://git.ligo.org/cWB/library It includes all features of the public version + new developments for the Third Observational run O3. **Installation:** 1. Download cWB library from GIT Repository The suggested local directory where to download the repository is **$HOME/git/cWB** .. code-block:: bash - Go into the cloned git library directory cd $HOME/git/cWB - PUBLIC git repository git clone https://gitlab.com/gwburst/public/library.git - LIGO git repository git clone git@git.ligo.org:cWB/library.git By default the downloaded software is the last available version, if you need a specific version then use the following insructions: .. code-block:: bash - Go into the cloned git library directory and list the availables tags: git tag - then select a suitable TAG and do (suggested tag: cWB-6.4.0 (public) or cWB-OfflineO3-v14 (LVK only)): git checkout -b TAG |LVK| At CIT the tagged versions are available in the following directory: /home/waveburst/SOFT/cWB/tags/library 2. Setting the cWB environmental variables (The cWB init script) .. code-block:: bash - Copy the default init root file into the $HOME directory cp $HOME/git/cWB/library/tools/cwb/cwb.rootrc ~/.rootrc - Create a directory used by cWB to display from WEB the CEDs and reports produced by the cWB analysis. Example for CIT user do : mkdir ~/public_html/reports reports can be browse at (user must be substituted with the user name): https://ldas-jobs.ligo.caltech.edu/~user/reports/ - Go into the cloned git library directory and select one of the following watenv init scripts suitable for your environment (sh,csh=bash,tcsh): - cit_watenv.(sh,csh) -> default for CIT cluster - cnaf_watenv.(sh,csh) -> default for CNAF cluster - atlas_watenv.(sh,csh) -> default for ATLAS cluster - cascina_watenv.(sh,csh) -> default for CASCINA cluster - gatech_watenv.(sh,csh) -> default for GEORGIA-TECH cluster - virtualbox_watenv.(sh,csh) -> default for VIRTUALBOX machine - Copy the selected watenv init script: cp cit_watenv.(sh,csh) user_watenv.(sh,csh) - Edit and change the environmental parameters according to the paths where the auxiliary libraries and config files have been installed. setenv HOME_LIBS "/home/waveburst/SOFT/" # default location at CIT cluster setenv CWB_CONFIG "$HOME/git/cWB/config" # Location of cWB config - Execute the init script source user_watenv.(sh,csh) 3. Compile library .. code-block:: bash - Go into the cloned git library directory execute your cWB init script: source user_watenv.(sh,csh) - Compile cWB with the default settings (up to 4 detectors) make - Install cWB libraries to the default directory ($HOME/git/cWB/library/tools/install) make install # only install make winstall # compile + install with this option only the compiled shared library files are copied to the destination directory - It is possible to install cWB libraries into a specific directory: make install ODIR=your_specific_dir with this option all the library files and the compiled shared library files are copied to the destination directory (but the .git infos are excluded) 4. Compile cWB with specific options (the instructions refere to tcsh shell, for bash shell see for example $HOME/git/cWB/cit_watenv.sh): .. code-block:: bash - To compile cWB with up to 8 detectors capability make XIFO=8 - To compile cWB with/without LAL (default : enabled) set # disable unsetenv _USE_LAL # disable LAL in cWB # enable setenv _USE_LAL 1 # enable LAL in cWB setenv HOME_LAL "${HOME_LIBS}/LAL/lalsuite/master" setenv LAL_INC "${HOME_LAL}/include" setenv LALINSPINJ_EXEC "${HOME_LAL}/bin/lalapps_inspinj" - To compile cWB with/without HEALPix (default : enabled) set # disable unsetenv _USE_HEALPIX # disable HEALPix in cWB # enable setenv _USE_HEALPIX 1 # enable HEALPix in cWB setenv HOME_HEALPIX "${HOME_LIBS}/HEALPix/Healpix_3.40" setenv HOME_CFITSIO "${HOME_LIBS}/CFITSIO/cfitsio-3.45" - To compile cWB with eBBH (default : enabled) set # disable unsetenv _USE_EBBH # disable EBBH in cWB # enable setenv _USE_EBBH 1 # enable EBBH in CWB setenv HOME_CVODE "${HOME_LIBS}/CVODE/sundials-2.7.0/dist" .. important:: The cWB init script must located in the main cWB library directory, if the installation has been done in the non default directory then the destination directory must be used. To check the cWB environmental variables use the command: **cwb_watenv** | 3 - cWB WWW setup ~~~~~~~~~~~~~~~~~ cWB needs html files, javascripts and images to display the CEDs & reports from WEB. All such stuff must be located into a directory visible from WEB. .. note:: |LVK| For CIT cluster we suggest to use the pre-installed directory in the waveburst account: /home/waveburst/public_html/waveburst/WWW/ced which is the default path defined in the CIT init script file cwb_watenv.(sh.csh): setenv HOME_CED_PATH "/home/waveburst/public_html/waveburst/WWW/ced" To setup a local WWW directory use the script **$CWB_SCRIPTS/cwb_create_www.sh**. It is implemented for CIT user and VirtualBox Machine but it can be easily adapted others cases. To execute the script do: .. code-block:: bash 1) execute the cWB init script then run the script: 2) cd $HOME_WAT/tools/cwb/www make 3) $CWB_SCRIPTS/cwb_create_www.sh In CIT cluster it creates the directory: **$HOME/public_html/waveburst/WWW** | 4 - Test cWB installation ~~~~~~~~~~~~~~~~~~~~~~~~~ .. note:: The easiest way to check cWB has been installed correctly is to process with cWB the GWTC-1 public data released in `GWOSC `__. The analysis of GWTC-1 Catalog events can be easily performed with a dedicated cWB command: `cwb_gwosc <../commands.html#cwb-gwosc>`__. The command line to execute the full analysis of GW150914 event is: .. code-block:: bash cwb_gwosc GW=GW150914 all The output of the previous command is the Coherent Event Display ( CED ) of the GW150914 event. See the `CEDs of the GWTC-1 Catalog `__ See also `My first cWB pipeline test <../faq.html#my-first-cwb-pipeline-test>`__