GPy/README.md
2013-11-27 12:30:19 +00:00

2.4 KiB

GPy

A Gaussian processes framework in Python.

Continuous integration status: CI status

Getting started

Installing with pip

The simplest way to install GPy is using pip. pip install gpy

Ubuntu

For the most part, the developers are using ubuntu. To install the required packages: sudo apt-get install python-numpy python-scipy python-matplotlib

clone this git repository and add it to your path: git clone git@github.com:SheffieldML/GPy.git <destination> echo "PYTHONPATH=$PYTHONPATH:<detination> > ~/.bashrc

Windows

On windows, we recommend the anaconda python distribution. We've also had luck with enthought. git clone or unzip the source to a suitable directory, and add a PYTHONPATH environement variable.

OSX

everything appears to work out-of-the box using enthought on osx Mavericks.

Compiling documentation:

The documentation is stored in doc/ and is compiled with the Sphinx Python documentation generator, and is written in the reStructuredText format.

The Sphinx documentation is available here: http://sphinx-doc.org/latest/contents.html

Installing dependencies:

To compile the documentation, first ensure that Sphinx is installed. On Debian-based systems, this can be achieved as follows:

sudo apt-get install python-pip
sudo pip install sphinx

A LaTeX distribution is also required to compile the equations. Note that the extra packages are necessary to install the unicode packages. To compile the equations to PNG format for use in HTML pages, the package dvipng must be installed. IPython is also required. On Debian-based systems, this can be achieved as follows:

sudo apt-get install texlive texlive-latex-extra texlive-base texlive-recommended
sudo apt-get install dvipng
sudo apt-get install ipython

Compiling documentation:

The documentation can be compiled as follows:

cd doc
make html

The HTML files are then stored in doc/_build/

Running unit tests:

Ensure nose is installed via pip:

pip install nose

Run nosetests from the root directory of the repository:

nosetests -v