ripy Documentation

Getting started with ripy

The Resolved Instruments Python module, ripy, is a python wrapper to the libri library providing control of the DPD80 photodetector from Python.

Python setup

ripy is currently only supported with Python 3.5 or later. It is also strongly recommended to use the 64 bit version of Python as the amount of data generated can quickly increase memory usage above the 4 GB limit of 32 bit applications.

For this tutorial it is assumed Python 3.6 and pip was installed to your system path and can be launched by opening a terminal (e.g. cmd or git-bash) and running python and pip.

If you already have a Python 2.7 install, you can install Python 3.6 at the same time without problems, however you may need to use the Python launcher, py to run the correct version of python. If this is the case, Python 3 can be started with py -3, and pip by using py -3 -m pip.

Finally, numpy is also a requirement for ripy, although it is recommended to install matplotlib and scipy at the same time. These can be installed with pip, or windows binaries for those packages compiled with the Intel Math Kernel Library (MKL) can be found at this site:

Alternatively, the Anaconda Python distribution includes these required packages.

ripy installation

  1. If you have not already downloaded and installed the Resolved Instruments RICU3 drivers, please install them from the downloads page.
  2. ripy is hosted on PyPI so it can be installed from the command line with pip install ri-python. Alternately, you can manually download the appropriate version of the ripy wheel (.whl) package for your version of python from the downloads page and install the wheel package in the command line with pip install /path/to/package.whl
  3. Test ripy installed successfully by running python and typing import ripy.
  4. If this command is run successfully, ripy has been installed.