.. include:: images.rst


Commands
********

This page lists the commands for performing analyses with CWB. The
commands are implemented as shell scripts (tcsh/bash) and are based on
ROOT macros.

**Pre-production**

+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_mkdir <#cwb-mkdir>`__               |  creates the working directory and subdirectories                                      |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_clonedir <#cwb-clonedir>`__         |  creates the working directory and subdirectories by copying an existing one           |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_setpipe <#cwb-setpipe>`__           |  selects the analysis pipeling: first- or second-generation pipeline (1G/2G - def: 2G) |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_setpars <#cwb-setpars>`__           |  sets the user parameters file (default: config/user_parameters.C)                     |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_setppars <#cwb-setppars>`__         |  sets the user pparamters file (default: config/user_pparameters.C)                    |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_condor <#cwb-condor>`__             |  creates and submits the dag and sub condor files                                      |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_lsf <#cwb-lsf>`__                   |  creates and submits job with LSF Job System (implemented in the CNAF cluster)         |
+------------------------------------------+----------------------------------------------------------------------------------------+
| `cwb_xtalk <#cwb-xtalk>`__               |  creats the xtalk catalog (used for the multiresolution analysis)                      |
+------------------------------------------+----------------------------------------------------------------------------------------+

**Production**

+--------------------------------------+---------------------------------------------------------------------------+
| `cwb_inet <#cwb-inet>`__             |  runs the interactive CWB pipeline (both 1G and 2G pipelines available)   |
+--------------------------------------+---------------------------------------------------------------------------+
| `cwb_inet2G <#cwb-inet2g>`__         |  runs the interactive 2G CWB pipeline in the multistage mode              |
+--------------------------------------+---------------------------------------------------------------------------+
| `cwb_eced <#cwb-eced>`__             |  generates the CED with the 1G CWB pipeline                               |
+--------------------------------------+---------------------------------------------------------------------------+
| `cwb_eced2G <#cwb-eced2g>`__         |  generates the CED with the 2G CWB pipeline                               |
+--------------------------------------+---------------------------------------------------------------------------+
| `cwb_dump <#cwb-dump>`__             |  dumps the output messages generated by the CWB pipeline                  |
+--------------------------------------+---------------------------------------------------------------------------+

**Post-production**

+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_condor benchmark <#cwb-condor-benchmark>`__         |  (is a `cwb_condor <#cwb-condor>`__ option) draws plots on the computational load |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_merge <#cwb-merge>`__                               |  merges the output root files                                                     |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_setchunk <#cwb-setchunk>`__                         |  add chunk id leaf to the merged root files                                       |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_setifar <#cwb-setifar>`__                           |  add ifar leaf to the merged simulation root files                                |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_setcuts <#cwb-setcuts>`__                           |  applies selection cuts on the leaves contained in the merged root file           |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_setveto <#cwb-setveto>`__                           |  applies vetoes to merged root file                                               |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_report <#cwb-report>`__                             |  creates final analysis reports                                                   |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_mkfad <#cwb-mkfad>`__                               |  calculates the false-alarm rate density statistic                                |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+
| `cwb_mkprc <#cwb-mkprc>`__                               |  produce FOM for sky localizations                                                |
+----------------------------------------------------------+-----------------------------------------------------------------------------------+

**Utility**

+----------------------------------------------------------+-------------------------------------+
| `cwb_mplugin <#cwb-mplugin>`__                           |  merge plugins into one             |
+----------------------------------------------------------+-------------------------------------+
| `cwb_mkhtml <#cwb-mkhtml>`__                             |  creates html pages from texi files |
+----------------------------------------------------------+-------------------------------------+
| `cwb_mkrep <#cwb-mkrep>`__                               |  creates customised reports         |
+----------------------------------------------------------+-------------------------------------+
| `cwb_draw_sensitivity <#cwb-draw-sensitivity>`__         |  draws sensitivity curves           |
+----------------------------------------------------------+-------------------------------------+
| `cwb_draw_antpat <#cwb-draw-antpat>`__                   |  draws the network antenna pattern  |
+----------------------------------------------------------+-------------------------------------+
| `cwb_gwosc <#cwb-gwosc>`__                               |  analysis of GWOSC O2 catalog events|
+----------------------------------------------------------+-------------------------------------+

|
|
|

Pre-production
--------------

|

.. include:: commands/cwb_mkdir.rst

|

.. include:: commands/cwb_clonedir.rst

|

.. include:: commands/cwb_setpipe.rst

|

.. include:: commands/cwb_setpars.rst

| 
 
.. include:: commands/cwb_setppars.rst

| 
 
.. include:: commands/cwb_condor.rst

| 
 
.. include:: commands/cwb_lsf.rst

| 
 
.. include:: commands/cwb_xtalk.rst

| 
 

Production
----------

.. include:: commands/cwb_inet.rst

| 
 
.. include:: commands/cwb_inet2G.rst

| 
 
.. include:: commands/cwb_eced.rst

| 
 
.. include:: commands/cwb_eced2G.rst

| 
 
.. include:: commands/cwb_dump.rst

| 
 

Post-Production
---------------

.. include:: commands/cwb_condor_benchmark.rst

| 
 
.. include:: commands/cwb_merge.rst

| 
 
.. include:: commands/cwb_setchunk.rst

| 
 
.. include:: commands/cwb_setifar.rst

| 
 
.. include:: commands/cwb_setcuts.rst

| 
 
.. include:: commands/cwb_setveto.rst

| 
 
.. include:: commands/cwb_report.rst

| 
 
.. include:: commands/cwb_mkfad.rst

| 
 
.. include:: commands/cwb_mkprc.rst

| 
 

Utility
-------

.. include:: commands/cwb_mplugin.rst

| 
 
.. include:: commands/cwb_mkhtml.rst

| 
 
.. include:: commands/cwb_mkrep.rst

| 
 
.. include:: commands/cwb_draw_sensitivity.rst

| 
 
.. include:: commands/cwb_draw_antpat.rst

| 
 
.. include:: commands/cwb_gwosc.rst