Zum Hauptinhalt springe

doQumentation

doQumentation macht an de komplett Open-Source-Bibliothek von IBM Quantum se Tutorials, Kurse ond Dokumentation a funktionsreiches, benutzerfreundliches Open-Source-Frontend dra.

IBM Quantum se Open-Source-Inhalte

IBM stellt a Haufa Lernmaterial zum Quantencomputing bereit – alles Open Source unter CC BY-SA 4.0:

  • Learning — Strukturierte Kurse von de Quantegrundlaga bis zu de fortgschrittena Thema
  • Tutorials — Über 40 Tutorials zu Transpilation, Fehlerminderung ond mehr
  • Documentation — Aleidunga ond API-Referenz für Qiskit
  • Source repo — Alle Inhalt uff GitHub

Ihre Quantum Platform isch immer aktuell ond guad gstaltet – der bescht Ort zum Lesa, Lerna ond Nachgucka.

Was des Projekt drzua macht

IBM se Qiskit-Dokumentation isch Open Source (CC BY-SA 4.0), aber ihre Webawendung isch's net. doQumentation macht a Open-Source-Frontend mit Live-Code-Ausführung, automatischer Credential-Injektion ond Simulator-Modus drzua.

Überall eisetzbar – von GitHub Pages über Docker bis zu RasQberry. Gucket se alle Funktiona a.

Erscht Schritte

Neu beim Quantencomputing? Fanget mit'm Kurs a. Kennet se Qiskit scho? Dann springet se direkt in a Tutorial oder a Aleitung nei.

Koi IBM Quantum-Konto? Aktivieret se dr Simulator-Modus in de Eistellunga, damit se alle Code ohne Ameldung ausführa könnet.

Code-Ausführung

Klicket se bei jedem Codeblock uff Run. Dr erscht Klick startet an kostelosa Jupyter-Kernel über Binder or IBM Code Engine (1–2 Min.). Danach goht's sofort.

  • Simulator-Modus (koi Konto braucht) — Aktivieret se dr Simulator-Modus, damit se alle Notebooks mit AerSimulator oder FakeBackends mit Rauschmodell ausführa könnet. Null Eirichtungsaufwand braucht.

  • IBM Quantum Hardware — Gebet se eure API-Token ond CRN oimol in de Eistellunga ei — d'Zugangsdaten werdet bei jeder Ausführung automatisch eigfügt. Erstellt a kosteloses Konto, falls se no kois habet.

Verfügbare Ausführungs-Backends

Jedes Tutorial hot ausführbare Codeblöcke. Klicket se uff Run, damit se se mit oim vo drei Backends ausführa könnet:

  1. Binder (Standard uff GitHub Pages) — Kostelosa Remote-Jupyter-Kernel über mybinder.org
  2. Lokales Jupyter (Docker / RasQberry) — Verbindet se mit'm lokala Jupyter-Server mit vorinstalliertem Qiskit
  3. Benutzerdefinierter Server — Verweist se in de Eistellunga uff an beliebiga Jupyter-Endpunkt

When multiple backends are available, choose which one to use from Settings.

Bereitstellungsoptiona

doQumentation isch verfügbar als:

Lokal ausführa mit Podman / Docker

Installieret se Podman Desktop oder Docker Desktop (Mac / Windows / Linux), dann führet se aus:

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

Machet se http://localhost:8080 uff — Code-Ausführung funktioniert lokal, koine Binder-Wartezeit.

Für a 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

Benützet se Docker? Ersetzet se oifach podman durch docker — d'Befehle send identisch. D'Images send Multi-Arch (linux/amd64 + linux/arm64), sodass Apple Silicon Macs nativ funktioniere.