⚙️ Configurações do doQumentation
Configure o servidor Jupyter usado para executar código Python nos tutoriais.
Backend do Servidor
Escolha qual backend usar para execução de código:
Modo de Execução
Escolha o que acontece quando você clica em Executar nas páginas de tutoriais. Isso se aplica somente à execução de código incorporada neste site — abrir um notebook no JupyterLab usa o runtime padrão do Qiskit.
Conta IBM Quantum
Instruções de configuração e notas de segurança
save_account() descrito abaixo.Insira suas credenciais do IBM Quantum uma vez aqui. Elas serão injetadas automaticamente via save_account() quando o kernel iniciar, então não é necessário inseri-las em cada notebook. Isso se aplica somente à execução de código incorporada neste site — abrir um notebook no JupyterLab requer chamar save_account() manualmente.
- Cadastrar em quantum.cloud.ibm.com/registration — sem cartão de crédito necessário nos primeiros 30 dias
- Entrar em Instâncias
- Instância — Crie uma instância gratuita do Open Plan em página inicial se ainda não tiver uma
- Token de API — Clique no ícone do seu perfil (canto superior direito), depois em "token de API". Copie a chave.
Para etapas detalhadas, consulte o guia Configurar autenticação da IBM (etapa 2).
Alternativa: Execute save_account() manualmente em uma célula do notebook
Se preferir não armazenar credenciais neste navegador, cole isso em qualquer célula de código e execute. As credenciais são salvas no armazenamento temporário do kernel do Binder e perdidas quando a sessão termina.
from qiskit_ibm_runtime import QiskitRuntimeService
QiskitRuntimeService.save_account(
token="YOUR_API_TOKEN",
instance="YOUR_CRN",
overwrite=True
)Preferências de Exibição
Tamanho da Fonte do Código
from qiskit import QuantumCircuitSaídas Pré-computadas
Cada página de notebook mostra saídas pré-computadas (imagens, tabelas, texto) das execuções originais da IBM. Ao clicar em Run para executar o código ao vivo, tanto as saídas originais quanto seus novos resultados ao vivo são exibidos. Desative esta opção para ocultar as saídas originais durante a execução ao vivo, mantendo visíveis apenas os seus resultados.
Avisos do Python
Por padrão, os avisos do Python (avisos de descontinuação, dicas de execução) são suprimidos para uma saída de notebook mais limpa. Desative esta opção para ver todos os avisos — útil para depuração ou para conhecer mudanças na API.
Gerenciar Seus Dados
Todos os dados permanecem no seu navegador. Em doqumentation.org, seu progresso, favoritos e configurações ficam no localStorage e em pequenos cookies que os compartilham entre os sites de idioma; esses cookies vão para o servidor web estático a cada requisição de página, nunca para um servidor do doQumentation. Suas credenciais do IBM Quantum nunca são colocadas em um cookie: elas ficam no localStorage do site de idioma em que você as inseriu. Ao limpar os dados do navegador ou usar outro navegador/dispositivo, você começa do zero.
Progresso de Aprendizado
As páginas visitadas exibem ✓ na barra lateral. As páginas de notebook exibem </>: cinza até serem visitadas, azul depois de visitadas e verde depois que você executa código nelas.
Nenhum progresso rastreado ainda. Visite tutoriais e guias para começar a rastrear.
Favoritos
Nenhum favorito ainda. Use o botão de favorito em qualquer página para salvá-la aqui.
Exibição e Interface
Sessões e Credenciais
Redefinir Tudo
Remover todos os dados salvos incluindo progresso, favoritos, preferências de exibição e credenciais.
Configurações Avançadas
IBM Cloud Code Engine
O IBM Cloud Code Engine fornece um kernel Jupyter rápido e serverless na sua própria conta IBM Cloud. A inicialização leva segundos em vez de minutos. O nível gratuito cobre ~14 horas/mês.
Instruções de Configuração
- Crie uma conta IBM Cloud em cloud.ibm.com (nível gratuito disponível)
- Acesse o IBM Cloud Code Engine console e crie um novo projeto na sua região preferida
- Crie um novo aplicativo com imagem
ghcr.io/janlahmann/doqumentation-codeengine:latest, porta de escuta 8080
Dimensionamento: 1 vCPU / 2 GB para usuário único, 8 vCPU / 16 GB para workshops (até 80 usuários) - Defina as variáveis de ambiente:
JUPYTER_TOKENpara um token seguro (mínimo 32 caracteres) eCORS_ORIGINpara o seu domínio (ex.:https://doqumentation.org)
Para detalhes de dimensionamento de workshop, consulte a documentação de configuração do workshop.
Pacotes do Binder
Ao executar no GitHub Pages, o código é executado via MyBinder. O ambiente do Binder inclui os pacotes principais do Qiskit pré-instalados:
qiskit[visualization], qiskit-aer,
qiskit-ibm-runtime, pylatexenc,
qiskit-ibm-catalog, qiskit-addon-utils, pyscfAlguns notebooks exigem pacotes adicionais. Você pode instalá-los sob demanda executando isto em uma célula de código:
!pip install -q <package>Ou instale todos os pacotes opcionais de uma só vez:
!pip install -q scipy scikit-learn qiskit-ibm-transpiler \
qiskit-experiments plotly sympy qiskit-serverless \
qiskit-addon-sqd qiskit-addon-mpf \
qiskit-addon-aqc-tensor[aer,quimb-jax] \
qiskit-addon-obp qiskit-addon-cutting ffsim \
gem-suite python-satAjuda de Configuração
Configuração do RasQberry
O RasQberry executa o contêiner do doQumentation (veja Configuração do Docker abaixo). Abra o site a partir do endereço do Pi, porta 8080, e o código será executado no Pi sem nenhuma configuração adicional.
Guia de workshop offline: conduza uma aula a partir de um único Raspberry Pi
Configuração Local do Jupyter
Inicie um servidor Jupyter que aceite apenas este site, com um token à sua escolha, e depois informe a URL e o token dele em Servidor Personalizado acima:
jupyter server --ServerApp.token='choose-a-long-token' \
--ServerApp.allow_origin='https://doqumentation.org' \
--ServerApp.disable_check_xsrf=TrueConfiguração do Docker
O contêiner Docker gera um token Jupyter aleatório na inicialização. A execução de código pelo site (porta 8080) funciona automaticamente — nenhum token é necessário. O token só é necessário para o acesso direto ao JupyterLab na porta 8888.
Para obter o token nos logs do contêiner:
podman logs doq | grep "Jupyter token"Para definir um token fixo:
podman run -d --name doq --restart unless-stopped \
-e JUPYTER_TOKEN=choose-a-token \
-p 8080:80 -p 127.0.0.1:8888:8888 \
ghcr.io/janlahmann/doqumentation:jupyterServidor Remoto
Para servidores remotos, certifique-se de que o CORS está configurado para permitir conexões deste site. Adicione o seguinte ao seu jupyter_server_config.py:
c.ServerApp.allow_origin = 'https://doqumentation.org'
c.ServerApp.allow_credentials = True