Metadata-Version: 2.4
Name: qiskit_ibm_catalog
Version: 0.20.0
Summary: Client for the IBM Quantum Platform's Qiskit Functions service
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/Qiskit/qiskit-ibm-catalog
Project-URL: Bug Tracker, https://github.com/Qiskit/qiskit-ibm-catalog/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: importlib-metadata>=9.0.1
Requires-Dist: qiskit-serverless~=0.36.0
Dynamic: license-file

![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational)
[![Python](https://img.shields.io/badge/Python-3.10--3.13-informational)](https://www.python.org/)
[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%201.0.0-6133BD)](https://github.com/Qiskit/qiskit)
[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/qiskit-community/quantum-prototype-template/blob/main/LICENSE.txt)
[![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)
[![Tests](https://github.com/qiskit-community/quantum-prototype-template/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/qiskit-community/quantum-prototype-template/actions/workflows/test_latest_versions.yml)
[![Coverage](https://coveralls.io/repos/github/qiskit-community/quantum-prototype-template/badge.svg?branch=main)](https://coveralls.io/github/qiskit-community/quantum-prototype-template?branch=main)

# Qiskit Functions Catalog IBM Client

Client for the IBM Quantum Platform's Qiskit Functions service.

[Qiskit Functions](https://quantum.cloud.ibm.com/functions) are abstracted services designed to accelerate application research. They simplify and accelerate utility-scale algorithm discovery and application development, by abstracting away parts of the quantum software development workflow.

This module provides the interface to access the Qiskit Functions service on IBM Quantum Platform.

### Table of Contents

##### For Users

1.  [Installation](#installation)
2.  [Quickstart Guide](#quickstart-guide)
3.  [Tutorials](docs/tutorials)
4.  [File Glossary](docs/file-map-and-description.md)
5.  [How to Give Feedback](#how-to-give-feedback)
6.  [Contribution Guidelines](#contribution-guidelines)
7. [References and Acknowledgements](#references-and-acknowledgements)
8. [License](#license)

##### For Developers/Contributors

1. [Contribution Guide](CONTRIBUTING.md)
2. [Technical Docs](docs/technical_docs.md)

----------------------------------------------------------------------------------------------------

### Installation

```shell
pip install qiskit-ibm-catalog
```


### Quickstart guide

```python
from qiskit_ibm_catalog import QiskitFunctionsCatalog

catalog = QiskitFunctionsCatalog(token=..., instance=...)

catalog.list()
# [<QiskitFunction("ibm/...")>, ...]

function = catalog.load("ibm/...")

job = function.run(circuit=...)

job.logs()

job.result()
```

----------------------------------------------------------------------------------------------------

### How to Give Feedback

We encourage your feedback! You can share your thoughts with us by:
- [Opening an issue](https://github.com/Qiskit/qiskit-ibm-catalog/issues) in the repository


----------------------------------------------------------------------------------------------------

### Contribution Guidelines

For information on how to contribute to this project, please take a look at our [contribution guidelines](CONTRIBUTING.md).


----------------------------------------------------------------------------------------------------

## References and Acknowledgements
[1] Qiskit SDK \
    https://github.com/Qiskit/qiskit


----------------------------------------------------------------------------------------------------

### License
[Apache License 2.0](LICENSE.txt)
