qiskit-ibmq-provider 0.1rc2

Qiskit provider for IBM Q quantum devices and simulators

Qiskit IBMQ Provider

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

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 link. For questions that are more suited for a forum we use the Qiskit tag in the Stack Overflow.

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