Installation
============


1. If you are using Ubuntu then the setup script will take care of the standard python packages. Otherwise, ensure absolutely required :doc:`dependencies` are installed. 
   
2. Extract downloaded distribution

..  code-block:: sh

    tar xzf Polyphony-1.0.tar.gz

3. Build the package

..  code-block:: sh

    python setup.py build
    
Please run this as yourself, not as root or su otherwise the resulting file ownership will not be correct.

4. Install the package

..  code-block:: sh

    sudo python setup.py install
    
Please note, this will remove an existing Polyphony installation (the first on the python path). If you don't have root privileges or would rather install into a specified local follow the instructions in :doc:`custom-install`

5. A directory called Polyphony will be created in your home directory. This directory will be used to store intermediate data files. PDB files are also stored here. If you already have directory where you keep these, create a logical link to it e.g.

..  code-block:: sh

    ln -s /home/fred/PDBs /home/fred/Polyphony/pdbs
    
There is also a file called :doc:`config` which stores the locations of data and 3rd party programs. Please have a look at this file and check it's contents.

6. Your ready to go. See :doc:`documentation` for what to do next.