aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPjotr Prins2017-07-07 07:28:04 +0000
committerPjotr Prins2017-07-08 09:16:29 +0000
commit66a8adef9baafe0ec31ac939afa6ad962a11619a (patch)
tree7a8213511260a03bbac44487a811c1296170f90f
parent86e96ede4ff0955bb2d03ac6c1bd7562a3984955 (diff)
downloadpangemma-66a8adef9baafe0ec31ac939afa6ad962a11619a.tar.gz
Install doc
-rw-r--r--INSTALL.md40
-rw-r--r--README.md2
2 files changed, 41 insertions, 1 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..dd6bb2a
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,40 @@
+# INSTALL GEMMA: Genome-wide Efficient Mixed Model Association
+
+## Check version
+
+Simply run gemma once installed
+
+ gemma
+
+and it should give you the version.
+
+## GEMMA dependencies
+
+GEMMA runs on Linux and MAC OSX and the runtime has the following
+dependencies:
+
+* C++ tool chain
+* GNU Science library (GSL)
+* blas
+* [Eigen library](http://eigen.tuxfamily.org/dox/)
+* zlib
+
+## Install GEMMA
+
+### Bioconda
+
+Recent versions of GEMMA can be installed with
+[BioConda](http://ddocent.com/bioconda/) without root permissions using the following
+command
+
+ conda install gemma
+
+### GNU Guix
+
+The GNU Guix package manager can install recent versions of GEMMA
+using the following command
+
+ guix package -i gemma
+
+
+### Install from source
diff --git a/README.md b/README.md
index a539cc0..0129d42 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@ MQS algorithm to estimate variance components.
## Quick start
-1. Download and install the software. *Give more details here.*
+1. Download and install the software. See [INSTALL.md](INSTALL.md).
2. Work through the demo. *Give more details here.*