Metadata-Version: 2.4
Name: qxlib
Version: 1.5.0rc4
Summary: Alternative installation entry point for the Qubex quantum experiment framework
Author: Akinori Machino
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/amachino/qubex
Project-URL: Documentation, https://amachino.github.io/qubex/
Project-URL: Issues, https://github.com/amachino/qubex/issues
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: qubex==1.5.0rc4
Provides-Extra: backend
Requires-Dist: qubex[backend]==1.5.0rc4; extra == "backend"
Provides-Extra: quel1
Requires-Dist: qubex[quel1]==1.5.0rc4; extra == "quel1"
Provides-Extra: quel3
Requires-Dist: qubex[quel3]==1.5.0rc4; extra == "quel3"
Dynamic: license-file

# qxlib

`qxlib` is an official alternative installation entry point for
[Qubex](https://github.com/amachino/qubex), maintained by Akinori Machino.
It installs Qubex and its companion libraries through normal Python package
dependencies, without copying their code or introducing another import namespace.

## Install

This first release is a **prerelease** for validating Qubex 1.5.0rc4.
Use a fresh Python 3.10+ environment:

```bash
pip install "qxlib==1.5.0rc4"
```

For the QuEL-1 hardware backend on Linux:

```bash
pip install "qxlib[backend]==1.5.0rc4"
```

`qxlib[quel1]` is an equivalent explicit extra. For QuEL-3 support:

```bash
pip install "qxlib[quel3]==1.5.0rc4"
```

Each extra forwards to the corresponding Qubex extra at the same version.
Hardware operation requires separate device configuration and authorization.

## Use

Use the existing Qubex Python imports:

```python
import qubex
from qubex.simulator import QuantumSimulator, QuantumSystem, Transmon
```

There is no `import qxlib` module. The `qxlib` distribution is the installer
entry point; `qubex`, `qxcore`, `qxpulse`, `qxschema`, `qxsimulator`, and
`qxvisualizer` provide the implementation. Installing `qxlib` and `qubex` at
the matching version in one environment does not duplicate those modules.

For rc3 or earlier installations, use a fresh environment or remove the old
companion distributions before upgrading, as explained in the
[Qubex migration guide](https://amachino.github.io/qubex/release-notes/v1-5-0-migration/).

## Documentation and support

- [Qubex source](https://github.com/amachino/qubex)
- [Qubex documentation](https://amachino.github.io/qubex/)
- [Report an issue](https://github.com/amachino/qubex/issues)

This distribution is maintained as a working dependency-based installer for
Qubex. Its dependency pins and forwarded extras are part of its release contract.
