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

Minor rewrite of the readme

parent de5116ed
No related branches found
No related tags found
No related merge requests found
Pipeline #
......@@ -6,25 +6,26 @@ https://monash.docs.ligo.org/peyote/)
Fulfilling all your GW dreams.
## Installation
In the following, we assume you have installed
[pip](https://pip.pypa.io/en/stable/installing/) and [git](https://git-scm.com/).
First, clone the repository, install the requirements, and then install `Peyote`.
### Install peyote
Clone the repository, install the requirements, and then install `peyote`.
```bash
$ git clone git@git.ligo.org:Monash/peyote.git
$ cd peyote/
$ pip install -r requirements.txt
$ python setup.py install
```
Once you have run these three steps, you have `Peyote installed`. However, you
aren't quite yet ready to run anything. First,
`pymultinest` needs 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).
Once you have run these steps, you have `peyote` installed.
Second, you need `lalsimulation` from `lalsuite` installed. To do this head
to [https://git.ligo.org/lscsoft/lalsuite](https://git.ligo.org/lscsoft/lalsuite)
### Install lalsuite
Many of the `peyote` features rely on having a swig-wrapped `lalsuite`
installation. To install this 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
......@@ -36,10 +37,18 @@ $ ./configure --prefix=${HOME}/lalsuite-install --disable-all-lal --enable-swig
$ make; make install
```
** warning **: in the configure line here, we have disabled everything except lalsimulation. If you need other modules, see `./configure --help`.
Warning: in the configure line here, we have disabled everything except
lalsimulation. If you need other modules, see `./configure --help`.
You could also `pip install lal, lalsuite`.
### Install lalsuite (optional)
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
To locally test the code
......
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