Update README after moving libpyarrow to main C++ source tree

Change-Id: Ie35d13ca1b8e0dcb328bf94b451067604a985ec9
This commit is contained in:
Wes McKinney committed 2017-03-27 09:59:43 -04:00
1 parent 3aac4adef1
commit 2608d2b784
2 files changed
+28 -13

No files matched your search

+10
View File
@@ -81,6 +81,16 @@ variables
* Hadoop: `HADOOP_HOME` (only required for the HDFS I/O extensions)
* jemalloc: `JEMALLOC_HOME` (only required for the jemalloc-based memory pool)
### Building Python integration library
The `arrow_python` shared library can be built by passing `-DARROW_PYTHON=on`
to CMake. This must be installed or in your library load path to be able to
build pyarrow, the Arrow Python bindings.
The Python library must be built against the same Python version for which you
are building pyarrow, e.g. Python 2.7 or Python 3.6. NumPy must also be
installed.
### API documentation
To generate the (html) API documentation, run the following command in the apidoc
+18 -13
View File
@@ -22,25 +22,30 @@ other traditional Python scientific computing packages.
This project is layered in two pieces:
* pyarrow, a C++ library for easier interoperability between Arrow C++, NumPy,
and pandas
* Cython extensions and pure Python code under arrow/ which expose Arrow C++
* arrow_python, a library part of the main Arrow C++ project for Python,
pandas, and NumPy interoperability
* Cython extensions and pure Python code under pyarrow/ which expose Arrow C++
and pyarrow to pure Python users
#### PyArrow Dependencies:
These are the various projects that PyArrow depends on.
1. **g++ and gcc Version >= 4.8**
2. **cmake > 2.8.6**
3. **boost**
4. **Arrow-cpp and its dependencies**
To build pyarrow, first build and install Arrow C++ with the Python component
enabled using `-DARROW_PYTHON=on`, see
(https://github.com/apache/arrow/blob/master/cpp/README.md) . These components
must be installed either in the default system location (e.g. `/usr/local`) or
in a custom `$ARROW_HOME` location.
The Arrow C++ library must be built with all options enabled and installed with
``ARROW_HOME`` environment variable set to the installation location. Look at
(https://github.com/apache/arrow/blob/master/cpp/README.md) for instructions.
```shell
mkdir cpp/build
pushd cpp/build
cmake -DARROW_PYTHON=on -DCMAKE_INSTALL_PREFIX=$ARROW_HOME ..
make -j4
make install
```
Ensure PyArrow can locate the Arrow-cpp shared libraries by setting the
LD_LIBRARY_PATH environment variable.
If you build with a custom `CMAKE_INSTALL_PREFIX`, during development, you must
set `ARROW_HOME` as an environment variable and add it to your
`LD_LIBRARY_PATH` on Linux and OS X:
```bash
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ARROW_HOME/lib