doQumentation
Learn quantum computing with IBM's Qiskit tutorials and courses, and run the code right here in your browser. No install, no account needed to start.
Getting started
New to quantum computing? Start with the course. Already familiar with Qiskit? Jump into a tutorial or guide.
No IBM Quantum account needed. Code runs on a built-in simulator by default. Add your API key in Settings only if you want real quantum hardware.
Code execution
Click Run on any code block. The first click starts a Jupyter kernel via Binder or IBM Code Engine. After that, runs are instant.
-
Simulator Mode (no account needed) — On by default: code runs on AerSimulator or on noise-model FakeBackends you can pick in Settings. Pages that need IBM Quantum hardware or IBM's cloud services say so when you run them.
-
IBM Quantum Hardware — Enter your API token and CRN in Settings once — credentials are auto-injected on every run. Create a free account if you don't have one.
Available execution backends
Every tutorial has executable code blocks. Click Run to execute them using one of four backends:
- Binder (default on GitHub Pages) — Free remote Jupyter kernel via mybinder.org
- IBM Code Engine — Serverless Jupyter on your IBM Cloud account. Cold start in seconds instead of minutes. Set up
- Local Jupyter (Docker / RasQberry) — Connects to the local Jupyter server with Qiskit pre-installed
- Custom server — Point to any Jupyter endpoint in Settings
When multiple backends are available, choose which one to use from Settings.
Deployment options
doQumentation is available as:
- GitHub Pages — Static site with Binder or IBM Code Engine for remote code execution
- Docker — Full stack locally, offline capable
- RasQberry — Self-hosted on Raspberry Pi with local Jupyter kernel
Run locally with Podman / Docker
Install Podman Desktop or Docker Desktop (Mac / Windows / Linux), then run:
# Full stack: site + Jupyter + Qiskit (~3 GB)
podman run -p 8080:80 -p 8888:8888 ghcr.io/janlahmann/doqumentation:jupyter
Open http://localhost:8080 — code execution works locally, no Binder wait time.
Using Docker instead? Just replace podman with docker — the commands are identical. Images are multi-arch (linux/amd64 + linux/arm64), so Apple Silicon Macs work natively.
About & credits
IBM Quantum's open-source content
IBM provides a wealth of quantum computing learning material — all open source under CC BY-SA 4.0:
- Learning — Structured courses from quantum basics to advanced topics
- Tutorials — 40+ tutorials on transpilation, error mitigation, and more
- Documentation — Guides and API reference for Qiskit
- Source repo — All content on GitHub
Their Quantum Platform is always up-to-date and well-designed — the best place for reading, learning, and reference.
What this project adds
IBM's Qiskit documentation is open source (CC BY-SA 4.0), but their web application is not. doQumentation adds an open-source frontend with live code execution, automatic credential injection, and simulator mode.
Deployable anywhere — from GitHub Pages to Docker to RasQberry. See all features.
When you're ready for more
doQumentation helps you take your first steps with Qiskit — read, run code, and explore — without installing anything. As you progress, head to IBM's official platform:
- Run on real hardware — create a free IBM Cloud account and an Open Plan instance to execute circuits on real quantum computers.
- Latest content — IBM's Qiskit learning platform has the newest courses, tutorials, and additions (some may not yet be in doQumentation).
- Develop locally — install Qiskit on your own laptop for serious development work.
Built on IBM Quantum's open-source documentation. Thanks to the IBM Quantum team for making this content freely available under CC BY-SA 4.0.