libmr 0.1.8

Project layout

• libMR Library source code and resources

• python A python wrapper for libMR using Cython

• examples Directory with example programs that test that also test for correctness

• doc C++ documentation; directory starts at html/index.html

C++ library

This needs CMake (version > 2.8)

Quick build instructions for Windows:

use CMake GUI
Source code = <where libmr is> libMR/libMR
Where to build binaries = < where libmr is > /libMR/build
Click generate
Select correct visual studio version compiler
Click yes to add directory build
Open Visual Studio Solution
Build ALL_BUILD project to build libmr
Build INSTALL project to install
Add install dir to path to link against libmr dll.

Quick build instructions for linux/Mac:

$ tar -zxf libMR.tgz
$ cd libMR
$ mkdir build;  % or whereyou like to build it
$ cd build
$ cmake ..
or to get a different installation directory
$ cmake -DCMAKE_INSTALL_PREFIX=<YOUR_INSTALLATON_PATH> ..
$ make

Running examples - Run after installing libMR:

$ examples/mr-test
$ examples/wlb-test

Optionally you can “install” it (by default in the system path – there you have to use sudo):

$ make install

There are built in tests in examples/mr-test to ensure it compiled correctly and is computing proper values

Python

Python bindings to LibMR are provided by Cython >=0.17. When building this way, LibMR is statically linked into the Python library which means you don’t have to build the entire package.

There are several ways to install LibMR for Python.

1. (preferred) Installing with Pip:

   This method will build LibMR as a Python extension and will install it into your python path. If you are inside a virtualenv, this allows you to install LibMR as a standard user without needing sudo:

   $ virtualenv venv && source venv/bin/activate
   $ pip install -r python/requirements.txt
   $ pip install .

   Update: libmr is now available on PyPI. To install the latest version, you can simply:

   $ pip install libmr

2. Building a shared object

   If you have Cython and NumPy already installed but you do not want to install LibMR into Python’s path, you can simply build the module directly:

   $ python setup.py build_ext -i

   This will place ‘libmr.so’ into the current folder. You can import it directly:

   $ file libmr.so
   libmr.so: ELF 64-bit LSB  shared object, ...
   $ python
   >>> import libmr
   >>> mr = libmr.MR()

   Now, move libmr.so into your project’s folder, or add this path into your PYTHONPATH environment variable.