Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Qiskit/qiskit-serverless

A programming model for leveraging quantum and classical resources
https://github.com/Qiskit/qiskit-serverless

cloud python qiskit qiskit-serverless quantum-computing

Last synced: 17 days ago
JSON representation

A programming model for leveraging quantum and classical resources

Host: GitHub
URL: https://github.com/Qiskit/qiskit-serverless
Owner: Qiskit
License: apache-2.0
Created: 2022-09-15T18:33:43.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-05-22T19:18:17.000Z (about 1 month ago)
Last Synced: 2024-05-22T19:53:39.454Z (about 1 month ago)
Topics: cloud, python, qiskit, qiskit-serverless, quantum-computing
Language: Python
Homepage: https://qiskit.github.io/qiskit-serverless/
Size: 41.8 MB
Stars: 51
Watchers: 11
Forks: 26
Open Issues: 36
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md

Lists

awesome-qiskit - Quantum Serverless - The quantum serverless package aims to allow developers to easily offload computations to cloud resources, without being experts in packaging code for remote execution environments. (Extensions)

README

[![Stability](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/Qiskit/qiskit-serverless/releases)
[![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)
[![Python](https://img.shields.io/badge/Python-3.9%20%7C%203.10-informational)](https://www.python.org/)
[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%201.0.0-6133BD)](https://github.com/Qiskit/qiskit)

# Qiskit Serverless

Qiskit Serverless is a user-friendly tool that enables you to easily run complex quantum computing tasks.
With this software, you can execute Qiskit programs as long running jobs and distribute them across multiple CPUs, GPUs, and QPUs.
This means you can take on more complex quantum-classical programs and run them with ease.
You don't have to worry about configuration or scaling up computational resources, as Qiskit Serverless takes care of everything for you.

![diagram](./docs/images/qs_diagram.png)

### Table of Contents

1. [Quickstart](#quickstart)
1. Modules
1. [Client](./client)
1. [Gateway](./gateway)
1. [Charts](./charts)
1. [How to Give Feedback](#how-to-give-feedback)
1. [Contribution Guidelines](#contribution-guidelines)
1. [Deprecation Policy](#deprecation-policy)
1. [References and Acknowledgements](#references-and-acknowledgements)
1. [License](#license)

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

### Quickstart
This Quickstart section guides users to easily deploy QiskitServerless infrastructure and run a simple example.
For user convenience, this section assumes that users will deploy the infrastructure in a local environment using Docker and test examples within the deployed Jupyter notebook.

1. Prepare local QiskitServerless infrastructure
1. Install Docker
If Docker is not installed on your system, follow the directions on the [Docker website](https://docs.docker.com/engine/install/) to install Docker on your system.
1. Install qiskit-serverless on your local system (we recommend using a [virtual environment](https://docs.python.org/3/library/venv.html)).
```shell
pip install qiskit-serverless
```
Optional: install [Jupyter Lab](https://jupyter.org/)
```shell
pip install jupyterlab
```
1. Clone the Qiskit Serverless repository
```shell
git clone https://github.com/Qiskit/qiskit-serverless.git
```
1. Run QiskitServerless infrastructure
Execute Docker Compose using the following commands.
```shell
cd qiskit-serverless/
sudo docker compose up
```

The output should resemble the following.
```
~/qiskit-serverless$ sudo docker compose --profile jupyter up
[+] Running 5/0
✔ Network public-qiskit-serverless_safe-tier Created 0.0s
✔ Container ray-head Created 0.0s
✔ Container public-qiskit-serverless-postgres-1 Created 0.0s
✔ Container gateway Created 0.0s
✔ Container scheduler Created 0.0s
Attaching to gateway, public-qiskit-serverless-postgres-1, qs-jupyter, ray-head, scheduler
```

1. Launch JupyterLab environment.
```shell
cd docs/getting_started/ # the directory with sample notebooks
jupyter lab
```
This will open the Jupyter Lab environment in your web browser.
1. Write your first example Qiskit Pattern.
In the JupyterLab, create a new file, `pattern.py`, in the `work` directory. You can include any arbitrary Python code in your program, or you can use the
[example Python file in this tutorial](https://github.com/Qiskit/qiskit-serverless/blob/main/docs/getting_started/basic/01_running_program.ipynb).

1. Run the program
In the JupyterLab, create a new notebook in the same directory as your program, and execute [the tutorial code](https://github.com/Qiskit/qiskit-serverless/blob/main/docs/getting_started/basic/01_running_program.ipynb).

You can check the job status and get the result.

```
job.status()
# 'DONE'

job.logs()
# 2023-09-21 03:48:40,286\tINFO worker.py:1329 -- Using address 172.18.0.4:6379 set in the environment variable RAY_ADDRESS\n2023-09-21 03:48:40,286\tINFO worker.py:1458 -- Connecting to existing Ray cluster at address: 172.18.0.4:6379...\n2023-09-21 03:48:40,295\tINFO worker.py:1633 -- Connected to Ray cluster. View the dashboard at \x1b[1m\x1b[32m172.18.0.4:8265 \x1b[39m\x1b[22m\n
```
```
job.status()
# '{"quasi_dists": [{"1": 0.5071335183298108, "5": 0.4334908044837378, "7": 0.0593756771864515}, {"1": 0.9161860602334094, "5": 0.0838139397665906}, {"2": 0.4999999999999999, "3": 0.4999999999999999}]}'
```

That's all!

For more detailed examples and explanations refer to the [Guide](https://qiskit.github.io/qiskit-serverless/index.html):

1. [Getting Started](https://qiskit.github.io/qiskit-serverless/getting_started/index.html#)
1. [Example Qiskit Patterns](https://qiskit.github.io/qiskit-serverless/examples/index.html)
1. [Infrastructure](https://qiskit.github.io/qiskit-serverless/deployment/index.html)
1. [Migrating from Qiskit Runtime programs](https://qiskit.github.io/qiskit-serverless/migration/index.html)

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

### How to Give Feedback

We encourage your feedback! You can share your thoughts with us by:
- Opening an [issue](https://github.com/Qiskit/qiskit-serverless/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).

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

### Deprecation Policy

This project is meant to evolve rapidly and, as such, do not follow [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md). We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in release notes.

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

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

[2] Client for IBM Qiskit Runtime \
https://github.com/Qiskit/qiskit-ibm-runtime

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

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