/M-LOOP

Permalink
Switch branches/tags
Nothing to show
Find file
M-LOOP/docs/install.rst
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
84 lines (50 sloc) 3.15 KB

Installation

M-LOOP is available on PyPI and can be installed with your favorite package manager. However, we currently recommend you install from the source code to ensure you have the latest improvements and bug fixes.

The installation process involves four steps.

  1. Get a Python 3 distribution with the standard scientific packages. We recommend installing :ref:`sec-anaconda`.
  2. Install the development version of :ref:`sec-scikit-learn`.
  3. Install the development version of :ref:`sec-M-LOOP`.
  4. :ref:`Test<sec-Testing>` your M-LOOP install.

Anaconda

We recommend installing Anaconda to get a python 3 environment with all the required scientific packages. The Anaconda distribution is available here:

https://www.continuum.io/downloads

Follow the installation instructions they provide.

M-LOOP requires a python 3.* environment. If you want to retain compatibility with python 2.* Anaconda supports installing multiple python environments on the same machine, see:

http://conda.pydata.org/docs/py2or3.html#create-python-2-or-3-environments.

scikit-learn

M-LOOP currently uses some of the machine learning algorithms from the development version of scikit-learn. This means you must also install scikit-learn from source in order to use M-LOOP.

To install the development version of scikit-learn you can follow the instructions here:

http://scikit-learn.org/stable/developers/contributing.html#git-repo

Or simply run these three commands:

git clone git://github.com/scikit-learn/scikit-learn.git
cd ./scikit-learn
python setup.py develop

The first command downloads the latest source code for scikit-learn from github into the current directory, the second moves into the scikit-learn source directory, and the third link builds the package and creates a link from you python package to the source. You may need admin privileges to run the setup script.

M-LOOP

M-LOOP can be installed from the source code with three commands:

git clone git://github.com/michaelhush/M-LOOP.git
cd ./M-LOOP
python setup.py develop

The first command downloads the latest source code for M-LOOP from github into the current directory, the second moves into the M-LOOP source directory, and the third link builds the package and creates a link from you python package to the source. You may need admin privileges to run the setup script.

At any time you can update M-LOOP to the latest version from github by running the command:

git pull origin master

in the M-LOOP directory.

Test Installation

To test your M-LOOP installation use the command:

python setup.py test

In the M-LOOP source code directory. The tests should take around five minutes to complete. If you find a error please consider :ref:`sec-contributing` to the project and report a bug on the github.

Documentation

If you would also like a local copy of the documentation enter the docs folder and use the command:

make html

Which will generate the documentation in docs/_build/html.