htswanalysis/MACS/INSTALL

   1 INSTALL Guide For MACS
   2 Time-stamp: <2008-05-07 23:57:21 Tao Liu>
   3
   4 Please check the following instructions to complete your installation.
   5
   6 * Prerequisite
   7
   8 Python version must be greater than or equal to 2.4 to run MACS. We
   9 recommend using the version 2.5.
  10
  11 * Install from source
  12
  13 MACS uses Python's distutils tools for source installations. To
  14 install a source distribution of MACS, unpack the distribution tarball
  15 and open up a command terminal. Go to the directory where you unpacked
  16 MACS, and simply run the install script :
  17
  18 $ python setup.py install
  19
  20 By default, the script will install python library and executable
  21 codes globally, which means you need to be root or administrator of
  22 the machine so as to complete the installation. Please contact the
  23 administrator of that machine if you want their help. If you need to
  24 provide a nonstandard install prefix, or any other nonstandard
  25 options, you can provide many command line options to the install
  26 script. Use the –help option to see a brief list of available options:
  27
  28 $ python setup.py --help
  29
  30 For example, if I want to install everything under my own HOME
  31 directory, use this command:
  32
  33 $ python setup.py install --prefix /home/taoliu/
  34
  35 * Configure enviroment variables
  36
  37 After running the setup script, you might need to add the install
  38 location to your PYTHONPATH and PATH environment variables. The
  39 process for doing this varies on each platform, but the general
  40 concept is the same across platforms.
  41
  42 ** PYTHONPATH
  43
  44 To set up your PYTHONPATH environment variable, you'll need to add the
  45 value PREFIX/lib/pythonX.Y/site-packages to your existing
  46 PYTHONPATH. In this value, X.Y stands for the major–minor version of
  47 Python you are using (such as 2.4 or 2.5 ; you can find this with
  48 sys.version[:3] from a Python command line). PREFIX is the install
  49 prefix where you installed MACS. If you did not specify a prefix on
  50 the command line, MACS will be installed using Python's sys.prefix
  51 value.
  52
  53 On Linux, using bash, I include the new value in my PYTHONPATH by
  54 adding this line to my ~/.bashrc :
  55
  56 $ export PYTHONPATH=/home/taoliu/lib/python2.5/site-packages:$PYTHONPATH
  57
  58 Using Windows, you need to open up the system properties dialog, and
  59 locate the tab labeled Environment. Add your value to the PYTHONPATH
  60 variable, or create a new PYTHONPATH variable if there isn't one
  61 already.
  62
  63 ** PATH
  64
  65 Just like your PYTHONPATH, you'll also need to add a new value to your
  66 PATH environment variable so that you can use the MACS command line
  67 directly. Unlike the PYTHONPATH value, however, this time you'll need
  68 to add PREFIX/bin to your PATH environment variable. The process for
  69 updating this is the same as described above for the PYTHONPATH
  70 variable.
  71
  72 $ export PATH=/home/taoliu/bin:$PATH
  73
  74 * About GSL package
  75
  76 We include GSL -- GNU Scientific Library (GPLv3 licensed), version
  77 1.11, in our distribution. MACS uses its CDF functions in some
  78 calculations. The first time you build/install MACS, it will take you
  79 a long time to compile the GSL modules, so please be patient.
  80
  81
  82 --
  83 Tao Liu <taoliu@jimmy.harvard.edu>
  84