https://github.com/mabuchilab/Instrumental

Python-based instrumentation library from the Mabuchi Lab.
https://github.com/mabuchilab/Instrumental

Last synced: 2 months ago
JSON representation

Python-based instrumentation library from the Mabuchi Lab.

• Host: GitHub
• URL: https://github.com/mabuchilab/Instrumental
• Owner: mabuchilab
• License: gpl-3.0
• Created: 2013-10-21T23:39:12.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-21T14:57:05.000Z (3 months ago)
• Last Synced: 2024-03-26T10:04:49.590Z (3 months ago)
• Language: Python
• Homepage: http://instrumental-lib.readthedocs.org/
• Size: 2.37 MB
• Stars: 112
• Watchers: 28
• Forks: 76
• Open Issues: 62
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: docs/contributing.rst
  • License: LICENSE
  • Authors: AUTHORS

Lists

• awesome_photonics - instrumental
• awesome-iontraps - Instrumental - Python-based instrumentation library from the Mabuchi Lab (Software / Experiment)

README

        
.. image:: https://img.shields.io/travis/mabuchilab/Instrumental/master.svg

    :target: https://travis-ci.org/mabuchilab/Instrumental

    :alt: Travis CI

.. image:: https://img.shields.io/appveyor/ci/natezb/Instrumental/master.svg

    :target: https://ci.appveyor.com/project/natezb/instrumental

    :alt: AppVeyor CI

.. image:: https://img.shields.io/pypi/v/Instrumental-lib.svg

    :target: https://pypi.python.org/pypi/Instrumental-lib

    :alt: PyPI

.. image:: https://readthedocs.org/projects/instrumental-lib/badge/

   :target: https://instrumental-lib.readthedocs.io

   :alt: Documentation

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2556398.svg

   :target: https://doi.org/10.5281/zenodo.2556398

|logo| Instrumental

===================

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.

 **Note**

 As of version 0.7, Instrumental has dropped support for Python 2 and now requires 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

    [,

     

     ]

    >>> daq = instrument(paramsets[2])

    >>> daq

    

If you're going to be using an instrument repeatedly, save it for later::

    >>> daq.save_instrument('myDAQ')

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 `_.

.. |logo| image:: images/logo-small.png

          :alt: Instrumental

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 `_).