Go to file
Matthew Treinish fe5f712c92 Clean up unused code in setup.py (#1670)
Since #1644 we've removed all the C++ code from the terra repository.
That commit updated the setup.py and build process to not assume we're
compiling code to build the simulators. However we missed a lot of
parameters imports and other code in the setup.py which are not needed
or don't apply anymore now that terra is just python code. This commit
cleans that all up so we minimize what we include in the setup.py.
2019-01-12 17:09:04 -05:00
.github Remove legacy C++ simulator code (#1644) 2019-01-08 17:22:18 -05:00
doc Cleaning up doc (#1585) (#1592) 2018-12-23 20:22:42 -05:00
examples New commutation passes (#1500) 2018-12-19 00:13:31 -05:00
qiskit Trivial layout as staticmethod (#1579) 2019-01-11 20:14:18 -05:00
test Trivial layout as staticmethod (#1579) 2019-01-11 20:14:18 -05:00
tools Renaming QISKit to Qiskit (#1382) 2018-12-01 21:44:46 -05:00
.gitignore Renaming qiskit.backends to qiskit.providers (#1531) 2018-12-17 18:11:40 -05:00
.pylintrc Move QiskitTestCase to qiskit.test (#1616) 2018-12-28 09:09:14 -05:00
.stestr.conf Switch to stestr for test runner (#737) 2018-11-06 17:43:03 +00:00
.travis.yml Switch to travis addon for homebrew on osx jobs (#1657) 2019-01-09 18:00:29 -05:00
CHANGELOG.rst Remove `transpile_dag()`'s `format` kwarg (#1664) 2019-01-11 16:46:58 -05:00
LICENSE.txt Consistent license across all the project (#550) 2018-06-08 15:00:58 +02:00
MANIFEST.in Remove legacy C++ simulator code (#1644) 2019-01-08 17:22:18 -05:00
Make.bat Remove legacy C++ simulator code (#1644) 2019-01-08 17:22:18 -05:00
Makefile Remove legacy C++ simulator code (#1644) 2019-01-08 17:22:18 -05:00
README.md Fixed typos and made consistent with the other elements (#1622) 2018-12-29 11:01:03 -05:00
appveyor.yml Remove legacy simulators (#1615) 2018-12-28 17:32:27 -05:00
pypi.sh Update QISKit to Qiskit (#634) 2018-07-11 13:14:15 +02:00
requirements-dev.txt Update pylint to recent version, solve cyclic dependencies (#1600) 2018-12-26 10:46:30 -05:00
requirements.txt bump marshmallow version requirement to 2.17.0 (#1652) 2019-01-07 23:54:21 -05:00
setup.py Clean up unused code in setup.py (#1670) 2019-01-12 17:09:04 -05:00
tox.ini Switch to stestr for test runner (#737) 2018-11-06 17:43:03 +00:00

README.md

Qiskit Terra

LicenseBuild 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 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 contribution guidelines.

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 Qiskt Aer element. This is a simple example that makes an entangled state.

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

In this case, the output will be:

{'counts': {'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 > 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()

Those who do not want to save there 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 to 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 Stack Overflow.

Next Steps

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

Authors

Qiskit Terra is the work of many people who contribute to the project at different levels.

License

Apache License 2.0