ray/doc/source/install-on-macosx.md
Robert Nishihara 53dffe0bf2 Use flatbuffers for some messages from Redis. (#341)
* Compile the Ray redis module with C++.

* Redo parsing of object table notifications with flatbuffers.

* Update redis module python tests.

* Redo parsing of task table notifications with flatbuffers.

* Fix linting.

* Redo parsing of db client notifications with flatbuffers.

* Redo publishing of local scheduler heartbeats with flatbuffers.

* Fix linting.

* Remove usage of fixed-width formatting of scheduling state in channel name.

* Reply with flatbuffer object to task table queries, also simplify redis string to flatbuffer string conversion.

* Fix linting and tests.

* fix

* cleanup

* simplify logic in ReplyWithTask
2017-03-10 18:35:25 -08:00

1.4 KiB

Installation on Mac OS X

Ray should work with Python 2 and Python 3. We have tested Ray on OS X 10.11.

Dependencies

To install Ray, first install the following dependencies. We recommend using Anaconda.

brew update
brew install cmake automake autoconf libtool boost wget

pip install numpy cloudpickle funcsigs colorama psutil redis flatbuffers --ignore-installed six

If you are using Anaconda, you may also need to run the following.

conda install libgcc

Install Ray

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

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.

python test/runtest.py

Optional - web UI

Ray's web UI requires Python 3. To enable the web UI to work, install these Python packages.

pip install aioredis asyncio websockets

Then install polymer, which also requires Node.js and Bower.

Once you've installed Polymer, run the following.

cd ray/webui
bower install

Then while Ray is running, you should be able to view the web UI at http://localhost:8080.