Tupak

Fulfilling all your gravitational wave dreams.

Documentation can be found here. This and the code in general are a work in progress. We encourage you to submit issues via are issue tracker and contribute to the development via a merge request (for help in creating a merge request, see this page or contact us directly.

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
   • Create your own time-domain 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

tupak is developed to work with both Python 2.7+ and Python 3+. In the following, we assume you have a working python installation, python pip, 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. You can now try to run the examples. However, for many gravitational-wave related examples you'll also need to install lalsuite.

Install lalsuite

We recommend you install lalsuite the simple way:

$ pip install lalsuite.

If this doesn't work, or you prefer to, you can also install 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.

Install pymultinest

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

We have a variety of tests which can be found in the tests directory. You can find a current coverage report for master here..