ray/doc/source/install-on-macosx.rst
Robert Nishihara ab5d4a6010 Bring cloudpickle inside the repository. (#1445)
* Bring cloudpickle version 0.5.2 inside the repo.

* Use internal copy of cloudpickle everywhere.

* Fix linting.

* Import ordering.

* Change __init__.py.

* Set pickler in serialization context.

* Don't check ray location.
2018-01-25 11:36:37 -08:00

76 lines
1.6 KiB
ReStructuredText

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.
You can install Ray as follows.
.. 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
.. code-block:: bash
brew update
brew install cmake pkg-config automake autoconf libtool boost wget
pip install numpy funcsigs click colorama psutil redis flatbuffers cython --ignore-installed six
If you are using Anaconda, you may also need to run the following.
.. code-block:: bash
conda install libgcc
Install Ray
~~~~~~~~~~~
Ray can be built from the repository as follows.
.. code-block:: bash
git clone https://github.com/ray-project/ray.git
cd ray/python
python setup.py install # Add --user if you see a permission denied error.
Alternatively, Ray can be built from the repository without cloning using pip.
.. code-block:: bash
pip install git+https://github.com/ray-project/ray.git#subdirectory=python
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.
.. code-block:: bash
python test/runtest.py
Cleaning the source tree
~~~~~~~~~~~~~~~~~~~~~~~~
The source tree can be cleaned by running
.. code-block:: bash
git clean -f -f -x -d
in the ``ray/`` directory.