Zum Hauptinhalt springen

doQumentation

doQumentation fügt der vollständigen Open-Source-Bibliothek von IBM Quantum-Tutorials, -Kursen und -Dokumentation ein funktionsreiches, benutzerfreundliches Open-Source-Frontend hinzu.

IBM Quantums Open-Source-Inhalte

IBM stellt eine Fülle von Lernmaterialien zum Quantencomputing bereit – alle Open Source unter CC BY-SA 4.0:

  • Learning — Strukturierte Kurse von Quantengrundlagen bis zu fortgeschrittenen Themen
  • Tutorials — Über 40 Tutorials zu Transpilation, Fehlerminderung und mehr
  • Documentation — Anleitungen und API-Referenz für Qiskit
  • Source repo — Alle Inhalte auf GitHub

Die Quantum Platform ist stets aktuell und gut gestaltet – der beste Ort zum Lesen, Lernen und Nachschlagen.

Was dieses Projekt hinzufügt

IBMs Qiskit-Dokumentation ist Open Source (CC BY-SA 4.0), aber ihre Webanwendung ist es nicht. doQumentation fügt ein Open-Source-Frontend mit Live-Code-Ausführung, automatischer Credential-Injektion und Simulator-Modus hinzu.

Überall einsetzbar – von GitHub Pages über Docker bis zu RasQberry. Siehe alle Funktionen.

Wenn du bereit für mehr bist

doQumentation hilft dir, deine ersten Schritte mit Qiskit zu machen — lesen, Code ausführen und erkunden — ohne etwas installieren zu müssen. Wenn du weiterkommen willst, geht es bei IBMs offizieller Plattform weiter:

  • Auf echter Hardware ausführen — erstelle ein kostenloses IBM Cloud-Konto und eine Open-Plan-Instanz, um Schaltkreise auf echten Quantencomputern auszuführen.
  • Neueste Inhalte — IBMs Qiskit-Lernplattform bietet die neuesten Kurse, Tutorials und Ergänzungen (manche sind möglicherweise noch nicht in doQumentation enthalten).
  • Lokal entwickelninstalliere Qiskit auf deinem eigenen Laptop für ernsthafte Entwicklungsarbeit.

Aufbauend auf IBM Quantums Open-Source-Dokumentation. Vielen Dank an das IBM Quantum-Team dafür, dass diese Inhalte unter CC BY-SA 4.0 frei verfügbar sind.

Erste Schritte

Neu im Quantencomputing? Beginne mit dem Kurs. Bereits mit Qiskit vertraut? Spring direkt in ein Tutorial oder eine Anleitung.

Kein IBM Quantum-Konto? Aktiviere den Simulator-Modus in den Einstellungen, um allen Code ohne Anmeldung auszuführen.

Code-Ausführung

Klicke bei jedem Codeblock auf Run. Der erste Klick startet einen Jupyter-Kernel über Binder oder IBM Code Engine. Danach erfolgen Ausführungen sofort.

  • Simulator-Modus (kein Konto erforderlich) — Aktiviere den Simulator-Modus, um alle Notebooks mit AerSimulator oder FakeBackends mit Rauschmodell auszuführen. Null Einrichtungsaufwand erforderlich.

  • IBM Quantum Hardware — Gib deinen API-Token und CRN einmal in den Einstellungen ein — die Zugangsdaten werden bei jeder Ausführung automatisch eingefügt. Erstelle ein kostenloses Konto, falls du noch keines hast.

Verfügbare Ausführungs-Backends

Jedes Tutorial hat ausführbare Codeblöcke. Klicke auf Run, um sie mit einem von vier Backends auszuführen:

  1. Binder (Standard auf GitHub Pages) — Kostenloser Remote-Jupyter-Kernel über mybinder.org
  2. IBM Code Engine — Serverless Jupyter auf deinem IBM Cloud-Konto. Kaltstart in Sekunden statt Minuten. Einrichten
  3. Lokales Jupyter (Docker / RasQberry) — Verbindet sich mit dem lokalen Jupyter-Server mit vorinstalliertem Qiskit
  4. Benutzerdefinierter Server — Verweise in den Einstellungen auf einen beliebigen Jupyter-Endpunkt

Kein IBM-Quantum-Konto? Aktiviere den Simulator-Modus in den Einstellungen, um sämtlichen Code ohne Anmeldung auszuführen.

Wenn mehrere Backends verfügbar sind, wähle in den Einstellungen, welches verwendet werden soll.

Bereitstellungsoptionen

doQumentation ist verfügbar als:

Lokal ausführen mit Podman / Docker

Installiere Podman Desktop oder Docker Desktop (Mac / Windows / Linux), dann führe aus:

# Full stack: site + Jupyter + Qiskit (~3 GB)
podman run -p 8080:80 -p 8888:8888 ghcr.io/janlahmann/doqumentation:jupyter

Öffne http://localhost:8080 — Code-Ausführung funktioniert lokal, keine Binder-Wartezeit.

Für eine leichtgewichtige Version ohne lokale Code-Ausführung (~60 MB):

# Static site only — code execution still works via Binder
podman run -p 8080:80 ghcr.io/janlahmann/doqumentation:latest

Du verwendest Docker? Ersetze einfach podman durch docker — die Befehle sind identisch. Die Images sind Multi-Arch (linux/amd64 + linux/arm64), sodass Apple Silicon Macs nativ funktionieren.