From fde843a636b0bd53b0930d6c5a848cd04c8e485c Mon Sep 17 00:00:00 2001 From: Robert Nishihara Date: Tue, 6 Jun 2017 22:51:06 -0700 Subject: [PATCH] Update installation documentation to recommend installing Ray with pip. (#637) --- doc/source/install-on-macosx.rst | 23 +++++++++++++++++------ doc/source/install-on-ubuntu.rst | 23 +++++++++++++++++------ 2 files changed, 34 insertions(+), 12 deletions(-) diff --git a/doc/source/install-on-macosx.rst b/doc/source/install-on-macosx.rst index 69c91fe1c..247aa6d90 100644 --- a/doc/source/install-on-macosx.rst +++ b/doc/source/install-on-macosx.rst @@ -4,10 +4,21 @@ Installation on Mac OS X Ray should work with Python 2 and Python 3. We have tested Ray on OS X 10.11 and 10.12. -Dependencies ------------- +You can install Ray as follows. -To install Ray, first install the following dependencies. We recommend using +.. code-block:: bash + + pip install ray + +Building Ray from source +------------------------ + +If you want to use the latest version of Ray, you can build it from source. + +Dependencies +~~~~~~~~~~~~ + +To build Ray, first install the following dependencies. We recommend using `Anaconda`_. .. _`Anaconda`: https://www.continuum.io/downloads @@ -27,7 +38,7 @@ If you are using Anaconda, you may also need to run the following. Install Ray ------------ +~~~~~~~~~~~ Ray can be built from the repository as follows. @@ -35,11 +46,11 @@ Ray can be built from the repository as follows. git clone https://github.com/ray-project/ray.git cd ray/python - python setup.py install --user + python setup.py install Test if the installation succeeded ----------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To test if the installation was successful, try running some tests. This assumes that you've cloned the git repository. diff --git a/doc/source/install-on-ubuntu.rst b/doc/source/install-on-ubuntu.rst index 56564a00f..608b16287 100644 --- a/doc/source/install-on-ubuntu.rst +++ b/doc/source/install-on-ubuntu.rst @@ -4,10 +4,21 @@ Installation on Ubuntu Ray should work with Python 2 and Python 3. We have tested Ray on Ubuntu 14.04 and Ubuntu 16.04. -Dependencies ------------- +You can install Ray as follows. -To install Ray, first install the following dependencies. We recommend using +.. code-block:: bash + + pip install ray + +Building Ray from source +------------------------ + +If you want to use the latest version of Ray, you can build it from source. + +Dependencies +~~~~~~~~~~~~ + +To build Ray, first install the following dependencies. We recommend using `Anaconda`_. .. _`Anaconda`: https://www.continuum.io/downloads @@ -32,7 +43,7 @@ If you are using Anaconda, you may also need to run the following. Install Ray ------------ +~~~~~~~~~~~ Ray can be built from the repository as follows. @@ -40,11 +51,11 @@ Ray can be built from the repository as follows. git clone https://github.com/ray-project/ray.git cd ray/python - python setup.py install --user + python setup.py install Test if the installation succeeded ----------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To test if the installation was successful, try running some tests. This assumes that you've cloned the git repository.