.. include:: images.rst

===========================
coherent WaveBurst 
===========================

coherent WaveBurst (cWB) is a data-analysis tool to search for a broad range of gravitational-wave (GW) transients.
The pipeline identifies coincident events in the GW data from earth-based
interferometric detectors and reconstructs the gravitational wave signal by using a constrained maximum 
likelihood approach. coherent WaveBurst was the `first algorithm to identify the gravitational wave signal GW150914 
detected by LIGO <https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.116.061102>`_ .

.. figure:: images/GW150914_cwb_ced.png
   :alt: map to buried treasure
   :align: center

   First shots of GW150914 event detected by coherent Waveburst - Livingston (left), Hanford (right)

|

Infos
----- 

.. note::
   The cWB library is publicly available (`here <https://gitlab.com/gwburst/public/library>`_) under the:  
    .. image:: https://img.shields.io/badge/license-GPLv3-lightgray.svg
       :target: https://choosealicense.com/licenses/gpl-3.0/

.. note::
   The current public version of cWB (`cWB-6.4.3.4 <https://gitlab.com/gwburst/public/library/-/tags/cWB-6.4.3.4>`_)
   is fully compatible with the one used for the LVK O3 analysis. The previous version, cWB-6.4.1 can also be found on: 
    .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5798976.svg
       :target: https://doi.org/10.5281/zenodo.5798976 

.. important::
   Some instructions and documents reported in this manual are addressed 
   only to LIGO-Virgo-KAGRA Collaboration (LVK) / cWB developers or for Public Version users. 

+------------------------------------+------------------------------------------------------------------------------------+
| LVK users are marked as:           | .. figure:: https://img.shields.io/badge/Users%20LVK-Only-orange.svg               |
+------------------------------------+------------------------------------------------------------------------------------+
| cWB developers are marked as:      | .. figure:: https://img.shields.io/badge/Developers%20cWB-Only-orange.svg          |
+------------------------------------+------------------------------------------------------------------------------------+
| Public Version Only is marked as:  | .. figure:: https://img.shields.io/badge/Public%20Version-Only-orange.svg          |
+------------------------------------+------------------------------------------------------------------------------------+

.. important::
   Somewhat outdated materials have also been reported mainly for reference and are marked as |TBU|.
   Nethertheless, since documentation update is not complete yet, it is not guaranteed that all outdated pages are marked so.
   

.. attention::
   The cWB has been developed for Linux operating systems.
   It is configured to work on Linux distributions such as:

   - Scientific Linux 7.x
   - Rocky Linux 8
   - Debian GNU/Linux buster, bullseye, bookworm 
   
   cWB can also be used with other Linux distributions or with OSX (with some minor modifications) but it is not officially supported.

|
 
.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   overview
   software
   install
   changelog


.. toctree::
   :maxdepth: 1
   :caption: Pipeline 

   flowchart
   running
   commands


.. toctree::
   :maxdepth: 1
   :caption: Tools

   ced
   plugins
   tutorials
   mdc
   frdisplay
   gwat
   toolbox
   regression
   online
   ann
   xgboost

 
.. toctree::
   :maxdepth: 1
   :caption: Miscellaneous topics

   faq
   documents
   links

 
.. toctree::
   :maxdepth: 1
   :caption: Documentation

   docs