cyflann 0.2.2

A Cython-based interface to the FLANN nearest neighbors library.

cyflann

This is a Cython-based interface to the FLANN library.

If you’re just looking for any Python interface to FLANN, the ctypes interface that it ships with may be better for you. I wrote this interface for an application that needs to run lots of independent searches without the GIL.

The interface is currently incomplete; right now only float32 is supported, it also has some known issues, and is probably less friendly in general than it could be. If you want to use it, bug reports and/or pull requests are welcome.

cyflann is only tested with FLANNs since 1.8.4. cyflann supports FLANN’s OpenMP wrappers, but has not been tested with its MPI or CUDA interfaces.

Installation

If you use the Anaconda Python distribution, the easiest way to get both cyflann and FLANN is:

conda install -c dougal cyflann

Otherwise, you need to install FLANN yourself, and can then run:

pip install cyflann

NOTE: If you’re using FLANN 1.8.4 or earlier, a problem with its pkg-config files means that cyflann won’t link properly. This has been fixed in the development branch since April 2013, but the 1.9.1 release isn’t yet widely packaged.

To work around this problem, set the environment variable FLANN_DIR to the root of the installation before running pip or setup.py, e.g. /usr/local if the libraries are in /usr/local/lib/libflann.so. If you’re using sudo, remember that it doesn’t necessarily propagate environment variables by default; sudo FLANN_DIR=/wherever pip install cyflann will work.

Installing FLANN

Anaconda: conda install -c dougal flann (included as a requirement by the cyflann package).

OSX: using Homebrew, brew install homebrew/science/flann; set FLANN_DIR=$(brew --prefix).

Ubuntu: apt-get install libflann1 flann-dev; set FLANN_DIR=/usr.

Fedora: yum install flann flann-devel; set FLANN_DIR=/usr.

CentOS: EPEL has flann packages, but they’re old and not tested with cyflann. Compile from source.

Arch: Install the AUR flann package; cyflann wants FLANN_DIR=/usr.

From source: Download the release source or get the latest version from github (it’s generally pretty stable), and follow the user manual to install. If you’re installing the development branch and have pkg-config available, you shouldn’t need to set FLANN_DIR, but if not set it to whatever you set CMAKE_INSTALL_PREFIX to (/usr/local by default).