MAGeCK / Wiki / install
Menu ▾ ▴

install

Wei Li
There is a newer version of this page. You can find it here.

Installation

Download

The latest version of MAGeCK (0.5.6) can be downloaded here:

Or click the link here (in cases the button points to a wrong file).


For earlier versions (< 0.5.4), the zip file is encrypted, but you can get the password easily by one of the following options:

  • Join our MAGeCK Google group and the password is shown on the top of the forum; or
  • Send an email to mageck.help@gmail.com with the subject "password", and you will get an automatic reply with password within 1 minute.

You need to go to the Terminal to unzip and install the software. See the instructions for Installation below.


System requirement

MAGeCK can be run on either Mac or Linux system. Since MAGeCK is written in Python and C, Python 2.7 (>2.7) and a C compiler is needed.

Optional dependencies

Two optional softwares include R and pdflatex. MAGeCK relies on both softwares to generating PDF reports if the --pdf-report option is used. If it is not possible to install them, you can also generate PDF reports by copying some MAGeCK output files to another computers with R and pdflatex are properly installed. See Q and A for more information.

If you use the --pdf-report option, xtable is required, and gplots is suggested to install in R. Use install.packages("xtable") and install.packages("gplots") in R to install them.

You won't get any error messages if you don't have gplots, but you will get a more beautiful clustering figure in the pdf report of the count command.

MAGeCK also suggests users installing numpy to calculate the negative binomial p value. However, in cases where numpy is not found, MAGeCK will use the normal p value instead. There may be slight differences between both methods.

What if I cannot install these R packages in my machine

You can run MAGeCK without --pdf-report option, and copy some files to another machine with these R packages to generate pdf report. See Q and A for more details.

Installation

Since version 0.3, MAGeCK uses standard Python installation procedures (distutils) for compiling and installation of the software.

The installation procedure is extremely easy. First, download the source code, unzip it by using the following command (or just double-clicking it), and go into the directory in the command line:

tar xvzf mageck-0.5.4.tar.gz
cd mageck-0.5.4

After that, invoke python setup.py:

python setup.py install

And it is done! If you want MAGeCK to be installed on your own directory , use the following command instead:

python setup.py install --user

This is the easiest way to install mageck. An alternative approach is (you may have one additional step to set up the environment variables; see below)

python setup.py install --prefix=$HOME

where $HOME is the root directory you want to install (usually the user home).

Manual installation

The manual installation is deprecated since version 0.3. Please refer to the installation instructions above.

After downloading the source code, follow the instructions below for manual installation.

Setting up the environment variables

In most systems you don't need to set up the environment variables. Just type "mageck" in the command line to see if the mageck program works.

For those who installed MAGeCK into custom directories, there may be additional steps, including changing the environment variable. First you need to add the path of the mageck program to your PATH variable. For example, if you used the --prefix=$HOME option during installation, then set up the PATH variable by typing:

export PATH=$PATH:$HOME/bin

Still get the "command not found" error? You need to determine where MAGeCK is installed. See this Q and A for additional steps to determine the correct bin directory.

You also need to add the path of the MAGeCK module to the PYTHONPATH variable. Again, his variable should be set as

export PYTHONPATH=$HOME/lib/python2.7/site-packages:$PYTHONPATH

To save the path configuration (so you don't have to type it every time), place the above command in your ~/.bashrc (for Linux) or ~/.bash_profile (for Mac).

Experimental version

The experimental version of MAGeCK is available at bitbucket. Note that the source codes on BitBucket are experimental and are not fully tested, and it may not be stable or function well. It is strongly recommended to use the MAGeCK software downloaded from sourceforge.

Return to [Home]