1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
|
Installation
================================================================================
The simplest way to install the latest stable release of Change-O is via pip::
> pip3 install changeo --user
The current development build can be installed using pip and mercurial in similar fashion::
> pip3 install hg+https://bitbucket.org/kleinstein/changeo#default --user
If you currently have a development version installed, then you will likely
need to add the arguments ``--upgrade --no-deps --force-reinstall`` to the
pip3 command.
Requirements
--------------------------------------------------------------------------------
+ `Python 3.4.0 <http://python.org>`__
+ `setuptools 2.0 <http://bitbucket.org/pypa/setuptools>`__
+ `NumPy 1.8 <http://numpy.org>`__
+ `SciPy 0.14 <http://scipy.org>`__
+ `pandas 0.15 <http://pandas.pydata.org>`__
+ `Biopython 1.65 <http://biopython.org>`__
+ `presto 0.5.10 <http://presto.readthedocs.io>`__
+ `airr 1.2.1 <https://docs.airr-community.org>`__.
+ AlignRecords requires `MUSCLE 3.8 <http://www.drive5.com/muscle>`__
+ ConvertDb-genbank requires `tbl2asn <https://www.ncbi.nlm.nih.gov/genbank/tbl2asn2>`__
+ AssignGenes requires `IgBLAST 1.6 <https://ncbi.github.io/igblast>`__, but
version 1.11 or higher is recommended.
+ BuildTrees requires `IgPhyML 1.0.5 <https://bitbucket.org/kbhoehn/igphyml>`_
Linux
--------------------------------------------------------------------------------
1. The simplest way to install all Python dependencies is to install the
full SciPy stack using the
`instructions <http://scipy.org/install.html>`__, then install
Biopython according to its
`instructions <http://biopython.org/DIST/docs/install/Installation.html>`__.
2. Install `presto 0.5.0 <http://presto.readthedocs.io>`__ or greater.
3. Download the Change-O bundle and run::
> pip3 install changeo-x.y.z.tar.gz --user
Mac OS X
--------------------------------------------------------------------------------
1. Install Xcode. Available from the Apple store or
`developer downloads <http://developer.apple.com/downloads>`__.
2. Older versions Mac OS X will require you to install XQuartz 2.7.5. Available
from the `XQuartz project <http://xquartz.macosforge.org/landing>`__.
3. Install Homebrew following the installation and post-installation
`instructions <http://brew.sh>`__.
4. Install Python 3.4.0+ and set the path to the python3 executable::
> brew install python3
> echo 'export PATH=/usr/local/bin:$PATH' >> ~/.profile
5. Exit and reopen the terminal application so the PATH setting takes effect.
6. You may, or may not, need to install gfortran (required for SciPy). Try
without first, as this can take an hour to install and is not needed on
newer releases. If you do need gfortran to install SciPy, you can install it
using Homebrew::
> brew install gfortran
If the above fails run this instead::
> brew install --env=std gfortran
7. Install NumPy, SciPy, pandas and Biopyton using the Python package
manager::
> pip3 install numpy scipy pandas biopython
8. Install `presto 0.5.0 <http://presto.readthedocs.io>`__ or greater.
9. Download the Change-O bundle, open a terminal window, change directories
to the download folder, and run::
> pip3 install changeo-x.y.z.tar.gz
Windows
--------------------------------------------------------------------------------
1. Install Python 3.4.0+ from `Python <http://python.org/downloads>`__,
selecting both the options 'pip' and 'Add python.exe to Path'.
2. Install NumPy, SciPy, pandas and Biopython using the packages
available from the
`Unofficial Windows binary <http://www.lfd.uci.edu/~gohlke/pythonlibs>`__
collection.
3. Install `presto 0.5.0 <http://presto.readthedocs.io>`__ or greater.
4. Download the Change-O bundle, open a Command Prompt, change directories to
the download folder, and run::
> pip install changeo-x.y.z.tar.gz
5. For a default installation of Python 3.4, the Change-0 scripts will be
installed into ``C:\Python34\Scripts`` and should be directly
executable from the Command Prompt. If this is not the case, then
follow step 5 below.
6. Add both the ``C:\Python34`` and ``C:\Python34\Scripts`` directories
to your ``%Path%``. On Windows 7 the ``%Path%`` setting is located
under Control Panel -> System and Security -> System -> Advanced
System Settings -> Environment variables -> System variables -> Path.
6. If you have trouble with the ``.py`` file associations, try adding ``.PY``
to your ``PATHEXT`` environment variable. Also, opening a
command prompt as Administrator and run::
> assoc .py=Python.File
> ftype Python.File="C:\Python34\python.exe" "%1" %*
|