Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions .github/workflows/code_quality.yml

This file was deleted.

41 changes: 0 additions & 41 deletions .github/workflows/tests.yml

This file was deleted.

78 changes: 0 additions & 78 deletions CHANGELOG.md

This file was deleted.

35 changes: 0 additions & 35 deletions CONTRIBUTING.md

This file was deleted.

38 changes: 3 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,6 @@
| | |
| --- | --- |
| Package | [![PyPI version](https://badge.fury.io/py/labone.svg)](https://badge.fury.io/py/labone) |
| Meta | [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff) [![code style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)|
| CI | ![](https://github.com/zhinst/labone-python/actions/workflows/github-code-scanning/codeql/badge.svg) ![](https://codecov.io/gh/zhinst/labone-python/branch/main/graph/badge.svg?token=VUDDFQE20M) ![](https://github.com/zhinst/labone-python/actions/workflows/code_quality.yml/badge.svg) ![](https://github.com/zhinst/labone-python/actions/workflows/tests.yml/badge.svg) |
-----

# LabOne Python API

The `labone` package provides a plain asynchronous Python API for [LabOne](https://www.zhinst.com/labone), the control software of Zurich Instruments.

> [!CAUTION]
> 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.
>
> 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`.
>

> [!NOTE]
> Since `labone` is not intended for direct usage, we do not offer any support
> or external documentation. Please contact [Zurich Instruments](mailto:info@zhinst.com) if you have any questions.

## LabOne compatibility
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.

| `labone` version | Minimum LabOne version | Best with LabOne |
| ---------------- | ---------------------- | ---------------- |
| up to 2.3 | 23.06 | 23.06 or later |
| up to 3.1.2 | 23.06 | 24.10 or later |
| from 3.2.0 | 23.06 | 25.01 or later |

## Internal Documentation

The internal documentation can be found [here](http://docs.pages.zhinst.com/internal-documentation-hub/async_labone/index.html).
Due to the early stage there is not public documentation.

## Contributing
The `labone` package has been removed for the time being.
Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/)
for the latest LabOne Python API.

See [Contributing](CONTRIBUTING.md)
16 changes: 4 additions & 12 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "labone"
dynamic = ["version"]
description = "Python API for Zurich Instruments LabOne software."
description = "Zurich Instruments."
readme = "README.md"
license = { text = "Apache 2.0" }
requires-python = ">=3.9"
Expand All @@ -14,7 +14,7 @@ authors = [
]
keywords = ["zhinst"]
classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 7 - Inactive",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: Apache Software License",
Expand All @@ -26,17 +26,11 @@ classifiers = [
"Programming Language :: Python :: 3.13",
"Topic :: Scientific/Engineering",
]
dependencies = [
"numpy>=1.20",
"packaging",
"typing_extensions>=4.8.0",
"zhinst-comms~=3.0",
]
dependencies = []

[project.urls]
homepage = "https://zhinst.com"
repository = "https://github.com/zhinst/labone-python"
changelog = "https://github.com/zhinst/labone-python/blob/main/CHANGELOG.md"
repository = "https://github.com/zhinst/toolkit"


[tool.hatch.version]
Expand Down Expand Up @@ -83,8 +77,6 @@ dependencies = [
"black>=24.8.0",
"mypy>=1.11.2",
"ruff>=0.6.4",
"numpy>=1.20",
"zhinst-comms~=3.0",
]

[tool.hatch.envs.lint.scripts]
Expand Down
20 changes: 9 additions & 11 deletions src/labone/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
"""Official package for the Zurich Instruments LabOne software."""
"""Deprecated package for the Zurich Instruments LabOne software.

from labone._version import __version__ # type: ignore[import]
from labone.core import ListNodesFlags
from labone.dataserver import DataServer
from labone.instrument import Instrument
The `labone` package has been removed for the time being.
Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/)
for the latest LabOne Python API.
"""

__all__ = [
"DataServer",
"Instrument",
"ListNodesFlags",
"__version__",
]
msg = """The `labone` package has been removed for the time being.
Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/)
for the latest LabOne Python API."""
raise ImportError(msg)
41 changes: 0 additions & 41 deletions src/labone/core/__init__.py

This file was deleted.

Loading