From b0c03343599af28f1d168059773bb391a9303ee4 Mon Sep 17 00:00:00 2001 From: James Hensman Date: Fri, 21 Nov 2014 17:59:01 +0000 Subject: [PATCH] Update README.md --- README.md | 74 +++++++++++++++++++++++++------------------------------ 1 file changed, 33 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index ab43556a..8c32f01d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -GPy -=== +# GPy + A Gaussian processes framework in Python. @@ -10,8 +10,7 @@ A Gaussian processes framework in Python. Continuous integration status: ![CI status](https://travis-ci.org/SheffieldML/GPy.png) -Citation -======== +### Citation @Misc{gpy2014, author = {The GPy authors}, @@ -20,23 +19,29 @@ Citation year = {2012--2014} } -Pronounciation -============== +### Pronounciation + We like to pronounce it 'Gee-pie'. -Getting started -=============== -Installing with pip -------------------- -The simplest way to install GPy is using pip. ubuntu users can do: +### Getting started: installing with pip + +The simplest way to install GPy is using pip. Ubuntu users can do: sudo apt-get install python-pip pip install gpy + +On windows, we recommend the ![anaconda python distribution](http://continuum.io/downloads). We've also had luck with ![enthought](http://www.enthought.com). + +On a fresh install of windows 8.1, we downloaded the Anaconda python distribution, started the anaconda command prompt and typed + + pip install GPy + +Everything seems to work: from here you can type `ipython` and then `import GPy; GPy.tests()`. Working as of 21/11/14 If you'd like to install from source, or want to contribute to the project (e.g. by sending pull requests via github), read on. -Ubuntu ------- +### Ubuntu hackers + For the most part, the developers are using ubuntu. To install the required packages: sudo apt-get install python-numpy python-scipy python-matplotlib @@ -47,33 +52,25 @@ clone this git repository and add it to your path: echo 'PYTHONPATH=$PYTHONPATH:~/SheffieldML' >> ~/.bashrc -Windows -------- -On windows, we recommend the ![anaconda python distribution](http://continuum.io/downloads). We've also had luck with ![enthought](http://www.enthought.com). git clone or unzip the source to a suitable directory, and add an approptiate PYTHONPATH environment variable. + +### OSX -On a fresh install of windows 8.1, we downloaded the Anaconda python distribution, started the anaconda command prompt and typed - - pip install GPy - -Everything seems to work: from here you can type `ipython` and then `import GPy; GPy.tests()`. Working as of 21/11/14. -OSX ---- Everything appears to work out-of-the box using ![enthought](http://www.enthought.com) on osx Mavericks. Download/clone GPy, and then add GPy to your PYTHONPATH git clone git@github.com:SheffieldML/GPy.git ~/SheffieldML echo 'PYTHONPATH=$PYTHONPATH:~/SheffieldML' >> ~/.profile -Compiling documentation: -======================== +### 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: ------------------------- +##### Installing dependencies: + To compile the documentation, first ensure that Sphinx is installed. On Debian-based systems, this can be achieved as follows: @@ -87,8 +84,8 @@ A LaTeX distribution is also required to compile the equations. Note that the ex sudo apt-get install ipython -Compiling documentation: ------------------------- +#### Compiling documentation: + The documentation can be compiled as follows: @@ -98,8 +95,8 @@ The documentation can be compiled as follows: The HTML files are then stored in doc/_build/ -Running unit tests: -=================== +## Running unit tests: + Ensure nose is installed via pip: @@ -109,19 +106,14 @@ Run nosetests from the root directory of the repository: nosetests -v +or from within IPython -How to cite GPy: -================ - @misc{GPy2014, - Author = {the GPy authors}, - Title = {{GPy}: A Gaussian process framework in python}, - Year = {2014}, - Howpublished = {\url{https://github.com/SheffieldML/GPy}} - } + import GPy; GPy.tests() -Funding Acknowledgements -======================== + +## Funding Acknowledgements + Current support for the GPy software is coming through the following projects.