Installation

We’re excited to announce that accompanying the recent migration to GitHub in April–May 2020, labscript suite components are now distributed as Python packages on PyPI and (coming soon) Anaconda Cloud.

This makes it far easier to get started using the labscript suite, as you no longer require a Mercurial or Git installation (or any knowledge of version control software); components can be installed and upgraded using:

  • pip: the standard package manager common to all Python distributions; or
  • conda: a binary package and environment manager, part of the Anaconda Python distribution.

For further information, please see the installation documentation, which includes information about both regular and developer (editable) installations of the labscript suite.

Notes:

  • The labscript suite works on Python 3.6+.
  • The image acquisition application BIAS requires 32-bit LabVIEW, and is no longer actively maintained. Instead, we recommend using a Python-based camera server. Several of these have been written for a range of cameras, examples of which can be found in the labscript_devices code bade, e.g. Andor, FLIR FlyCapture 2, Basler pylon, and any camera compatible with National Instruments IMAQdx (most cameras compliant with the GigE Vision interface standard).
  • The optimisation framework mise is no longer supported. Autonomous optimisation can instead be implemented by writing an analysis script for lyse that uses the runmanager API to create new shots. An example extension using machine-learning online optimisation is analysislib-mloop.

Please contact us if you have problems with the installation process.

Getting help

To get advice on how to do something with the existing functionality of the labscript suite, and to be informed of updates to the code, please join our mailing list.

Join the labscript suite mailing list

Issue tracking

Development of the labscript suite now occurs on GitHub as of  April 2020. Please use the GitHub issue trackers for:

  • Reporting bugs (when something doesn’t work or works ina way you didn’t expect);
  • Suggesting enhancements: new features or requests;
  • Issues relating to installationperformance, or documentation.

License

The components of the labscript suite (unless otherwise stated) are copyright © 2013, Monash University, all rights reserved, and licensed under the simplified BSD license:

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.