.. 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 `_ . .. 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 `_) 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 is `cWB-6.4.8.0 `_. The most recent version used for an LVK analysis is `cWB-6.4.6.9 `_ (O4c). The last version submitted to Zenodo, `cWB-6.4.7.0 `_, can be found on: .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17107610.svg :target: https://doi.org/10.5281/zenodo.17107610 .. important:: Some instructions and documents reported in this manual are addressed only to LIGO-Virgo-KAGRA Collaboration (LVK) / cWB developers, or only to 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|. Nevertheless, since documentation update is not complete yet, it is not guaranteed that all outdated pages are marked so. .. warning:: |DEPRECATED| The following tools are deprecated and will be removed in cWB 6.4.7.0: - **FrDisplay** (see :doc:`frdisplay`): graphical data display tool based on Baudline - **ANN** (see :doc:`ann`): artificial neural network support (replaced by :doc:`xgboost`) - **Bico**: bicoherence analysis tool - **WaveGraph**: a wavelet graphs utility to search for CBC signals .. attention:: The cWB has been developed for Linux operating systems. It is configured to work on Linux distributions such as: - Rocky Linux 8, 9 - Debian GNU/Linux bullseye, bookworm, trixie cWB can also be used with other Linux distributions or with OSX on x86_64 (with some minor modifications) but it is not officially supported. OSX on ARM (Apple Silicon) is not supported. | .. toctree:: :maxdepth: 1 :caption: Getting Started overview software install changelog .. toctree:: :maxdepth: 1 :caption: Pipeline flowchart running commands openmp .. toctree:: :maxdepth: 1 :caption: Tools ced plugins tutorials mdc xmdc frdisplay gwat toolbox regression online ann xgboost .. toctree:: :maxdepth: 1 :caption: Miscellaneous topics faq documents links .. toctree:: :maxdepth: 1 :caption: Documentation docs