annotate ezBAMQC/doc/INSTALL @ 8:82bb8c455761

Uploaded
author cshl-bsr
date Wed, 30 Mar 2016 12:03:10 -0400
parents dfa3745e5fd8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
1
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
2 Installation guide for ezBAMQC for from source installs
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
3 =====================================================
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
4
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
5 When installing ezBAMQC there are several options, but the main point is: since ezBAMQC uses C++ STD 11 you'll need a version of GCC that can support that, this useally means 4.8 or 4.9. beyond that, you'll need Python, R and Corrplot for interfacing with the C code.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
6
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
7 :Intallation:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
8 `Source Code <https://github.com/mhammell-laboratory/bamqc/archive/0.6.4.tar.gz>`_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
9
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
10 `Pypi <https://pypi.python.org/pypi?:action=display&name=BAMQC&version=0.6.4>`_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
11
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
12 :Prerequisites:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
13 * `python2.7 <https://www.python.org/download/releases/2.7/>`_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
14 * `R <https://www.r-project.org/>`_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
15 * `corrplot <https://cran.r-project.org/web/packages/corrplot/>`_
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
16 * `GCC 4.8.1 or greater <https://gcc.gnu.org/gcc-4.8/>`_ GCC 4.9.1 or greater is recomended for PyPi install
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
17
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
18 :Notes:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
19 * While there are multiple methods of installing the prerequistes it may help to look at (if using a yum based linux distro):*
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
20 * `Devtoolset-3 <https://access.redhat.com/documentation/en-US/Red_Hat_Developer_Toolset/3/html/User_Guide/sect-Red_Hat_Developer_Toolset-Install.html>`_ for GCC compilers
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
21 * `IUS <https://ius.io/>`_ for Python2.7
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
22 * `Software Collections <https://www.softwarecollections.org/>`_ for collections of software (like devtoolset 3 or python)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
23 * `rpmfinder <https://www.rpmfind.net/>`_ for searching rpms across mutliple systems
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
24
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
25 Setup
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
26 =====
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
27
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
28 1) Make sure that the GCC comiler is in your PATH:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
29
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
30 ::
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
31
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
32 export PATH=/path/to/gcc:$PATH
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
33
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
34 2) Make sure that python2.7 is in your PYTHONPATH:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
35
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
36 ::
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
37
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
38 export PYTHONPATH=/path/to/python2.7/site-packages:$PYTHONPATH
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
39
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
40 3) There are three methods of installation of ezBAMQC, from source, from setup.py, and from pypi, once prequistes are setup.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
41
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
42 From Source
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
43 ~~~~~~~~~~~
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
44
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
45 1) Download source
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
46
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
47 2) Unpack tarball and go to the directory of the package:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
48
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
49 ::
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
50
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
51 tar xvfz bamqc-0.6.4.tar.gz
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
52
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
53 cd bamqc-0.6.4
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
54
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
55 3) Run make:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
56
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
57 ::
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
58
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
59 make
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
60
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
61 From Setup.py
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
62 ~~~~~~~~~~~~~
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
63
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
64 ::
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
65
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
66 python2.7 setup.py install
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
67
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
68 From Pypi
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
69 ~~~~~~~~~
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
70
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
71 ::
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
72
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
73 pip2.7 install BAMqc
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
74