Przejdź do głównej treści

doQumentation

doQumentation dodaje bogaty w funkcje, przyjazny użytkownikowi, otwartoźródłowy frontend do kompletnej biblioteki otwartych tutoriali, kursów i dokumentacji IBM Quantum.

Otwarte zasoby IBM Quantum

IBM udostępnia bogaty zbiór materiałów edukacyjnych z zakresu obliczeń kwantowych — wszystkie na otwartej licencji CC BY-SA 4.0:

  • Learning — Ustrukturyzowane kursy od podstaw kwantowych po zaawansowane tematy
  • Tutorials — Ponad 40 tutoriali o transpilacji, mitygacji błędów i nie tylko
  • Documentation — Przewodniki i dokumentacja API dla Qiskit
  • Source repo — Wszystkie treści na GitHubie

Ich Quantum Platform jest zawsze aktualna i dobrze zaprojektowana — najlepsze miejsce do czytania, nauki i szukania informacji.

Co ten projekt dodaje

Dokumentacja Qiskit IBM jest otwarta (CC BY-SA 4.0), ale ich aplikacja webowa już nie. doQumentation dodaje otwartoźródłowy frontend z uruchamianiem kodu na żywo, automatycznym wstrzykiwaniem poświadczeń i trybem symulatora.

Możliwy do wdrożenia wszędzie — od GitHub Pages przez Docker po RasQberry. Zobacz wszystkie funkcje.

Pierwsze kroki

Nowy w obliczeniach kwantowych? Zacznij od kursu. Znasz już Qiskit? Przejdź od razu do tutoriala lub przewodnika.

Nie masz konta IBM Quantum? Włącz Tryb Symulatora w Ustawieniach, żeby uruchamiać cały kod bez rejestracji.

Uruchamianie kodu

Kliknij Run na dowolnym bloku kodu. Pierwsze kliknięcie uruchamia kernel Jupyter przez Binder lub IBM Code Engine. Potem uruchomienia są natychmiastowe.

  • Tryb Symulatora (bez konta) — Włącz Tryb Symulatora, żeby uruchamiać wszystkie notebooki z AerSimulator lub FakeBackends z modelem szumu. Zero konfiguracji.

  • Sprzęt IBM Quantum — Wpisz swój token API i CRN w Ustawieniach raz — poświadczenia są automatycznie wstrzykiwane przy każdym uruchomieniu. Utwórz darmowe konto, jeśli jeszcze go nie masz.

Dostępne backendy uruchomieniowe

Każdy tutorial ma wykonywalne bloki kodu. Kliknij Run, żeby uruchomić je na jednym z czterech backendów:

  1. Binder (domyślny na GitHub Pages) — Darmowy zdalny kernel Jupyter przez mybinder.org
  2. IBM Code Engine — Bezserwerowy Jupyter na twoim koncie IBM Cloud. Cold start w sekundy zamiast minut. Skonfiguruj
  3. Lokalny Jupyter (Docker / RasQberry) — Łączy się z lokalnym serwerem Jupyter z preinstalowanym Qiskit
  4. Własny serwer — Wskaż dowolny endpoint Jupyter w Ustawieniach

Gdy dostępnych jest kilka backendów, wybierz który używać w Ustawieniach.

Opcje wdrożenia

doQumentation jest dostępny jako:

Uruchom lokalnie z Podman / Docker

Zainstaluj Podman Desktop lub Docker Desktop (Mac / Windows / Linux), a następnie uruchom:

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

Otwórz http://localhost:8080 — uruchamianie kodu działa lokalnie, bez czekania na Binder.

Dla lekkiej wersji bez lokalnego uruchamiania kodu (~60 MB):

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

Używasz Dockera? Po prostu zamień podman na docker — komendy są identyczne. Obrazy są wieloarchitekturowe (linux/amd64 + linux/arm64), więc Apple Silicon Mac działa natywnie.