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 USB Photodetector and the DPD80 Balanced Photodetector from Python.

Python setup

ripy is 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.7 was installed to your system path. If you already have a Python 2.7 install, you can install Python 3.7 at the same time without problems, however it may be easier 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 command.

Note

As of version 0.9.7, ripy can be installed with Python 2.7. However it is not well supported and it is strongly recommended to use Python 3.5+ unless absolutely required.

To install ripy, numpy is a requirement. When installing ripy with pip, numpy will be automatically installed. However, for slightly improved performance windows binaries for numpy compiled with the Intel Math Kernel Library (MKL) can be found at this site: http://www.lfd.uci.edu/~gohlke/pythonlibs/.

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:

    py -3 -m 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

    py -3 -m pip install /path/to/package.whl

  3. Test ripy installed successfully by running py -3 and typing import ripy.

  4. If this command is run successfully, ripy has been installed.