Перейти до основного вмісту

doQumentation

doQumentation додає багатофункціональний, зручний, відкритий інтерфейс до повної бібліотеки відкритих навчальних матеріалів, курсів та документації IBM Quantum.

Відкритий контент IBM Quantum

IBM надає величезну кількість навчальних матеріалів з квантових обчислень — усе відкрите під ліцензією CC BY-SA 4.0:

Їхня Quantum Platform завжди актуальна та добре розроблена — найкраще місце для читання, навчання та довідкової інформації.

Що додає цей проект

Документація Qiskit від IBM є відкритою (CC BY-SA 4.0), але їхній веб-додаток — ні. doQumentation додає відкритий інтерфейс з можливістю виконання коду в реальному часі, автоматичним впровадженням облікових даних та режимом симулятора.

Може бути розгорнутий будь-де — від GitHub Pages до Docker до RasQberry. Дивіться всі можливості.

Початок роботи

Новачок у квантових обчисленнях? Почніть з курсу. Вже знайомі з Qiskit? Переходьте до посібника або довідника.

Немає облікового запису IBM Quantum? Увімкніть Режим симулятора в Налаштуваннях, щоб виконувати весь код без реєстрації.

Виконання коду

Натисніть Run на будь-якому блоці коду. Перше натискання запускає безкоштовне ядро Jupyter через Binder or IBM Code Engine (1–2 хв). Після цього виконання миттєве.

  • Режим симулятора (не потрібен обліковий запис) — Увімкніть Режим симулятора, щоб виконувати всі ноутбуки з AerSimulator або FakeBackends з моделями шуму. Налаштування не потрібне.

  • Апаратне забезпечення IBM Quantum — Введіть свій API-токен та CRN у Налаштуваннях один раз — облікові дані автоматично впроваджуються при кожному запуску. Створіть безкоштовний обліковий запис, якщо у вас його немає.

Доступні бекенди для виконання

Кожен посібник має виконувані блоки коду. Натисніть Run, щоб виконати їх, використовуючи один із трьох бекендів:

  1. Binder (за замовчуванням на GitHub Pages) — Безкоштовне віддалене ядро Jupyter через mybinder.org
  2. Локальний Jupyter (Docker / RasQberry) — Підключається до локального сервера Jupyter з попередньо встановленим Qiskit
  3. Власний сервер — Вкажіть будь-яку кінцеву точку Jupyter у Налаштуваннях

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

Варіанти розгортання

doQumentation доступний як:

  • GitHub Pages — Статичний сайт з Binder or IBM Code Engine для віддаленого виконання коду
  • Docker — Повний стек локально, здатний працювати офлайн
  • RasQberry — Самостійно розміщений на Raspberry Pi з локальним ядром Jupyter
Запуск локально з Podman / Docker

Встановіть Podman Desktop або Docker Desktop (Mac / Windows / Linux), потім виконайте:

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

Відкрийте http://localhost:8080 — виконання коду працює локально, без очікування Binder.

Для легкої версії без локального виконання коду (~60 МБ):

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

Використовуєте Docker? Просто замініть podman на docker — команди ідентичні. Образи мультиархітектурні (linux/amd64 + linux/arm64), тому Apple Silicon Mac працюють нативно.