Metadata-Version: 2.4
Name: qubitos
Version: 0.7.3
Summary: Python modules for QubitOS quantum control kernel
Project-URL: Homepage, https://github.com/qubit-os/qubit-os
Project-URL: Documentation, https://qubit-os.github.io/qubit-os/
Project-URL: Repository, https://github.com/qubit-os/qubit-os
Project-URL: Issues, https://github.com/qubit-os/qubit-os/issues
Author: QubitOS Contributors
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: computing,control,grape,optimization,pulse,quantum
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: agentbible>=1.0.0
Requires-Dist: click>=8.0.0
Requires-Dist: grpcio>=1.60.0
Requires-Dist: httpx>=0.26.0
Requires-Dist: matplotlib>=3.7.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: protobuf>=4.25.0
Requires-Dist: pydantic>=2.5.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: qutip>=5.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: scipy>=1.12.0
Provides-Extra: dev
Requires-Dist: grpcio-tools>=1.60.0; extra == 'dev'
Requires-Dist: mypy>=1.8.0; extra == 'dev'
Requires-Dist: pre-commit>=3.6.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.2.0; extra == 'dev'
Requires-Dist: scipy-stubs>=1.17.0; extra == 'dev'
Requires-Dist: types-grpcio>=1.0.0; extra == 'dev'
Requires-Dist: types-protobuf>=4.0.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-gen-files>=0.5.0; extra == 'docs'
Requires-Dist: mkdocs-jupyter>=0.24.0; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.6.0; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.24.0; extra == 'docs'
Provides-Extra: gpu
Requires-Dist: cupy-cuda12x>=13; extra == 'gpu'
Description-Content-Type: text/plain

QubitOS Core
============

Open-source quantum control system: pulse optimization, multi-qubit
scheduling, calibration management, Lindblad simulation, and hardware
abstraction.

Current version: v0.7.0. Python 3.11+. Apache License 2.0.

This package is the Python module of the QubitOS monorepo. See the
top-level README.txt for the project overview and the monorepo layout.


Install
-------

From source (development):

    cd core
    python -m venv .venv && source .venv/bin/activate
    pip install -e ".[dev]"
    pytest

From PyPI (release):

    pip install qubitos


CLI quick reference
-------------------

    qubit-os pulse execute --local examples/x_gate.yaml
    qubit-os calibrator load <path>
    qubit-os hal health --server localhost:50051

Run with --help for full subcommand documentation.


What is in core/
----------------

    src/qubitos/
        calibrator/    Calibration loading, drift detection, T1/T2 fitting
        cli/           Command-line interface (entry point: qubit-os)
        client/        gRPC client to HAL server
        compilation/   Native gate compilation traits
        error_budget/  Cumulative error tracking
        feedback/      Lyapunov feedback controller, comparison framework,
                       visualization (v0.7.0)
        lindblad/      Python Lindblad solver (validation oracle)
        provenance/    Merkle tree experiment provenance
        pulsegen/      GRAPE optimizer, DRAG, Gaussian envelopes
        sme/           Stochastic master equation solver (v0.6.0)
        temporal/      Time model and constraint validation
        testing/       Test utilities and mock backends
        validation/    Input validation


Tests
-----

    pytest tests/                       Run the full suite
    pytest tests/unit/                  Unit tests only
    pytest --cov=qubitos                With coverage
    pytest -k "test_grape"              Substring match


Documentation
-------------

User guides and tutorials live under core/docs/ and build into the MkDocs
site at https://qubit-os.github.io/qubit-os/. See also:

    core/docs/guides/installation.md
    core/docs/guides/quickstart.md
    core/docs/specs/                    Per-subsystem design specs


Related modules
---------------

    ../hal/      Rust HAL server (gRPC backend dispatch)
    ../proto/    Protocol Buffer API contracts


License
-------

Apache 2.0. See ../LICENSE.
