Skip to main content

Qiskit Plug-in for OpenQAOA

Project description

OpenQAOA

build test Documentation Status PyPI version arXiv License Contributor Covenant Downloads Binder Discord Website

OpenQAOA-Qiskit Plugin

OpenQAOA is a multi-backend python library for quantum optimization using QAOA on Quantum computers and Quantum computer simulators. This package is part of a set of OpenQAOA plug-ins that lets users run QAOA computations on IBMQ devices, and devices that support qiskit circuits. Check out OpenQAOA website https://openqaoa.entropicalabs.com/

OpenQAOA is currently in OpenBeta.

Please consider joining our discord if you want to be part of our community and participate in the OpenQAOA's development.

Installation instructions

Install via PyPI

You can install the latest version of openqaoa-qiskit directly from PyPi. We recommend creating a virtual environment with python>=3.8 first and then simply pip install openqaoa-qiskit with the following command.

NOTE: Installing openqaoa-qiskit installs openqaoa-core by default

pip install openqaoa-qiskit

Installation instructions for Developers

OpenQAOA-Qiskit does not yet support developer install as a standalone package. If you wish to work in developer mode, please install the entire library. Instructions are available here

Should you face any issue during the installation, please drop us an email at openqaoa@entropicalabs.com or open an issue!

Getting started

The documentation for OpenQAOA-Qiskit can be found here.

We also provide a set of tutorials to get you started. Among the many, perhaps you can get started with the following ones:

  • Link OpenQAOA Qiskit notebooks
  • Using QPU
  • Using Qiskit Simulators

Available devives

OpenQAOA-Qiskit services devices both locally and on the cloud. The QPU accessible through the cloud depends on the specified credentials. Moreover, users can also access qiskit local simulators.

Device location Device Name
local ['qiskit.shot_simulator', 'qiskit.statevector_simulator']
ibmq Please check the IBMQ backends available to your account

Running the tests

TODO

Contributing and feedback

If you find any bugs or errors, have feature requests, or code you would like to contribute, feel free to open an issue or send us a pull request on GitHub.

We are always interested to hear about projects built with EntropicaQAOA. If you have an application you'd like to tell us about, drop us an email at openqaoa@entropicalabs.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openqaoa-qiskit-0.2.5.tar.gz (38.5 kB view hashes)

Uploaded Source

Built Distribution

openqaoa_qiskit-0.2.5-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page