Commit 4320a4bb authored by Gregory Ashton's avatar Gregory Ashton

Update readme

parent 3860e42d
Pipeline #19574 canceled with stages
in 4 minutes and 42 seconds
......@@ -4,7 +4,7 @@
# Tupak
Fulfilling all your GW dreams.
Fulfilling all your gravitational wave dreams.
## Example
......@@ -27,8 +27,10 @@ To get started with `tupak`, we have a few examples and tutorials:
## Installation
In the following, we assume you have installed
[https](pip:// and [git](
`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
and [git](
### Install tupak
Clone the repository, install the requirements, and then install `tupak`.
......@@ -39,12 +41,18 @@ $ pip install -r requirements.txt
$ python install
Once you have run these steps, you have `tupak` installed.
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
The simple way: `pip install lalsuite`, or,
from source:
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
to check you have an account and SSH keys set up. Then,
......@@ -61,32 +69,18 @@ $ 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
To locally test the code
$ python
To locally generate a coverage report
$ pip install coverage
$ coverage run
$ coverage html
This will generate a directory `htmlcov`, to see detailed coverage navigate
from your browser to the file `tupak/htmlcov/index.html`.
## Tests and coverage
The coverage report for master can be seen here:
We have a variety of tests which can be found in the `tests` directory. You
can find a [current coverage report for master
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment