Regular installation (Anaconda Cloud)

In this example, we will use an existing conda environment named py38. Skip the first line/step if continuing on from the instructions to set up this environment.

Quick start

(base) C:\> conda activate py38
(base) C:\> conda config --env --add channels labscript-suite
(py38) C:\> conda install labscript-suite pyqt
(py38) C:\> labscript-profile-create
(py38) C:\> desktop-app install blacs lyse runmanager runviewer

Detailed instructions

  1. Activate the conda environment from the Anaconda Prompt.

(base) C:\> conda activate py38

  1. Add the labscript-suite channel on Anaconda Cloud to the current conda environment:

(py38) C:\> conda config --env --add channels labscript-suite

  1. Install the meta-package (labscript-suite) and bindings to the GUI toolkit (pyqt) from Anaconda Cloud. This will install blacs, labscript, labscript-devices, labscript-utils, lyse, runmanager, runviewer, and all dependencies:

(py38) C:\> conda install labscript-suite pyqt

  1. Create a profile directory in your home directory (the location of user data; see Recent changes to the labscript suite):

(py38) C:\> labscript-profile-create

  1. (Optional) Create shortcuts for the GUI applications (blacs, lyse, runmanager, and runviewer) and place them in the start-menu (or non-Windows OS equivalent).

    (py38) C:\> desktop-app install blacs lyse runmanager runviewer

    These will be named, e.g. ‘runmanager – the labcript suite (py38)’ which when clicked on will:

    • Launch the application without a terminal window, using the virtual environment the above command was called in.

    • Display the application with an application-specific shortcut in the taskbar (which can be pinned, like any other desktop application).

Note

Conda environments named anything other than base will be included in the name of the shortcut, e.g. ‘runmanager – the labscript suite (py38)’ for a conda environment named py38.

Alternatively, you can launch the applications from the Anaconda Prompt in the , e.g.

(py38) C:\> runmanager

This will print debugging information to the console.

To launch the applications detached from the console, suffix the application name with -gui, e.g.

(.venv) C:\> runmanager-gui

Note

  • You must have activated the conda environment in which the labscript suite was installed to use these commands.

  • For the -gui entry points to function in Anaconda Python, Step 5 (above) must be completed.

Updating a regular installation

Individual components of the labscript suite can be updated using the conda update command. For example:

(py38) C:\> conda update -c labscript-suite runmanager

To upgrade to a pre-release version, you can use the test label:

(py38) C:\> conda upadte -c labscript-suite/label/test runmanager

If updating multiple components, use a single conda update command to assist dependency resolution:

(py38) C:\> conda update -c labscript-suite labscript lyse runmanager

You can also update (or downgrade) to a specific version:

(py38) C:\> conda update runmanager==2.5.0