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

Update installation instructions and readme

- Move instructions to docs
- Update and simplify readme
- Add note on HTTPS
parent 18191fb6
No related branches found
No related tags found
No related merge requests found
Pipeline #
......@@ -6,15 +6,16 @@ https://monash.docs.ligo.org/tupak/htmlcov/)
Fulfilling all your gravitational wave dreams.
Documentation can be found
[here](https://monash.docs.ligo.org/tupak/index.html). This and the code in
general are a work in progress. We encourage you to submit issues via are
[issue tracker](https://git.ligo.org/Monash/tupak/issues) and contribute to the
development via a merge request (for help in creating a merge request, see
[this page](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) or
* [Installation instructions](https://monash.docs.ligo.org/tupak/installation.html)
* [Documentation](https://monash.docs.ligo.org/tupak/index.html).
* [Issue tracker](https://git.ligo.org/Monash/tupak/issues)
We encourage you to contribute to the development via a merge request (for help
in creating a merge request, see [this
page](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) or
contact us directly.
## Example
## Examples
To get started with `tupak`, we have a few examples and tutorials:
......@@ -31,64 +32,3 @@ To get started with `tupak`, we have a few examples and tutorials:
3. [Notebook-style tutorials](https://git.ligo.org/Monash/tupak/tree/master/examples/tutorials)
* [Comparing different samplers](https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/compare_samplers.ipynb)
* [Visualising the output](https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/visualising_the_results.ipynb)
## 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](https://packaging.python.org/tutorials/installing-packages/#use-pip-for-installing),
and [git](https://git-scm.com/).
### Install tupak
Clone the repository, install the requirements, and then install `tupak`.
```bash
$ 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:
```bash
$ 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](https://git.ligo.org/lscsoft/lalsuite)
to check you have an account and SSH keys set up. Then,
```bash
$ 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](https://johannesbuchner.github.io/PyMultiNest/install.html). We
have also written [a shortened tl;dr here](./TLDR_MULTINEST.md).
## 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.](https://monash.docs.ligo.org/tupak/htmlcov/).
Here is a short version, if this fails refer to the full instructions.
First, install the dependencies (for Ubuntu/Linux):
```bash
$ sudo apt-get install python-{scipy,numpy,matplotlib,progressbar} ipython libblas{3,-dev} liblapack{3,-dev} libatlas{3-base,-dev} cmake build-essential git gfortran
```
For Mac, the advice in the instructions are "If you google for “MultiNest Mac OSX” or “PyMultiNest Mac OSX” you will find installation instructions".
The following will place a directory `MultiNest` in your `$HOME` directory, if you want
to place it somewhere, adjust the instructions as such.
```bash
git clone https://github.com/JohannesBuchner/MultiNest $HOME
cd $HOME/MultiNest/build
cmake ..
make
```
Finally, add the libraries to you path. Add this to the `.bashrc` file
```
export LD_LIBRARY_PATH=$HOME/Downloads/MultiNest/lib:
```
(you'll need to resource your `.bashrc` after this, i.e. run `bash`.
......@@ -8,6 +8,7 @@ Welcome to tupak's documentation!
:maxdepth: 3
:caption: Contents:
installation
basics-of-parameter-estimation
compact-binary-coalescence-parameter-estimation
prior
......
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