Metadata-Version: 2.4
Name: ibm-quantum-schemas
Version: 0.7rc1
Summary: IBM Quantum Pydantic models.
Author-email: Qiskit Development Team <qiskit@us.ibm.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/Qiskit/ibm-quantum-schemas
Project-URL: BugTracker, https://github.com/Qiskit/ibm-quantum-schemas
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pydantic<3.0.0,>=2.11
Requires-Dist: qiskit<3.0.0,>=2.2.0
Requires-Dist: samplomatic>=0.12.0
Requires-Dist: pybase64>=1.3.0
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-error-for-skips; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: towncrier; extra == "dev"
Provides-Extra: documentation
Requires-Dist: Sphinx>=6; extra == "documentation"
Requires-Dist: sphinx-automodapi; extra == "documentation"
Requires-Dist: sphinx-autodoc-typehints<=1.19.2; extra == "documentation"
Requires-Dist: sphinxcontrib-katex==0.9.9; extra == "documentation"
Requires-Dist: autodoc_pydantic==2.2.0; extra == "documentation"
Dynamic: license-file

# IBM Quantum Schemas

This repository contains the Pydantic models that describe the inputs and outputs of IBM Quantum
primitives and programs, to allow easier programmatic interfacing from Python.

The resulting `ibm-quantum-schemas` Python package contains the versioned definition of such
inputs and outputs, using the following structure:

```
ibm_quantum_schemas.<program>.version_<x_y>
```

Please note:
* this package contains multiple versions of the models, using semantic versioning in the last
  component of the module name (`.version_<x_y>`).
* when a new version is in development, it will contain a `_dev` suffix for signalling it
  (`.version_<x_y>_dev`). Such versions are not considered stable yet.
* other (non `_dev`) versions included in releases of this package are considered stable, albeit
  not all of them might be supported by the IBM Quantum platform at a given time. In particular,
  the programs included in the initial release of this library (`executor` and `noise_learner_v3`)
  are considered beta and not yet supported.
* please refer to the [Qiskit Runtime REST API] for the programs and their versions supported by
  the IBM Quantum platform.

## History

> [!WARNING]
> The purpose of this repository has changed. Prior to October 2025, the
> repository hosted JSONSchema files that dictated the request and response payloads
> for the primary IBM Quantum API payloads that allowed interacting with
> devices. Primarily, the Qobj, backend configuration, backend properties,
> pulse defaults, and result schemas.

[Qiskit Runtime REST API]: https://quantum.cloud.ibm.com/docs/en/api/qiskit-runtime-rest
