From 38eb76d4965d2628441c19653a1831afbc969078 Mon Sep 17 00:00:00 2001 From: Max Zwiessele Date: Thu, 10 Sep 2015 08:38:45 +0100 Subject: [PATCH] [README] updated --- README.md | 46 ++++++++++++++++++++++++++++------------------ setup.py | 2 +- 2 files changed, 29 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 2a2775fb..4818b766 100644 --- a/README.md +++ b/README.md @@ -26,21 +26,16 @@ We like to pronounce it 'Gee-pie'. ### Getting started: installing with pip -We are now requiring the newest version of [scipy](http://www.scipy.org/) and thus, we strongly recommend using +We are now requiring the newest version (0.16) of +[scipy](http://www.scipy.org/) and thus, we strongly recommend using the [anaconda python distribution](http://continuum.io/downloads). With anaconda you can install GPy by the following: conda update scipy pip install gpy -. We've also had luck with [enthought](http://www.enthought.com), although enthought currently (as of 8th Sep. 2015) does not support scipy 0.16. - -On a fresh install of windows 8.1, we downloaded the Anaconda python distribution, started the anaconda command prompt and typed - - conda update scipy - 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 +We've also had luck with [enthought](http://www.enthought.com), +although enthought currently (as of 8th Sep. 2015) does not support scipy 0.16. 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. @@ -70,12 +65,12 @@ The command `python3 setup.py build_ext --inplace` builds the Cython extensions. * A set of benchmarks would be useful! -### Pronounciation - -We like to pronounce it 'Gee-pie'. ### Ubuntu hackers +:Note: Right now the Ubuntu package index does not include scipy 0.16.0, and thus, cannot +be used for GPy. We hope this gets fixed soon. + For the most part, the developers are using ubuntu. To install the required packages: sudo apt-get install python-numpy python-scipy python-matplotlib @@ -89,14 +84,29 @@ clone this git repository and add it to your path: ### OSX -Everything appears to work out-of-the box using -[anaconda python distribution](http://continuum.io/downloads) -on osx Mavericks. -Download/clone GPy, and then add GPy to your PYTHONPATH + +We were working hard to make pre-built distributions ready. +You can now install GPy via pip on MacOSX using +[anaconda python distribution](http://continuum.io/downloads): conda update scipy - git clone git@github.com:SheffieldML/GPy.git ~/SheffieldML - echo 'PYTHONPATH=$PYTHONPATH:~/SheffieldML' >> ~/.profile + pip install gpy + +If this does not work, then you need to build GPy yourself, +using the [development toolkits](https://developer.apple.com/xcode/). +Download/clone GPy and run the build process: + + conda update scipy + git clone git@github.com:SheffieldML/GPy.git ~/GPy + cd ~/GPy + python setup.py install + +If you do not wish to build the C extensions (10 times speedup), +you can run the pure python installations, by just adding GPy +to your python path. + + echo 'PYTHONPATH=$PYTHONPATH:~/SheffieldML' >> ~/.profile + ### Compiling documentation: diff --git a/setup.py b/setup.py index 096a61f8..f3d0eca4 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ def read(fname): def read_to_rst(fname): try: import pypandoc - print 'Warning in installation: For rst formatting in pypi, consider installing pypandoc for conversion' + #print 'Warning in installation: For rst formatting in pypi, consider installing pypandoc for conversion' return pypandoc.convert('README.md', 'rst') except: return read(fname)