Installation

The package exposes one optional extra per notebook frontend. Install the one you use, or both:

uv add "qibocal-widgets[marimo]"
uv add "qibocal-widgets[jupyter]"

or, with pip:

pip install "qibocal-widgets[marimo,jupyter]"

The jupyter extra installs ipywidgets, used to render accordions and tabs.

Qibocal version

qibocal-widgets targets the executor interface developed on the protodev branch of Qibocal. Until that is released, pin Qibocal to the branch in your own project:

[tool.uv.sources]
qibocal = { git = "https://github.com/qiboteam/qibocal.git", branch = "protodev" }

and install qibocal-widgets itself from the repository:

uv add "qibocal-widgets[marimo] @ git+https://github.com/qiboteam/qibocal-widgets"

Development

git clone https://github.com/qiboteam/qibocal-widgets
cd qibocal-widgets
uv sync --all-extras --group tests --group analysis --group docs
uv run pytest
uv run --with poethepoet poe docs

devenv users can run devenv shell instead: it installs Python, all the extras and development groups (the example simulator included), poe, prek and Jupyter, and sets QIBOLAB_PLATFORMS to the example platforms.