/qiskit-textbook

A university quantum algorithms/computation course supplement based on Qiskit

Primary LanguageJupyter NotebookApache License 2.0Apache-2.0

stable: Build Status main: Build Status

Qiskit Textbook Source Code

⚠️ This repo is for pages at https://qiskit.org/textbook/**. This is an old version of the textbook and will soon be deprecated. If your issue is about the latest version of the textbook (i.e. any page on https://learn.qiskit.org/**), please make your issue / PR at https://github.com/Qiskit/platypus.

This is the repository for the interactive open-source Learn Quantum Computation using Qiskit textbook. The textbook is intended for use as a university quantum algorithms course supplement as well as a guide for self-learners who are interested in learning quantum programming.

The Jupyter notebooks corresponding to each section of the textbook can be found in the content folder. The code in these notebooks will constantly be updated to the latest version of Qiskit.

The notebooks are compiled into html and exported to the website.

Installing the qiskit_textbook Package

The Qiskit Textbook provides some tools and widgets specific to the Textbook. This is not part of Qiskit and is available through the qiskit_textbook package. The quickest way to install this with pip and Git is through the command:

pip install git+https://github.com/qiskit-community/qiskit-textbook.git#subdirectory=qiskit-textbook-src

Or, if you prefer using pipenv:

pipenv install "git+https://github.com/qiskit-community/qiskit-textbook.git#subdirectory=qiskit-textbook-src&egg=qiskit_textbook"

Alternatively, you can download the folder qiskit-textbook-src and run:

pip install ./qiskit-textbook-src

from the directory that contains this folder.

Contribution Guidelines

If you'd like to contribute to Qiskit Textbook, please take a look at our contributors guide. Note that unfortunately we're not accepting new content contributions at this time.

License

The materials and associated source code of this open-source textbook are licensed under Apache License 2.0.

Contact

For any issues, please contact Frank Harkins in the Qiskit Slack workspace. You can also email Frank Harkins (francis.harkins@ibm.com).