From 6eb175052ba6c298bb45485647c7ac17515fb9b0 Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Tue, 27 Mar 2018 13:09:57 +1100
Subject: [PATCH] Update of setup.py, requirements and README
---
README.md | 35 ++++++++++++++++++++++++++++++++++-
requirements.txt | 9 +++++++++
setup.py | 2 +-
3 files changed, 44 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 4e9516b39..0ff09fbd2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
# PEYOte
-Fulfilling all your GW dreams.
\ No newline at end of file
+Fulfilling all your GW dreams.
+
+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`.
+```bash
+$ git clone git@github.com:plasky/PEYOte.git
+$ 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).
+
+Second, you need `lalsimulation` from `lalsuite` installed. To do 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
+$ git lfs install
+$ 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`.
+
diff --git a/requirements.txt b/requirements.txt
index e69de29bb..412d8fa28 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -0,0 +1,9 @@
+numpy
+matplotlib>=1.4
+scipy
+gwpy
+pandas
+pymultinest
+gwsurrogate
+NRSur7dq2
+chainconsumer
diff --git a/setup.py b/setup.py
index 2a5a9f956..9d1aa8643 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@
from distutils.core import setup
-setup(name='PEYOte',
+setup(name='peyote',
version='0.1',
packages=['peyote'],
)
--
GitLab