Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

Qiskit IBMQ Provider

LicenseBuild Status

Qiskit is an open-source framework for working with noisy intermediate-scale quantum computers (NISQ) at the level of pulses, circuits, and algorithms.

This module contains a provider that allows accessing the IBM Q quantum devices and simulators.

Installation

We encourage installing Qiskit via the PIP tool (a python package manager), which installs all Qiskit elements and components, including this one.

pip install qiskit

PIP will handle all dependencies automatically for us and you will always install the latest (and well-tested) version.

To install from source, follow the instructions in the contribution guidelines.

Setting up the IBMQ provider

Once the package is installed, you can access the provider from Qiskit.

Configure your IBMQ credentials

Note: since IBMQProvider version 0.2.0, the package supports connecting to the new IBM Q Experience, which includes a number of new features. Please note that support is still experimental, and some functionality might be subject to change or experience technical issues.

  1. Create an IBM Q account if you haven't already done so.

  2. Get an API token from the IBM Q website under My Account > Advanced > API Token.

  3. Take your token from step 2, here called MY_API_TOKEN, and run:

    >>> from qiskit import IBMQ
    >>> IBMQ.save_account('MY_API_TOKEN')
    
  4. If you have access to the IBM Q Network features, you also need to pass the url listed on your IBM Q account page to save_account.

After calling IBMQ.save_account(), your credentials will be stored on disk. Once they are stored, at any point in the future you can load and use them in your program simply via:

>>> from qiskit import IBMQ
>>> IBMQ.load_accounts()

For those who do not want to save there credentials to disk please use

>>> from qiskit import IBMQ
>>> IBMQ.enable_account('MY_API_TOKEN')

Contribution Guidelines

If you'd like to contribute to IBM Q provider, please take a look at our contribution guidelines. This project adheres to Qiskit's code of conduct. By participating, you are expect to uphold to this code.

We use GitHub issues for tracking requests and bugs. Please use our slack for discussion and simple questions. To join our Slack community use the invite link. For questions that are more suited for a forum we use the Qiskit tag in Stack Exchange.

Next Steps

Now you're set up and ready to check out some of the other examples from our Qiskit Tutorial repository.

Authors and Citation

The Qiskit IBM Q provider is the work of many people who contribute to the project at different levels. If you use Qiskit, please cite as per the included BibTeX file.

License

Apache License 2.0.

Metadata

Release files for qiskit-ibmq-provider 0.2.3rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qiskit-ibmq-provider 0.2.3rc1
File Size Uploaded
qiskit-ibmq-provider-0.2.3rc1.tar.gz 41.3 kB Details

Release files / qiskit-ibmq-provider-0.2.3rc1.tar.gz

Download URL qiskit-ibmq-provider-0.2.3rc1.tar.gz
Size 41.3 kB
Tags Source
SHA-256 checksum
How to use checksums
936577474ebea705d2a581072047404abb07c1e28c9f0231271aab10017d1054
BLAKE2b-256 checksum
How to use checksums
c35a6eaef8d48d4f2873ecf22415ec6686c3d712706c772a25f880443febd5c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.5.3

Release history Release notifications | RSS feed

This release

0.2.3rc1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page