Skip to main content

The `labbench` module provides API tools to support python scripting for laboratory automation.The goal is to simplify the process of developing an experimental procedure into clear, concise, explainable, and reusable code.

Project description

PyPI Latest Release DOI License Downloads Last commit Test coverage

The labbench module provides API tools to support python scripting for laboratory automation. The goal is to simplify the process of developing an experimental procedure into clear, concise, explainable, and reusable code. These characteristics are necessary to scale up the complexity of large testbeds and experiments.

Features include:

  • Expedited development of python device wrappers, including specialized backends for pythonnet, pyvisa, pyserial, subprocess, telnetlib
  • Descriptor-driven development: minimize the distance between programming manuals and python wrappers and apply calibrations transparently
  • Automated logging of simple device parameters into root CSV or sqlite root tables, pointing to relational data and metadata in json and plain-text
  • Simplified multi-threaded concurrency tools for lab applications
  • Container objects for nesting device wrappers and snippets of test procedures
  • Support for running experiments based on tables of test conditions

The source code was developed at NIST to support complex measurement efforts. Examples of these projects include:

Status

The project is under ongoing development

  • API changes have slowed, but deprecation warnings are not yet being provided
    • Suggest pinning labbench dependency to an exact version
  • Parts of the documentation are in need of updates, and others have not yet been written

Installation

  1. Prerequisites:
    • python (3.9-3.12)
    • an installer for python packages (pip, conda, etc.)
  2. Command-line package install options
    # option 1: preferred option in anaconda based distributions
    conda install conda-forge::labbench
    
    # option 2: preferred in other distributions
    pip install labbench
    

Resources

Contributing

Contributors

Name Contact
Dan Kuester (maintainer) daniel.kuester@nist.gov
Shane Allman Formerly with NIST
Paul Blanchard Formerly with NIST
Yao Ma yao.ma@nist.gov

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

labbench-0.42.0.tar.gz (105.7 kB view details)

Uploaded Source

Built Distribution

labbench-0.42.0-py3-none-any.whl (117.6 kB view details)

Uploaded Python 3

File details

Details for the file labbench-0.42.0.tar.gz.

File metadata

  • Download URL: labbench-0.42.0.tar.gz
  • Upload date:
  • Size: 105.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for labbench-0.42.0.tar.gz
Algorithm Hash digest
SHA256 693bc6975dca21d6852e6abd6c0af399459da058f304f922bc217e7140a1495b
MD5 592b96e8423ec83c0611b58546f6421d
BLAKE2b-256 67550839eef3c834275cdd5c9bae576249a931ec830783a80147686a8e0261e2

See more details on using hashes here.

File details

Details for the file labbench-0.42.0-py3-none-any.whl.

File metadata

  • Download URL: labbench-0.42.0-py3-none-any.whl
  • Upload date:
  • Size: 117.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for labbench-0.42.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84e59f80e9f69a5648b0471e3b6c2f22eabb41db286a041921776a52383bb1c0
MD5 fc8b8709aa0153bc54249316496e2001
BLAKE2b-256 5524fee9ffba96f2765c742bff8f7ec1d11b1bc1cc7a8e24e3f0991e65cd1afe

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