Skip to content
Snippets Groups Projects
Commit 4320a4bb authored by Gregory Ashton's avatar Gregory Ashton
Browse files

Update readme

parent 3860e42d
No related branches found
No related tags found
No related merge requests found
Pipeline #
...@@ -4,7 +4,7 @@ https://monash.docs.ligo.org/tupak/) ...@@ -4,7 +4,7 @@ https://monash.docs.ligo.org/tupak/)
# Tupak # Tupak
Fulfilling all your GW dreams. Fulfilling all your gravitational wave dreams.
## Example ## Example
...@@ -27,8 +27,10 @@ To get started with `tupak`, we have a few examples and tutorials: ...@@ -27,8 +27,10 @@ To get started with `tupak`, we have a few examples and tutorials:
## Installation ## Installation
In the following, we assume you have installed `tupak` is developed to work with both Python 2.7+ and Python 3+. In the
[https](pip://pypa.io.en/stable/installing/pip/) and [git](https://git-scm.com/). following, we assume you have a working python installation, [python
pip](https://packaging.python.org/tutorials/installing-packages/#use-pip-for-installing),
and [git](https://git-scm.com/).
### Install tupak ### Install tupak
Clone the repository, install the requirements, and then install `tupak`. Clone the repository, install the requirements, and then install `tupak`.
...@@ -39,12 +41,18 @@ $ pip install -r requirements.txt ...@@ -39,12 +41,18 @@ $ pip install -r requirements.txt
$ python setup.py install $ python setup.py 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 ### Install lalsuite
The simple way: `pip install lalsuite`, or, We recommend you install `lalsuite` the simple way:
from source:
```bash
$ pip install lalsuite.
```
If this doesn't work, or you prefer to, you can also install from source.
Head to Head to
[https://git.ligo.org/lscsoft/lalsuite](https://git.ligo.org/lscsoft/lalsuite) [https://git.ligo.org/lscsoft/lalsuite](https://git.ligo.org/lscsoft/lalsuite)
to check you have an account and SSH keys set up. Then, to check you have an account and SSH keys set up. Then,
...@@ -61,32 +69,18 @@ $ make; make install ...@@ -61,32 +69,18 @@ $ make; make install
Warning: in the configure line here, we have disabled everything except Warning: in the configure line here, we have disabled everything except
lalsimulation. If you need other modules, see `./configure --help`. lalsimulation. If you need other modules, see `./configure --help`.
### Install pymultinest
If you want to use the `pymultinest` sampler, you first need the If you want to use the `pymultinest` sampler, you first need the
MultiNest library to be installed to work properly. The full instructions can MultiNest library to be installed to work properly. The full instructions can
be found [here](https://johannesbuchner.github.io/PyMultiNest/install.html). We be found [here](https://johannesbuchner.github.io/PyMultiNest/install.html). We
have also written [a shortened tl;dr here](./TLDR_MULTINEST.md). have also written [a shortened tl;dr here](./TLDR_MULTINEST.md).
## Tests and coverage
To locally test the code ## Tests and coverage
```bash
$ python tests.py
```
To locally generate a coverage report
```bash
$ 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: We have a variety of tests which can be found in the `tests` directory. You
[https://monash.docs.ligo.org/tupak/](https://monash.docs.ligo.org/tupak/). can find a [current coverage report for master
here.](https://monash.docs.ligo.org/tupak/).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment