Metadata-Version: 2.4
Name: laboneq
Version: 26.1.1
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Dist: attrs>=24.3.0
Requires-Dist: cattrs>=25.1.0
Requires-Dist: cycler>=0.12.1
Requires-Dist: engineering-notation>=0.10.0
Requires-Dist: flask>=3.0.2
Requires-Dist: jsonschema>=4.21.1
Requires-Dist: matplotlib>=3.8.3
Requires-Dist: multimethod~=2.0.2
Requires-Dist: networkx>=3.4.2
Requires-Dist: numpy>=2
Requires-Dist: openpulse~=1.0.1
Requires-Dist: openqasm3~=1.0.0
Requires-Dist: orjson>=3.9.15
Requires-Dist: pybase64>=1.3.2
Requires-Dist: pycparser>=2.21
Requires-Dist: pygments>=2.18.0
Requires-Dist: python-box>=7.1.1
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: requests>=2.31.0
Requires-Dist: rich>=13.7.1
Requires-Dist: scipy>=1.12.0
Requires-Dist: sortedcollections>=2.1.0
Requires-Dist: sortedcontainers>=2.4.0
Requires-Dist: sqlitedict>=2.1.0
Requires-Dist: typeguard>=4.4.4
Requires-Dist: typing-extensions>=4.10.0
Requires-Dist: zhinst-comms>=3.4
Requires-Dist: zhinst-comms-schemas~=4.0.0
Requires-Dist: zhinst-core~=26.1.0
Requires-Dist: zhinst-timing-models~=26.1.0
Requires-Dist: zhinst-toolkit>=1.2.0
Requires-Dist: zhinst-utils==0.7.1
Requires-Dist: xarray>=2024 ; extra == 'xarray'
Provides-Extra: xarray
License-File: LICENSE
License-File: AUTHORS
Summary: Zurich Instruments LabOne Q software framework for quantum computing control
Keywords: quantum,sdk,zhinst
Author-email: Zurich Instruments Development Team <info@zhinst.com>
License-Expression: Apache-2.0
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/zhinst/laboneq

![LabOne Q logo](https://github.com/zhinst/laboneq/raw/main/docs/images/Logo_LabOneQ.png)


# LabOne Q

[LabOne Q](https://www.zhinst.com/quantum-computing-systems/labone-q) is Zurich
Instruments’ software framework to accelerate progress in quantum computing. Its
Python-based, high-level programming interface enables users to concentrate on
intuitive, efficient experiment design, while automatically accounting for their
instrumentation details and maximizing useful computation time. Tight system
integration between software and hardware ensures a seamless user experience
from setups with a single qubit to those with 100 and more.

## Requirements

> ⚠️ **This software requires Python 3.10 or higher.** We assume that
> `pip` and `python` use a corresponding Python version.

> 💡 To ease the maintenance of multiple installations, we recommended to
> use Python environments through e.g. **venv**, **pipenv** or **conda**.

## Installation

The following command will fetch the latest (quarterly) *stable* release of
LabOne Q from [PyPI](https://pypi.org/project/laboneq/) and make it available in
your current environment.

```sh
$ pip install --upgrade laboneq
```

*Preview* releases are typically published every two weeks and contain new
features, improvements, or bugfixes. They undergo the similar internal testing,
but do not receive backports of bugfixes. Preview releases can be installed
through:

```sh
$ pip install --upgrade --pre laboneq
```

If you instead would like to install from source, you will additionally need to install
a Rust toolchain. For this, follow the instructions on [rustup.rs](https://rustup.rs/).

## Documentation

Find the LabOne Q Manual here:
<https://docs.zhinst.com/labone_q_user_manual/>

Dive right into using LabOne Q and generate your first pulse sequence:
<https://docs.zhinst.com/labone_q_user_manual/getting_started/index.html>

The API Documentation is published here:
<https://docs.zhinst.com/labone_q_user_manual/core/reference/simple.html>

## Architecture

![Overview of the LabOne Q Software Stack](https://github.com/zhinst/laboneq/raw/main/docs/images/flowchart_QCCS.png)

