Metadata-Version: 2.1
Name: laboneq
Version: 1.2
Summary: Zurich Instrument tools for quantum information science
Home-page: https://github.com/zhinst/laboneq
Author: Zurich Instruments Development Team
Author-email: info@zhinst.com
License: Apache 2.0
Keywords: zhinst sdk quantum
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: ipykernel
Requires-Dist: marshmallow
Requires-Dist: marshmallow-enum
Requires-Dist: marshmallow-union
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: retworkx (==0.11.0)
Requires-Dist: numpy
Requires-Dist: python-box
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: sortedcollections
Requires-Dist: engineering-notation
Requires-Dist: intervaltree
Requires-Dist: jsonschema
Requires-Dist: pycparser
Requires-Dist: requests
Requires-Dist: setuptools (>=40.1.0)
Requires-Dist: wheel
Requires-Dist: zhinst-core (==22.8.36541)
Requires-Dist: zhinst-toolkit (~=0.4.3)
Requires-Dist: zhinst-utils (~=0.1.2)

![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
Instrument’s 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.7 or higher.** We assume that
> `pip3` and `python3` 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 commands will make LabOne Q available in your current
environment.

```sh
$ pip3 install --upgrade laboneq
```

## Documentation

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

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

The API Documentation is published here:
<https://docs.zhinst.com/labone_q_api/apidocs/modules.html>

## Architecture

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