diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index cd255bdb33ce9b6d8611a2d9a15494f7d7018c9f..a18a9bd7ce9c701fe9c0e78311bcf647bdbf5a76 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -21,10 +21,11 @@ exitcode-jessie: - pip install -r requirements.txt - pip install coverage - pip install coverage-badge - - coverage run test/prior_tests.py - - coverage run test/tests.py - - coverage run test/waveform_generator_tests.py - - coverage run test/noise_realisation_tests.py + - coverage erase + - coverage run -a test/prior_tests.py + - coverage run -a test/tests.py + - coverage run -a test/waveform_generator_tests.py + - coverage run -a test/noise_realisation_tests.py - coverage html --include=peyote/* - coverage-badge -o coverage.svg artifacts: diff --git a/README.md b/README.md index 1810ef8fa76835c97070f88fa8cc4abc43e627ff..dddf36210d530553da698ab9e4d0d3e419d5dff3 100644 --- a/README.md +++ b/README.md @@ -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