IBM Q Experience user guides
The repository contains the user guides from the IBM Q Experience
If quantum physics sounds challenging to you, you are not alone. All of our intuitions are based on day-to-day experiences and are defined by classical physics — so most of us find the concepts in quantum physics counterintuitive at first. In order to comprehend the quantum world, you must let go of your beliefs about our physical world, and develop an intuition for a completely different (and often surprising) set of laws.
The guide is divided in two.
Beginner's Guide: You can find a simple aproach about Quantum Computing and how use the IBM Q Experice tools, like Quantum Composer.
User's Guide: This section contain the more full coverage from Quantum Computing and in particular several examples and algorithm.
Jay M. Gambetta, Antonio Córcoles, Andrew Cross, Lev Bishop, and Abigail Cross
Installation and setup
1. Get the tools
- Install Python 3.
- Jupyter client is needed to run the tutorials, not to use as a library.
- Mac OS X users will find Xcode useful: https://developer.apple.com/xcode/
- Optionally download Git: https://git-scm.com/download/.
2. Get the code
Clone the qiskit-qx-user-guides repository and navigate to its folder on your local machine:
- If you have Git installed, run the following commands:
git clone https://github.com/QISKit/ibmqx-user-guides.git cd ibmqx-user-guides
- If you don't have Git installed, click the "Clone or download" button at the URL shown in the git clone command, unzip the file if needed, then navigate to that folder in a terminal window.
3. Setup the environment
To use as a library install the dependencies:
# Depending on the system and setup to append "sudo -H" before could be needed. pip3 install -r requires.txt
4. Generate documentation
To generate HTML documenatation run
You can find the generated documenatation in _build/html
Do you want to help?
If you'd like to contribute please take a look to our contribution guidelines.
The documentation for the project is in the
rst directory. The
documentation for the python SDK is auto-generated from python
docstrings using Sphinx for generating the
documentation. All the documents are created using RST format. You can
find more info about it in:
You can generate the documentation in format HTML using.
You can export the documenatation in other formats like "epub", "text" or others.
You can find more info about this formats using:
The examples are include from the "test" folder, you can test all of them, features often imply changes in the existent tests or new ones are needed. Once they're updated/added run this be sure they keep passing:
Other QISKit projects
- ibmqx backend information Information about the different IBM Q Experience backends.
- OpenQasm Examples and tools for the OpenQASM intermediate representation.
- Python API API Client to use IBM Q Experience in Python.
- Python SDK Software development kit for working with quantum programs in Python.
- Tutorial Jupyter notebooks for using QISKit.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.