Metadata-Version: 2.4
Name: labscript
Version: 3.4.1
Summary: The labscript compiler — expressive control of harware-timed experiments
Author-email: The labscript suite community <labscriptsuite@googlegroups.com>
License: Copyright (c) 2013, Monash University
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met: 
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer. 
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution. 
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
        ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Homepage, http://labscriptsuite.org/
Project-URL: Documentation, https://docs.labscriptsuite.org/
Project-URL: Repository, https://github.com/labscript-suite/labscript/
Project-URL: Downloads, https://github.com/labscript-suite/labscript/releases/
Project-URL: Tracker, https://github.com/labscript-suite/labscript/issues/
Keywords: experiment control,automation
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: labscript_utils>=3.0.0
Requires-Dist: numpy>=1.15
Requires-Dist: scipy
Requires-Dist: matplotlib
Provides-Extra: docs
Requires-Dist: PyQt5; extra == "docs"
Requires-Dist: Sphinx==8.2.3; extra == "docs"
Requires-Dist: sphinx-rtd-theme==3.0.2; extra == "docs"
Requires-Dist: myst_parser==4.0.1; extra == "docs"
Requires-Dist: numpy<2; extra == "docs"
Dynamic: license-file

<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/labscript_32nx32n.svg" height="64" alt="the labscript suite" align="right">

# the _labscript suite_ » labscript

### Expressive composition of hardware-timed experiments

[![Actions Status](https://github.com/labscript-suite/labscript/workflows/Build%20and%20Release/badge.svg)](https://github.com/labscript-suite/labscript/actions)
[![License](https://img.shields.io/pypi/l/labscript.svg)](https://github.com/labscript-suite/labscript/raw/master/LICENSE.txt)
[![Python Version](https://img.shields.io/pypi/pyversions/labscript.svg)](https://python.org)
[![PyPI](https://img.shields.io/pypi/v/labscript.svg)](https://pypi.org/project/labscript)
[![Conda Version](https://img.shields.io/conda/v/labscript-suite/labscript)](https://anaconda.org/labscript-suite/labscript)
[![Google Group](https://img.shields.io/badge/Google%20Group-labscriptsuite-blue.svg)](https://groups.google.com/forum/#!forum/labscriptsuite)
<!-- [![DOI](http://img.shields.io/badge/DOI-10.1063%2F1.4817213-0F79D0.svg)](https://doi.org/10.1063/1.4817213) -->


The **labscript** Python library permits expressive composition of hardware-timed experiments. Hardware connections and experiment logic are described using Python classes, functions and methods, which labscript translates into low-level primitives specific to individual instruments.

<!-- Thus the experimenter writes a labscript primitive such as `laser_beam.constant(t=3, value=100, units='mW')` and this
will add an entry to the table of instructions for whichever digital-to-analogue converter is controlling the a laser beam to output 100 mW, 3 seconds after the experiment commences. This is a simple example, but has advantages over having a human write tables of instructions for scientific instruments directly. -->


## Installation

labscript is distributed as a Python package on [PyPI](https://pypi.org/user/labscript-suite) and [Anaconda Cloud](https://anaconda.org/labscript-suite), and should be installed with other components of the _labscript suite_. Please see the [installation guide](https://docs.labscriptsuite.org/en/latest/installation) for details.
