Tupak

Fulfilling all your GW dreams.

Example

To get started with tupak, we have a few examples and tutorials:

1. Examples of injecting and recovering data

   • A basic tutorial
   • Create your own source model
   • How to specify the prior
   • Using a partially marginalized likelihood

2. Examples using open data

   • Analysing the first Binary Black hole detection, GW150914

3. Notebook-style tutorials

   • Comparing different samplers
   • Visualising the output

Installation

In the following, we assume you have installed https and git.

Install tupak

Clone the repository, install the requirements, and then install tupak.

$ git clone git@git.ligo.org:Monash/tupak.git
$ cd tupak/
$ pip install -r requirements.txt
$ python setup.py install

Once you have run these steps, you have tupak installed.

Install lalsuite

The simple way: pip install lalsuite, or, from source:

Head to https://git.ligo.org/lscsoft/lalsuite to check you have an account and SSH keys set up. Then,

$ git lfs install # you may need to install git-lfs first
$ git clone git@git.ligo.org:lscsoft/lalsuite.git
$ cd lalsuite
$ ./00boot
$ ./configure --prefix=${HOME}/lalsuite-install --disable-all-lal --enable-swig  --enable-lalsimulation
$ make; make install

Warning: in the configure line here, we have disabled everything except lalsimulation. If you need other modules, see ./configure --help.

If you want to use the pymultinest sampler, you first need the MultiNest library to be installed to work properly. The full instructions can be found here. We have also written a shortened tl;dr here.

Tests and coverage

To locally test the code

$ python tests.py

To locally generate a coverage report

$ pip install coverage
$ coverage run tests.py
$ coverage html

This will generate a directory htmlcov, to see detailed coverage navigate from your browser to the file tupak/htmlcov/index.html.

The coverage report for master can be seen here: https://monash.docs.ligo.org/tupak/.