Skip to content
Terra provides the foundations for Qiskit. It allows the user to write quantum circuits easily, and takes care of the constraints of real hardware.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Move CONTRIBUTING.rst to top level (#2359) Jun 7, 2019
docs Removing international language (#2302) May 5, 2019
examples Add tests that run example python scripts (#2559) Jun 17, 2019
qiskit Brought pulse command naming in line with circuit Registers (#2593). (#… Jun 17, 2019
test Reduce randomize testing timeouts in CI (#2648) Jun 18, 2019
tools Add randomized testing stage to travis (#2620) Jun 17, 2019
.gitignore gitignore cpp files created in cython folders under the passes folder ( Mar 6, 2019
.pylintrc Remove VCR (#2448) Jun 2, 2019
.stestr.conf Switch to stestr for test runner (#737) Nov 6, 2018
.travis.yml Reduce randomize testing timeouts in CI (#2648) Jun 18, 2019
CHANGELOG.md Update CHANGELOG (#2643) Jun 17, 2019
CODE_OF_CONDUCT.md Move CONTRIBUTING.rst to top level (#2359) Jun 7, 2019
CONTRIBUTING.md Update CONTRBUTING table and CLA (#2649) Jun 18, 2019
LICENSE.txt Consistent license across all the project (#550) Jun 8, 2018
MANIFEST.in Add cython files to manifest to enable sdist compilation (#2436) May 16, 2019
Make.bat Remove pip install from Make.bat (#2513) Jun 2, 2019
Makefile Add randomized testing stage to travis (#2620) Jun 17, 2019
README.md Add coverage badge to README (#2628) Jun 13, 2019
appveyor.yml Upload wheels to pypi.org instead of test.pypi.org (#2561) Jun 4, 2019
constraints.txt Update pylint to 2.3 (#2522) May 28, 2019
pyproject.toml Add pyproject.toml to declare cython build requirement (#2278) May 14, 2019
requirements-dev.txt Reduce randomize testing timeouts in CI (#2648) Jun 18, 2019
requirements.txt Make pylatexenc and pillow optional (#2451) May 21, 2019
setup.py Make pylatexenc and pillow optional (#2451) May 21, 2019
tox.ini Remove VCR (#2448) Jun 2, 2019

README.md

Qiskit Terra

LicenseBuild StatusCoverage Status

Qiskit is an open-source framework for working with Noisy Intermediate-Scale Quantum (NISQ) computers at the level of pulses, circuits, and algorithms.

Qiskit is made up of elements that work together to enable quantum computing. This element is Terra and is the foundation on which the rest of Qiskit is built.

Installation

We encourage installing Qiskit via the pip tool (a python package manager), which installs all Qiskit elements, including Terra.

pip install qiskit

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

To install from source, follow the instructions in the documentation.

Creating Your First Quantum Program in Qiskit Terra

Now that Qiskit is installed, it's time to begin working with Terra.

We are ready to try out a quantum circuit example, which is simulated locally using the Qiskit BasicAer element. This is a simple example that makes an entangled state.

$ python
>>> from qiskit import *
>>> qc = QuantumCircuit(2, 2)
>>> qc.h(0)
>>> qc.cx(0, 1)
>>> qc.measure([0,1], [0,1])
>>> backend_sim = BasicAer.get_backend('qasm_simulator')
>>> result = execute(qc, backend_sim).result()
>>> print(result.get_counts(qc))

In this case, the output will be:

{'00': 513, '11': 511}

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

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 Qiskit for using the credentials in your IBM Q account:

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 > API Token and the URL for the account.

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

    >>> from qiskit import IBMQ
    >>> IBMQ.save_account('MY_API_TOKEN', 'MY_URL')

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()

Those who do not want to save their credentials to disk should use instead:

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

and the token will only be active for the session. For examples using Terra with real devices we have provided a set of examples in examples/python and we suggest starting with using_qiskit_terra_level_0.py and working up in the levels.

Contribution Guidelines

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

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

Next Steps

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

Authors and Citation

Qiskit Terra 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

You can’t perform that action at this time.