Cardiff Gravity Exploration Institute

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Installing LALSuite from source ======
If you don't want to, or can't, use the packaged versions of LALSuite, you must install the suite from the git repository source.

===== Clone the repo =====
<note>On the LIGO Data Grid computing clusters, you are encouraged to clone the repository on a disk local to the machine. Please see [[.:ldg-local|this page]] for instructions on choosing the correct local directory.</note>

  - Choose a directory in which to clone the repo <code bash>LALSUITE_DIR=${HOME}/git # change as appropriate</code>
  - Clone the repository with your ''albert.einstein'' LIGO.ORG username <code bash>git clone albert.einstein@ligo-vcs.phys.uwm.edu:/usr/local/git/lalsuite.git</code> The repository can be cloned in a read-only state with no authentication via <code bash>git clone git://ligo-vcs.phys.uwm.edu/lalsuite.git</code>
  - Move into the repository <code bash>cd lalsuite</code>

===== Installing with a top-level build =====
The following instructions describe a 'top-level' build, where all the ''C''-based packages of LALSuite are compiled together. This is the simplest way to build if everything works, but can get complicated if there is a problem.

==== Configure the build ====
First, run the setup script
<code bash>./00boot</code>
This will return some minimal output, but should be obviously broken when it fails.

Next, configure the build. This requires a set of keyword arguments to the ''./configure'' script. To see a list of all possible options, and their defaults, run
<code bash>./configure --help</code>
In short, you need to have
  * ''----prefix /path/to/my/install'', e.g. ''----prefix ${HOME}/opt/lalsuite/master'' to install in your home directory for the specific 'master' branch of lalsuite. This allows you to install multiple branches in the same directory tree.

And you might want to add
  * ''----enable-swig-python'' to install the SWIG-bindings for python
  * ''----enable-swig-octave'' to install the SWIG-bindings for octave
  * ''----quiet'' to print less verbose output during ''configure''
  * ''----enable-laldetchar'' to install the LALDetChar package

Once you have chosen your arguments, run the configure script. First, set the prefix path
<code bash>LALSUITE_PREFIX=${HOME}/opt/lalsuite/master # change as appropriate</code>
then run the ''configure'', e.g:
<code bash>./configure --prefix ${LALSUITE_PREFIX} --enable-swig-python --enable-laldetchar --silent</code>

==== Compile and install the code ====
You can then compile and install the code via
<code bash>make --quiet install</code>
<note tip>You can make ''make'' go a lot faster by allowing it to use more than one CPU at a time, use this code to find out how many CPUs your machine has <code bash>
if [[ "${OSTYPE}" == "linux-gnu" ]]; then
    export NCPUS=$(cat /proc/cpuinfo | grep processor | wc -l)
elif [[ "${OSTYPE:0:6}" == "darwin" ]]; then
    export NCPUS=$(sysctl hw.ncpu | awk '{print $2}')
fi</code> then run make with another argument to use them all <code bash>make --quiet --jobs=${NCPUS} install</code></note>

==== Installing GLUE and PyLAL ====
The LALSuite git repository also includes two python packages associated with the C-libraries.

=== Installing GLUE ===
The Grid LIGO User Environment is a python package that provides a bunch of tools to help data analysis on the LIGO Data Grid systems. It has no actual dependence on LAL and its friends, and should be installed on each of the LDG systems.

You can install it from the repository by moving into the directory and running the ''setup.py'' script:
<code bash>cd glue
python setup.py install --prefix ${LALSUITE_PREFIX}
</code>

There aren't many options for the setup.py, but you could add ''--quiet'' before ''install'' to supress some output.

=== Installing PyLAL ===
PyLAL is a python package built on top of the LALSuite C-libraries, and is heavily dependent on the other parts of LALSuite, including GLUE and LAL.

As with GLUE, you can install it from the repository by moving into the directory and running the ''setup.py'' script:
<code bash>cd pylal
python setup.py install --prefix ${LALSUITE_PREFIX}
</code>

===== Setting your environment =====
You will need to add a number of directory paths to a few environment variables so that you can easily find and use the codes you've just installed.

Each of the packages in LALSuite will have installed a script in the ''${LALSUITE_PREFIX}/etc'' directory. It's best to manually build a script to pull them all together. Set the top-level environment script in the same directory
<code bash>LALSUITERC=${LALSUITE_PREFIX}/etc/lalsuiterc</code>
and run the following code to fill it with the correct text:
<code bash>echo '#!/bin/bash

# define function to remove duplicates from path environment variables
cleanpath() {
    local badpath=$(eval echo \$$1)
    badpath=${badpath%%:}
    badpath="$(echo "${badpath}" | awk -v RS=":" -v ORS=":" "!a[\$1]++")"
    badpath=${badpath%%:}
    eval $1=${badpath}
    eval export $1
}

export LSCSOFT_LOCATION='${LALSUITE_PREFIX}'

# set environment for each sub-package of LALSuite
for PACKAGE in LAL LALFRAME LALMETAIO LALBURST LALINSPIRAL LALSTOCHASTIC LALPULSAR LALDETCHAR LALXML LALAPPS GLUE PYLAL; do
    lc_package=$(echo $PACKAGE | tr "[A-Z]" "[a-z]")
    PKG_ENV_SH=${LSCSOFT_LOCATION}/etc/${lc_package}-user-env.sh
    if [ -f "${PKG_ENV_SH}" ]; then
        . ${PKG_ENV_SH}
    fi
done

cleanpath PATH
cleanpath PYTHONPATH
cleanpath LD_LIBRARY_PATH' > ${LALSUITERC}</code>