|
1 | | -# labscript |
| 1 | +<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/labscript_32nx32n.svg" height="64" alt="the labscript suite" align="right"> |
2 | 2 |
|
| 3 | +# the _labscript suite_ » labscript |
3 | 4 |
|
4 | | -The labscript Python library provides a translation from simple Python code to complex hardware instructions. The library is used to construct a "connection table" containing information about what hardware is being used and how it is interconnected. Devices described in this connection table can then have their outputs set by using a range of functions, including arbitrary ramps. |
| 5 | +### Expressive composition of hardware-timed experiments |
5 | 6 |
|
6 | | -( |
7 | | -[view on Github](https://github.com/labscript-suite/labscript) |
8 | | -) |
| 7 | +[](https://github.com/labscript-suite/labscript/actions) |
| 8 | +[](https://github.com/labscript-suite/labscript/raw/master/LICENSE.txt) |
| 9 | +[](https://python.org) |
| 10 | +[](https://pypi.org/project/labscript) |
| 11 | +[](https://anaconda.org/labscript-suite/labscript) |
| 12 | +[](https://groups.google.com/forum/#!forum/labscriptsuite) |
| 13 | +<!-- [](https://doi.org/10.1063/1.4817213) --> |
| 14 | + |
| 15 | + |
| 16 | +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. |
| 17 | + |
| 18 | +<!-- Thus the experimenter writes a labscript primitive such as `laser_beam.constant(t=3, value=100, units='mW')` and this |
| 19 | +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. --> |
| 20 | + |
| 21 | + |
| 22 | +## Installation |
| 23 | + |
| 24 | +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. |
0 commit comments