@cslab-lmu/jupyterlab_qcontrol3

QControl3 integration for jupyterlab

Usage no npm install needed!

<script type="module">
  import cslabLmuJupyterlabQcontrol3 from 'https://cdn.skypack.dev/@cslab-lmu/jupyterlab_qcontrol3';
</script>

README

jupyterlab_qcontrol3

QControl3 integration for jupyterlab

Features

  • correct indenting and highlighting for .pys files
  • run sequence files directly from jupyterlab

Ideas for the future

  • Display current status of the system (paused/running, current iteration status)
  • completion for defined channels
  • error messages from sequence compilation / execution (requires changes to qcontrol3_base)
  • buttons to control sequence

Requirements

  • JupyterLab >= 3.0
  • qcontrol3_base >= 0.4.0

Install

pip install jupyterlab_qcontrol3

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_qcontrol3 directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab_qcontrol3