From 603a7e3dd3058f76fc75837cbae0c24b5cfe3ca5 Mon Sep 17 00:00:00 2001 From: Robert Nishihara Date: Fri, 30 Dec 2016 23:15:25 -0800 Subject: [PATCH] Add documentation for troubleshooting installation. (#167) --- README.md | 1 + doc/installation-troubleshooting.md | 31 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 doc/installation-troubleshooting.md diff --git a/README.md b/README.md index bac386836..0afcf9819 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ estimate of pi (waiting until the computation has finished if necessary). ## Next Steps - Installation on [Ubuntu](doc/install-on-ubuntu.md), [Mac OS X](doc/install-on-macosx.md) + - [Troubleshooting](doc/installation-troubleshooting.md) - [Tutorial](doc/tutorial.md) - Documentation - [Serialization in the Object Store](doc/serialization.md) diff --git a/doc/installation-troubleshooting.md b/doc/installation-troubleshooting.md new file mode 100644 index 000000000..70045db2e --- /dev/null +++ b/doc/installation-troubleshooting.md @@ -0,0 +1,31 @@ +# Installation Troubleshooting + +## Trouble installing Numbuf + +### Arrow fails to build +If the installation of Numbuf fails, chances are there was a problem building +Arrow. Some candidate possibilities. + +#### You have a different version of Flatbuffers installed + +Arrow pulls and builds its own copy of Flatbuffers, but if you already have +Flatbuffers installed, Arrow may find the wrong version. If a directory like +`/usr/local/include/flatbuffers` shows up in the output when installing Numbuf, +this may be the problem. To solve it, get rid of the old version of flatbuffers. + +#### There is some problem with Boost + +If a message like `Unable to find the requested Boost libraries` appears when +installing Numbuf, there may be a problem with Boost. This can happen if you +installed Boost using MacPorts. This is sometimes solved by using Brew instead. + +## Trouble installing or running Ray + +### One of the Ray libraries is compiled against the wrong version of Python + +If there is a segfault or a sigabort immediately upon importing Ray, one of the +components may have been compiled against the wrong Python libraries. CMake +should normally find the right version of Python, but this process is not +completely reliable. In this case, check the CMake output from installation and +make sure that the version of the Python libraries that were found match the +version of Python that you're using.