Library with high-level drivers for lab equipment
Instrumental is a Python-based library for controlling lab hardware like cameras, DAQs, oscilloscopes, spectrometers, and more. It has high-level drivers for instruments from NI, Tektronix, Thorlabs, PCO, Photometrics, Burleigh, and others.
Version 0.6 will be the last release to support Python 2, which was sunset on January 1, 2020. Future versions will only support Python 3.7+.
Instrumental’s goal is to make common tasks simple to perform, while still providing the flexibility to perform complex tasks with relative ease. It also makes it easy to mess around with instruments in the shell. For example, to list the available instruments and open one of them:
>>> from instrumental import instrument, list_instruments >>> paramsets = list_instruments() >>> paramsets [<ParamSet[TSI_Camera] serial='05478' number=0>, <ParamSet[K10CR1] serial='55000247'> <ParamSet[NIDAQ] model='USB-6221 (BNC)' name='Dev1'>] >>> daq = instrument(paramsets) >>> daq <instrumental.drivers.daq.ni.NIDAQ at 0xb61...>
If you’re going to be using an instrument repeatedly, save it for later:
Then you can simply open it by name:
>>> daq = instrument('myDAQ')
Instrumental also bundles in some additional support code, including:
- A server-client implementation for controlling instruments from remote machines
- Plotting and curve fitting utilities
- Utilities for acquiring and organizing data
Instrumental makes use of NumPy, SciPy, Matplotlib, and Pint, a Python units library. It optionally uses PyVISA/VISA and other drivers for interfacing with lab equipment.
For install information, documentation, examples, and more, see our page on ReadTheDocs.
If you would like to cite Instrumental, to give it more visibility to other researchers, you can cite the repository through Zenodo (DOI: 10.5281/zenodo.2556398).
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size Instrumental_lib-0.6-py2.py3-none-any.whl (288.0 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size Instrumental-lib-0.6.zip (366.3 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for Instrumental_lib-0.6-py2.py3-none-any.whl