Pular para o conteúdo principal

doQumentation

doQumentation adiciona um frontend de código aberto, rico em recursos e amigável aos tutoriais completos, cursos e biblioteca de documentação de código aberto da IBM Quantum.

Conteúdo de código aberto da IBM Quantum

A IBM fornece uma grande quantidade de material de aprendizado sobre computação quântica — todo em código aberto sob CC BY-SA 4.0:

  • Learning — Cursos estruturados desde os fundamentos quânticos até tópicos avançados
  • Tutorials — Mais de 40 tutoriais sobre transpilação, mitigação de erros e muito mais
  • Documentation — Guias e referência de API para Qiskit
  • Source repo — Todo o conteúdo no GitHub

Sua Quantum Platform está sempre atualizada e bem projetada — o melhor lugar para leitura, aprendizado e referência.

O que este projeto adiciona

A documentação do Qiskit da IBM é de código aberto (CC BY-SA 4.0), mas seu aplicativo web não é. doQumentation adiciona um frontend de código aberto com execução de código ao vivo, injeção automática de credenciais e modo simulador.

Pode ser implantado em qualquer lugar — de GitHub Pages a Docker a RasQberry. Veja todos os recursos.

Começando

Novo em computação quântica? Comece com o curso. Já familiarizado com Qiskit? Pule direto para um tutorial ou guia.

Sem conta IBM Quantum? Habilite o Modo Simulador nas Configurações para executar todo o código sem se cadastrar.

Execução de código

Clique em Run em qualquer bloco de código. O primeiro clique inicia um kernel Jupyter gratuito via Binder or IBM Code Engine (1–2 min). Depois disso, as execuções são instantâneas.

  • Modo Simulador (não precisa de conta) — Habilite o Modo Simulador para executar todos os notebooks com AerSimulator ou FakeBackends com modelo de ruído. Nenhuma configuração necessária.

  • Hardware IBM Quantum — Insira seu token de API e CRN nas Configurações uma vez — as credenciais são auto-injetadas em cada execução. Crie uma conta gratuita se você não tiver uma.

Backends de execução disponíveis

Todo tutorial tem blocos de código executáveis. Clique em Run para executá-los usando um dos três backends:

  1. Binder (padrão no GitHub Pages) — Kernel Jupyter remoto gratuito via mybinder.org
  2. Jupyter local (Docker / RasQberry) — Conecta ao servidor Jupyter local com Qiskit pré-instalado
  3. Servidor customizado — Aponte para qualquer endpoint Jupyter nas Configurações

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

Opções de implantação

doQumentation está disponível como:

Execute localmente com Podman / Docker

Instale Podman Desktop ou Docker Desktop (Mac / Windows / Linux), então execute:

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

Abra http://localhost:8080 — a execução de código funciona localmente, sem tempo de espera do Binder.

Para uma versão leve sem execução local de código (~60 MB):

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

Usando Docker em vez disso? Apenas substitua podman por docker — os comandos são idênticos. As imagens são multi-arquitetura (linux/amd64 + linux/arm64), então Macs Apple Silicon funcionam nativamente.