qiskit-textbook

(★ 1,030)

[ARCHIVED] A university quantum algorithms/computation course supplement based on Qiskit

File Explorer

Download Latest Version (.zip)

- - content-problem---.yaml
  - enhancement-request---.yaml
  - new-content-suggestion-----.yaml
  - software-bug---.yaml
  - something-else---.yaml
- - deploy.workflow.yml
- CODEOWNERS
- issue_template.md
- pull_request_template.md
- - ipython_kernel_config.py
- settings.conf
- - messages.yml
  - toc.yml
- demostoc.yml
- messages.yml
- toc.yml
- - binder.html
  - download.html
  - jupyterhub.html
  - nbinteract.html
  - thebelab.html
- - interact-update.html
  - nbinteract.html
  - print.html
  - thebelab-cell-button.html
  - thebelab-page-config.html
  - thebelab.html
- banner.html
- buttons.html
- coursemap_img.html
- css_entry.scss
- fb_tags.html
- footer.html
- google_analytics.html
- head.html
- hotjar.html
- mathjax.html
- metadata.json
- page-nav.html
- qiskit_navbar.html
- segment.html
- sidebar.html
- topbar.html
- default.html
- - _components.book__layout.scss
  - _components.book__topbar.scss
  - _components.images.scss
  - _components.interact-button.scss
  - _components.iqx.scss
  - _components.page__banner.scss
  - _components.page__footer.scss
  - _components.page__nav.scss
  - _components.page__onthispage.scss
  - _components.qiskit__navbar.scss
  - _components.search.scss
  - _components.thebelab.scss
- - _base.scss
  - hamburgers.scss
- - _objects.thebelab-in-cell-button.scss
- - main.scss
- main.scss
- - styles.scss
- - custom.css
  - custom.css.backup
  - custom.js
- - index.html
  - search_form.html
- - chevron--down.svg
  - copy-button.svg
  - download-solid.svg
  - edit-button.svg
  - hamburger.svg
  - hamburger_left.svg
  - launch.svg
  - leftarrow_purple.svg
  - list-solid.svg
  - logo_binder.svg
  - logo_jupyterhub.svg
  - logo_qiskit.svg
  - logo_qiskit_black.svg
  - logo_qiskit_pink.svg
  - logo_qiskit_purple.svg
  - logo_qiskit_purple_new.svg
  - rightarrow.svg
  - rightarrow_purple.svg
  - search-solid-purple.svg
  - search-solid.svg
- - scripts.js
- - bernstein-vazirani.ipynb
  - defining-quantum-circuits.ipynb
  - deutsch-jozsa.ipynb
  - grover.ipynb
  - hidden-shift-problem.ipynb
  - index.md
  - quantum-counting.ipynb
  - quantum-fourier-transform.ipynb
  - quantum-key-distribution.ipynb
  - quantum-phase-estimation.ipynb
  - quantum-walk-search-algorithm.ipynb
  - shor.ipynb
  - simon.ipynb
  - superdense-coding.ipynb
  - teleportation.ipynb
- - index.md
  - linear_algebra.ipynb
  - qiskit.ipynb
- - .gitkeep
  - advanced-quantum-algs-index.md
  - algs_for_apps_index.md
  - algs_index.md
  - apps_index.md
  - facial-expression-recognition.ipynb
  - hhl_tutorial.ipynb
  - image-processing-frqi-neqr.ipynb
  - imp_index.md
  - qaoa.ipynb
  - quantum-edge-detection.ipynb
  - satisfiability-grover.ipynb
  - vqe-molecules.ipynb
- - .gitignore
  - 2_qubit_circuit.png
  - 3_qubit_circuit.png
  - 4_qubit_circuit.png
  - 5_qubit_circuit.png
  - 6_qubit_circuit.png
  - 7_qubit_circuit.png
  - 8_qubit_circuit.png
  - 9_qubit_circuit.png
  - chsh.ipynb
  - coin-game.ipynb
  - first-quantum-game.ipynb
  - index.md
  - piday-code.ipynb
  - variational-quantum-regression.ipynb
- - ex1.ipynb
  - ex2.ipynb
  - ex3.ipynb
  - hello-qiskit.ipynb
  - hello-qiskit.ipynb.orig
  - index.md
- - fun-matrices.ipynb
  - introduction.ipynb
  - more-circuit-identities.ipynb
  - multiple-qubits-entangled-states.ipynb
  - oracles.ipynb
  - phase-kickback.ipynb
  - proving-universality.ipynb
  - quantum-gates.ipynb
  - standard-gate-set.ipynb
- - index.md
  - Lab01_QuantumCircuits.ipynb
  - Lab02_QuantumMeasurement.ipynb
  - Lab03_AccuracyQPE.ipynb
  - Lab04_IterativePhaseEstimation.ipynb
  - Lab05_Scalable_Shor_Algorithm.ipynb
  - Lab06_Grover_search_with_an_unknown_number_of_solutions.ipynb
  - Lab07_QuantumSimulationSearchAlgorithm.ipynb
  - Lab08_QEC.ipynb
- - 1qubitcirc.png
  - hybridnetwork.png
  - machine-learning-qiskit-pytorch.ipynb
  - neuralnetworkQC.png
  - quantumgradient.png
- - tsp.ipynb
  - vqls.ipynb
- - python-and-jupyter-notebooks.ipynb
  - setting-the-environment.ipynb
- - ac-Stark-shift.ipynb
  - accessing_higher_energy_states.ipynb
  - calibrating-qubits-pulse.ipynb
  - cliffords2.pickle
  - cQED-JC-SW.ipynb
  - density-matrix.ipynb
  - error-correction-repetition-code.ipynb
  - hamiltonian-tomography.ipynb
  - index-circuits.md
  - index-pulses.md
  - Jaynes-Cummings-model.ipynb
  - measurement-error-mitigation.ipynb
  - measuring-quantum-volume.ipynb
  - Open-quantum-systems.ipynb
  - randomized-benchmarking.ipynb
  - transmon-physics.ipynb
  - transpiling-quantum-circuits.ipynb
- - atoms-computation.ipynb
  - case-for-quantum.ipynb
  - introduction.ipynb
  - old-states-many-qubits.ipynb
  - old-unique-properties-qubits.ipynb
  - old-writing-down-qubit-states.ipynb
  - representing-qubit-states.ipynb
  - single-qubit-gates.ipynb
- - 0.ipynb
- - curriculum.svg
  - melbourne.png
  - preface-hw-example.png
  - preface_algs.png
  - preface_code.png
  - preface_hardware.png
  - preface_illustration.svg
  - preface_illustration_2.svg
- about.ipynb
- LICENSE.md
- preface.ipynb
- qiskit-textbook.bib
- upcoming.ipynb
- using-the-textbook.ipynb
- what-is-quantum.ipynb
- widgets-index.ipynb
- config.i18n.yml
- LOCALIZATION_CONTRIBUTORS
- Translation-Guidelines.pdf
- - __init__.py
- setup.py
- clean.py
- create_redirections.py
- postprocess_html.py
- replace_code_cells.py
- run_notebooks.py
- run_notebooks_soft.py
.gitignore
_config.yml
build.sh
CODE_OF_CONDUCT.md
CONTRIBUTING.md
deploy.sh
environment.yml
Gemfile
Gemfile.lock
Guardfile
LICENSE.txt
Makefile
rclone.conf.enc
README.md
requirements-dev.txt
requirements.txt
runtime.txt

# Installation Guide

1. Get the code

git clone https://github.com/qiskit-community/qiskit-textbook

Downloads the entire project code from GitHub to your computer.

cd qiskit-textbook

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

✅ If it runs without errors and prints output in the terminal, it worked.

3. Ruby

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Ruby Ruby is required to use the bundle command.

bundle install

Installs the Ruby libraries listed in the Gemfile.

✅ If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

4. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

qiskit-textbook

File Explorer

# Installation Guide

2. Python

3. Ruby

4. Make

Today's picks

Was this content helpful?

Recent Feedback

qiskit-textbook

File Explorer

# Installation Guide

2. Python

3. Ruby

4. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README