.. _install:

****************************
Prerequisites / Installation
****************************

odML-tables is a pure Python package so that it should be easy to install on any system.


Dependencies
------------

The following packages are required to use python-odmltables:

    * Python_ >= 2.7
    * numpy_ >= 1.8.2
    * quantities_ >= 0.10.1
    * odml >= 1.1
    * xlrd >= 0.9.4
    * xlwt >= 1.0.0
    * For building the documentation:
        * numpydoc >= 0.5
        * sphinx >= 1.2.2
    * For running tests:
        * nose >= 1.3.3

Download
--------

The latest version of python-odmltables is available on [GitHub] (https://github.com/INM-6/python-odmltables). You can either use git and download python-odmltables directly under Linux using

    $ cd /home/usr/toolbox/
    $ git clone https://github.com/INM-6/python-odmltables.git

or alternatively download python-odmltables as ZIP file and unzip it to a folder.


Installation
------------

Linux
*****

On Linux, to set up python-odmltables you navigate to your python-odmltables folder and install it via

    $ cd /home/usr/toolbox/python-odmltables/
    $ python setup.py install

You can start the odmltables graphical wizard by calling
    
    odml-tables
    
Alternatively, you may navigate to the python-odmltables folder and run
    
    ./odmltables-gui
    
    
Windows/Mac OS X
****************

On non-Linux operating systems we recommend using the Anaconda_ Python distribution, and installing all dependencies in a `Conda environment`_, e.g.::

    $ conda create -n neuroscience python numpy scipy pip six
    $ source activate neuroscience
    
Then navigate to the folder where you downloaded python-odmltables and run:

    $ python setup.py install

On Windows, to run the graphical wizard, execute odml-tables.exe in the Anaconda/Envs/neuroscience/Scripts folder in your User directory.

Alternatively, on Windows or Max OS X you may navigate to the python-odmltables folder and run
    
    python odmltables-gui.py


Bugs
----
If you observe a bug in odMLtables please add a bug report at [the github bug tracker] (https://github.com/INM-6/python-odmltables/issues)


.. _Anaconda: http://continuum.io/downloads
.. _`Conda environment`: http://conda.pydata.org/docs/faq.html#creating-new-environments