|
1 | | -| | | |
2 | | -| --- | --- | |
3 | | -| Package | [](https://badge.fury.io/py/labone) | |
4 | | -| Meta | [](https://github.com/pypa/hatch) [](https://github.com/charliermarsh/ruff) [](https://github.com/psf/black) [](https://github.com/python/mypy) [](https://opensource.org/licenses/Apache-2.0)| |
5 | | -| CI |     | |
6 | | ------ |
7 | | - |
8 | 1 | # LabOne Python API |
9 | 2 |
|
10 | | -The `labone` package provides a plain asynchronous Python API for [LabOne](https://www.zhinst.com/labone), the control software of Zurich Instruments. |
11 | | - |
12 | | -> [!CAUTION] |
13 | | -> This API package is solely being developed to support [LabOne Q](https://www.zhinst.com/quantum-computing-systems/labone-q), the software framework for quantum computing. |
14 | | -> |
15 | | -> For direct access to the instruments without LabOne Q, the standard Python API for all Zurich Instruments' devices is provided through the `zhinst` package and can be obtained from [PyPI](https://pypi.org/project/zhinst/) by `pip install zhinst`. |
16 | | -> |
17 | | -
|
18 | | -> [!NOTE] |
19 | | -> Since `labone` is not intended for direct usage, we do not offer any support |
20 | | -> or external documentation. Please contact [Zurich Instruments](mailto:info@zhinst.com) if you have any questions. |
21 | | -
|
22 | | -## LabOne compatibility |
23 | | -The `labone` package is broadly compatible with any LabOne version greater or equal than 23.06. When used with older versions of LabOne, some features may not be available or only partially working. |
24 | | - |
25 | | -| `labone` version | Minimum LabOne version | Best with LabOne | |
26 | | -| ---------------- | ---------------------- | ---------------- | |
27 | | -| up to 2.3 | 23.06 | 23.06 or later | |
28 | | -| up to 3.1.2 | 23.06 | 24.10 or later | |
29 | | -| from 3.2.0 | 23.06 | 25.01 or later | |
30 | | - |
31 | | -## Internal Documentation |
32 | | - |
33 | | -The internal documentation can be found [here](http://docs.pages.zhinst.com/internal-documentation-hub/async_labone/index.html). |
34 | | -Due to the early stage there is not public documentation. |
35 | | - |
36 | | -## Contributing |
| 3 | +The `labone` package has been removed for the time being. |
| 4 | +Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/) |
| 5 | +for the latest LabOne Python API. |
37 | 6 |
|
38 | | -See [Contributing](CONTRIBUTING.md) |
0 commit comments