.. include:: images.rst


Software
--------

This page provides an overview of the internal and external libraries
required to run an analysis with cWB. The architecture is summarised by
the following image. For a more detailed explanation, see below in this
page.

| 
|  |image7|
|

cWB libraries
~~~~~~~~~~~~~

.. toggle-header::
    :header: Show/Hide Block Diagram

    |image8|
       :align: center


The following links provide relevant information on the cWB libraries:

-  `cWB Data classes <https://gwburst.gitlab.io/public/library/html/files.html>`__
   : overview of the classes used to handle gravitational-wave data 

.. toggle-header::
    :header: Show/Hide Block Diagram

    |image9|
       :align: center


-  `cWB Network classes <https://gwburst.gitlab.io/public/library/html/files.html>`__
   : overview of the classes used for the network analysis 

.. toggle-header::
    :header: Show/Hide Block Diagram

    |image10|
       :align: center


-  `cWB pipeline classes <https://gwburst.gitlab.io/public/library/html/files.html>`__
   : overview of the classes used by the cWB pipeline 

   -  The pipeline base :cwb_library:`cwb`
   -  The 1G pipeline :cwb_library:`cwb1G` (obsolete, is no longer maintained)
   -  The 2G pipeline :cwb_library:`cwb2G`

.. toggle-header::
    :header: Show/Hide Block Diagram

    |image11|
       :align: center


-  `GIT Repository <https://git.ligo.org/cWB/library>`__
   : web interface of the git repository hosting the cWB libraries


-  GIT Structure

   -  overview of the cWB directories on git

.. toggle-header::
    :header: Show/Hide Structure

    .. literalinclude:: logs/cwb_library_structure.txt
       :language: bash


-  `Library at CIT - /home/waveburst/SOFT/GIT/cWB/library <https://git.ligo.org/cWB/library>`__:
   path to the cWB library at CIT

| 

Auxiliary libraries
~~~~~~~~~~~~~~~~~~~

.. toggle-header::
    :header: Show/Hide Block Diagram

    |image12|
       :align: center


The internal libraries make use of external libraries. Information on
the external libraries and on where to find them  CIT are available below:

-  `Documentation <links.html#links>`__: list of the links to external libraries
-  `Libraries at CIT: /home/waveburst/SOFT <https://ldas-jobs.ligo.caltech.edu/~waveburst/LSC/soft/>`__:
   path to the external libraries and pakages at CIT

Two external libraries are necessary to run cWB:
`ROOT <http://root.cern.ch>`__ and
`FRAMELIB <http://lappweb.in2p3.fr/virgo/FrameL>`__. The ROOT libraries,
in particular, are used in two modes: the compiled mode, as a general library, and the `interpreted
mode <https://root.cern.ch/cling>`__, as an interpreter for
C and C++ code. The cWB classes are accessible via the interpreter and
can be used interactively via the root shell or as ROOT macros
(`tutorials <tutorials.html#tutorials>`__.
The pre and post-production `commands <commands.html#commands>`__ are implemented as
ROOT macros : `pipeline macros <https://git.ligo.org/cWB/library/tree/master/tools/cwb/macros>`__