Skip to main content

Code for use in lab environment: experiment automation, data acquisition, device communication

Project description

Overview

PyLabLib aims to provide support for device control and experiment automation. It interfaces with lots of different of devices, including several different camera interfaces, translational stages, oscilloscopes, AWGs, sensors, and more. The interface is implemented in a natural way through Python objects, and is easy to understand. For example, here is a complete script which steps Thorlabs KDC101 stage by 10000 steps ten times, and each time grabs a frame with Andor iXon camera:

from pylablib.devices import Thorlabs, Andor  # import the device libraries
import numpy as np  # import numpy for saving

# connect to the devices
with Thorlabs.KinesisMotor("27000000") as stage, Andor.AndorSDK2Camera() as cam:
    # change some camera parameters
    cam.set_exposure(50E-3)
    cam.set_roi(0, 128, 0, 128, hbin=2, vbin=2)
    # start the stepping loop
    images = []
    for _ in range(10):
        stage.move_by(10000)  # initiate a move
        stage.wait_move()  # wait until it's done
        img = cam.snap()  # grab a single frame
        images.append(img)

np.array(images).astype("<u2").tofile("frames.bin")  # save frames as raw binary

The list of the devices is constantly expanding.

Additional utilities are added to simplify data acquisition, storage, and processing:

  • Simplified data processing utilities: convenient fitting, filtering, feature detection, FFT (mostly wrappers around NumPy and SciPy).

  • Universal multi-level dictionaries which are convenient for storing heterogeneous data and settings in human-readable format.

  • Assorted functions for dealing with file system (creating, moving and removing folders, zipping/unzipping, path normalization), network (simplified interface for client and server sockets), strings (conversion of various Python objects to and from string), and more.

The most recent version of the library is available on GitHub (https://github.com/AlexShkarin/pyLabLib), and the documentation can be found at https://pylablib.readthedocs.io/ .

Requirements

  • Python 3 (tested with 3.6+)

  • Most extensively tested with Windows 10 and 64-bit Python. Linux is, in principle, supported, but devices which require manufacturer-provided DLLs (mostly cameras) might, potentially, have problems.

  • Basic version only needs numpy, SciPy and pandas. Advanced device communication packages (such as PyVISA and pySerial) are automatically installed, but can be avoided if necessary.

  • Some devices might require additional software. If this is the case, the requirements are mentioned on the corresponding page.

Installation

You can install the library from PyPi:

pip install pylablib

More options are described in the documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pylablib-1.1.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

pylablib-1.1.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file pylablib-1.1.0.tar.gz.

File metadata

  • Download URL: pylablib-1.1.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.5

File hashes

Hashes for pylablib-1.1.0.tar.gz
Algorithm Hash digest
SHA256 923d5eaa2a1751267c9f91e80b85414de59d4ccd2e3939435eabeb2da0304fdb
MD5 466682a1512a973435e637e0098071e7
BLAKE2b-256 c61f32273d6864be7c1cb5acc971711a6501909f6db0bea54e261bb529e10179

See more details on using hashes here.

File details

Details for the file pylablib-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: pylablib-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.5

File hashes

Hashes for pylablib-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 755c47e8bc818e295a32197476f642b73b344381f43244cb0d1913e3703d2068
MD5 fea9feb9e82131b97f270a24cf0e3d1a
BLAKE2b-256 7bceb071026057ce80321dcc4a19357685d884ef85450dfcf804ba1562a372b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page