From cbd906d69d1f4928cf1b0dbe65e5325c8f608a19 Mon Sep 17 00:00:00 2001 From: Daniel Williams Date: Wed, 1 Feb 2017 16:46:21 +0000 Subject: [PATCH] Improved the installation documentation. --- docs/installation.rst | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 5a67f1a..e3dd770 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -13,14 +13,24 @@ virtual environment alongside the Minke code, which should make your life slightly easier, and in the future we hope to find a way to bundle this installation into the Minke install script. - - - -At the command line:: - - $ easy_install minki - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv minki - $ pip install minki +To install lalsuite and minke you should run:: + $ ./setup_environment.sh +in the root of the project, which will attempt to download and build the +latest version of lalsuite, using the correct branch to run the minke code. +You can then install the Minke python package by running:: + $ python setup.py install + +======================= +Use on the LDG Clusters +======================= + +Daniel Williams currently maintains a virtual environment on the LLO +cluster of the LIGO Data Grid for general use of Minke. You can +activate the virtual environment, which gives access to both the +correct branch of LALSuite and to the Minke Python package, by running +the following command in BASH:: + $ source ~daniel.williams/.virtualenvs/lal-minke/bin/activate + +Any code which is run in this virtual environment should link +automatically to the correct python packages to produce signals using +Minke. -- GitLab