/qiskit-sdk-py

Quantum Information Science Kit for writing quantum computing experiments, programs, and applications.

Primary LanguagePythonApache License 2.0Apache-2.0

Quantum Information Software Kit (QISKit)

PyPI Build Status

The Quantum Information Software Kit (QISKit for short) is a software development kit (SDK) for working with OpenQASM and the IBM Q Experience (QX).

Use QISKit to create quantum computing programs, compile them, and execute them on one of several backends (online Real quantum processors, online simulators, and local simulators). For the online backends, QISKit uses our python API client to connect to the IBM Q Experience.

We use GitHub issues for tracking requests and bugs. Please see the IBM Q Experience community for questions and discussion.

If you'd like to contribute to QISKit, please take a look at our contribution guidelines.

Links to Sections:

Installation

Dependencies

At least Python 3.5 or later is needed for using QISKit. In addition, Jupyter Notebook is recommended for interacting with the tutorials. For this reason we recommend installing the Anaconda 3 python distribution, as it comes with all of these dependencies pre-installed.

In addition, a basic understanding of quantum information is very helpful when interacting with QISKit. If you're new to quantum, start with our User Guides!

Installation

We encourage to install QISKit via the PIP tool (a python package manager):

pip install qiskit

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

PIP package comes with prebuilt binaries for these platforms:

  • Linux x86_64
  • Darwin
  • Win64

If your platform is not in the list, PIP will try to build from the sources at installation time. It will require to have CMake 3.5 or higher pre-installed and at least one of the build environments supported by CMake.

If during the installation PIP doesn't succeed to build, don't worry, you will have QISKit installed at the end but you probably couldn't take advantage of some of the high-performance components. Anyway, we always provide a python, not-so-fast alternative as a fallback.

Setup your environment

We recommend using python virtual environments to improve your experience. Refer to our Environment Setup documentation for more information.

Creating your first Quantum Program

Now that the SDK is installed, it's time to begin working with QISKit.

We are ready to try out a quantum circuit example, which runs via the local simulator.

This is a simple example that makes an entangled state.

# Import the QISKit SDK
from qiskit import QuantumCircuit, ClassicalRegister, QuantumRegister
from qiskit import available_backends, execute

# Create a Quantum Register with 2 qubits.
q = QuantumRegister(2)
# Create a Classical Register with 2 bits.
c = ClassicalRegister(2)
# Create a Quantum Circuit
qc = QuantumCircuit(q, c)

# Add a H gate on qubit 0, putting this qubit in superposition.
qc.h(q[0])
# Add a CX (CNOT) gate on control qubit 0 and target qubit 1, putting
# the qubits in a Bell state.
qc.cx(q[0], q[1])
# Add a Measure gate to see the state.
qc.measure(q, c)

# See a list of available local simulators
print("Local backends: ", available_backends({'local': True}))

# Compile and run the Quantum circuit on a simulator backend
job_sim = execute(qc, "local_qasm_simulator")
sim_result = job_sim.result()

# Show the results
print("simulation: ", sim_result)
print(sim_result.get_counts(qc))

In this case, the output will be:

COMPLETED
{'counts': {'00': 512, '11': 512}}

This script is available here, where we also show how to run the same program on a real quantum computer.

Executing your code on a real Quantum chip

You can also use QISKit to execute your code on a real quantum chip. In order to do so, you need to configure the SDK for using the credentials in your IBM Q Experience account:

Configure your API token and QX credentials

  1. Create an IBM Q Experience > Account if you haven't already done so.
  2. Get an API token from the IBM Q Experience website under My Account > Advanced > API Token. This API token allows you to execute your programs with the IBM Q Experience backends. See: Example.
  3. We are going to create a new file called Qconfig.py and insert the API token into it. This file must have these contents:
APItoken = 'MY_API_TOKEN'

config = {
    'url': 'https://quantumexperience.ng.bluemix.net/api',
    # The following should only be needed for IBM Q Network users.
    'hub': 'MY_HUB',
    'group': 'MY_GROUP',
    'project': 'MY_PROJECT'
}

  1. Substitute MY_API_TOKEN with your real API Token extracted in step 2.

  2. If you have access to the IBM Q Network features, you also need to setup the values for your hub, group, and project. You can do so by filling the config variable with the values you can find on your IBM Q account page.

Once the Qconfig.py file is set up, you have to move it under the same directory/folder where your program/tutorial resides, so it can be imported and be used to authenticate with the set_api() function. For example:

from qiskit import QuantumProgram
import Qconfig

# Creating Programs create your first QuantumProgram object instance.
qp = QuantumProgram()
qp.set_api(Qconfig.APItoken, Qconfig.config["url"],
           hub=Qconfig.config["hub"],
           group=Qconfig.config["group"],
           project=Qconfig.config["project"])

For more details on this and more information see our QISKit documentation.

Next Steps

Now you're set up and ready to check out some of the other examples from our Tutorial repository. Start with the index tutorial and then go to the ‘Getting Started’ example. If you already have Jupyter Notebooks installed, you can copy and modify the notebooks to create your own experiments.

To install the tutorials as part of the QISKit SDK, see the following installation details. Complete SDK documentation can be found in the doc directory and in the official QISKit site.

More Information

For more information on how to use QISKit, tutorial examples, and other helpful links, take a look at these resources:

QISKit was originally developed by researchers and developers on the IBM-Q Team at IBM Research, with the aim of offering a high level development kit to work with quantum computers.

Visit the IBM Q Experience community for questions and discussions on QISKit and quantum computing more broadly. If you'd like to contribute to QISKit, please take a look at our contribution guidelines.

Multilanguage guide

Authors (alphabetical)

QISKit was originally authored by Luciano Bello, Jim Challenger, Andrew Cross, Ismael Faro, Jay Gambetta, Juan Gomez, Ali Javadi-Abhari, Paco Martin, Diego Moreda, Jesus Perez, Erick Winston and Chris Wood.

And continues to grow with the help and work of many people who contribute to the project at different levels.

License

This project uses the Apache License Version 2.0 software license.