How to Contribute

Install Documentation

# download cWB Documentation from GIT Repository
# The suggested local directory where to download the repository is $HOME/git/cWB
# Download the git master version (developing version):

  cd $HOME/git/cWB
  git clone git@git.ligo.org:cWB/documentation.git

Documentation uses doxygen to generate reference guide for cWB library and cWB config. The instructions to install the library and config are here.

Install Auxiliary Libraries

The CWB documentation is written in reStructuredText Format and uses Sphinx and Read the Docs Theme

In CIT cluster it is possible to use the pre-installed libraries:

# setting (for bash shell)

source ~waveburst/virtualenv/pycwb/bin/activate

# setting (for tcsh shell)

source ~waveburst/virtualenv/pycwb/bin/activate.csh

To install the auxiliary libraries in the local user account do:

# installation of packages used for cwb documentation
# packages are installed into pycwb virtual enviroment ~/virtualenv/pycwb

# create pycwb virtual enviroment ~/virtualenv/pycwb

python3 -m venv ~/virtualenv/pycwb

# activate pycwb virtual enviroment

source ~/virtualenv/pycwb/bin/activate

# install packages into ~/virtualenv/pycwb

pip3 install -r requirements.txt

# the requirements.txt file is in the documentation git repository:

sphinx==1.8.3
sphinxcontrib-programoutput
matplotlib
sphinx_rtd_theme
sphinxcontrib-contentui
sphinxcontrib-doxylink==1.6


# to update packages in ~/virtualenv/pycwb

pip3 install -r requirements.txt -U


# setting (for bash shell)

source ~/virtualenv/pycwb/bin/activate


# setting (for tcsh shell)

source ~/virtualenv/pycwb/bin/activate.csh

Generate Documentation

# generate cWB config and library reference guides with Doxygen

make doxygen

# generate cWB documentation

make html

# generate cWB command man

make man

# the man1 files are copied into library $HOME_WAT/man directory

# to get the online command help do (Ex):

    man cwb_inet

Public Documentation

cWB

For more details on building and maintaining the documentation under public GitLab project pages, see