ARTIQ for Visual Studio Code

The VS Code ARTIQ extension provides rich UI for the ARTIQ control system for quantum information experiments.

Requirements

• Visual Studio Code 1.98 or newer (or editors compatible with VS Code 1.98+ APIs).

• ARTIQ: HEAD of the master branch (what becomes release-9 one day). Clone directly from the repository, e.g.:

  git clone https://github.com/m-labs/artiq
  cd artiq
  nix run # obtain nix via https://nix.dev/install-nix#install-nix
  cd path/to/my/experiments
  artiq_master
  

Quick Start

Welcome! 👋🏻
Whether you are new to ARTIQ or an experienced ARTIQ user, we hope this extension fits your needs and enhances your working experience.

1. Install ARTIQ if you haven't already.

2. Install the VS Code ARTIQ extension.

3. Access the extension via Primary Sidebar and Panel. Select available experiments through the ARTIQ Explorer and they will pop-up in the Editor.

4. The extension depends on ms-python.python. If ms-python.python is missing, the extension will try to install it.

You are ready to go :-)    🎉🎉🎉

⚠️ Note: The extension expects to be run alongside artiq_master in the same filesystem tree.

What's next

• file an issue for problems with the extension.
• Start a GitHub discussion or get help in chat.
• Explore ARTIQ resources on m-labs.hk/artiq/manual/ and forum.m-labs.hk.

If you are new to ARTIQ, this article provides the overview on ARTIQ Real-Time I/O concepts and basic terminology.

Feature highlights

• Explorer - Jump to or peek at an experiment's class definition
• Experiment - Submit an experiment with custom options
• Arguments - Tweak experiment arguments before submission
• Datasets - Tweak or monitor data to and from experiments
• Schedule - Follow what's about to happen next on hardware
• Log - Evaluate results and errors as they appear