Installation

We recommend using conda to install the requirements for using pambox. The following procedure should give you a functioning python environment where you can use pambox.

Install the miniconda version for you platform. It's a minimal installation of python that simplifies the installation of all the scientific packages. On Linux and Amc, it can be done from the terminal.

Note: On the Mac, you must replace the download link with the Mac OS X installer link on the Downloads page.

$ wget http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh 
$ chmod +x miniconda.sh
$ ./miniconda.sh -b

Download or clone pambox to your disk.

$ git clone https://github.com/achabotl/pambox.git
$ cd pambox

Create a conda environment, and only install python inside it.

$ conda create -n pambox-env python

Activate the pambox-env environment.

$ source activate pambox-env

Install the pambox requirements.

$ conda install --file requirements.txt

Install pambox.

$ python setup.py install

You should now have a working pambox installation. To test if everything worked correctly, start a python (or ipython) prompt and try importing pambox:

$ ipython
Python 2.7.8 (default, Oct 19 2014, 16:02:00)
Type "copyright", "credits" or "license" for more information.

IPython 2.3.1 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.

In [1]: import pambox

Next time you want to use pambox from the terminal, you just have to activate your pambox environment:

$ source activate pambox-env

Installing for development

If you intend to add features to pambox, you should install it using the following command (instead of python setup.py install:

$ python setup.py develop

This command adds a link to the pambox folder in the Python path. This means that your python environment will be aware of the changes you make to pambox, without requiring that you reinstall it every time you make a change.