Pular para o conteúdo principal

⚙️ doQumentation Settings

Configure o servidor Jupyter usado para executar código Python nos tutoriais.

Current Environment: Não detectado

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.

As alterações entram em vigor na próxima sessão do kernel. Se o código estiver em execução, clique em Voltar e depois em Executar para aplicar.

Conta IBM Quantum

Instruções de configuração e notas de segurança
Nota de segurança: As credenciais são armazenadas no localStorage do seu navegador em texto simples. Não são criptografadas e podem ser lidas por extensões do navegador ou qualquer pessoa com acesso a este dispositivo. Use a configuração de expiração abaixo para limitar a exposição e exclua as credenciais quando terminar. Para computadores compartilhados ou públicos, prefira o método manual 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.

  1. Cadastrar em quantum.cloud.ibm.com/registration — sem cartão de crédito necessário nos primeiros 30 dias
  2. Entrar em Instâncias
  3. Instância — Crie uma instância gratuita do Open Plan em página inicial se ainda não tiver uma
  4. 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
)

Display Preferences

Code Font Size

14px
from qiskit import QuantumCircuit

Pre-computed Outputs

Each notebook page shows pre-computed outputs (images, tables, text) from IBM's original runs. When you click Run to execute code live, both the original outputs and your new live results are shown side by side. Enable this toggle to hide the original outputs during live execution, keeping only your results visible.

Python Warnings

By default, Python warnings (deprecation notices, runtime hints) are suppressed for cleaner notebook output. Disable this to see all warnings — useful for debugging or learning about API changes.

Gerenciar Seus Dados

Todos os dados são armazenados localmente no seu navegador (localStorage). Nada é enviado para nossos servidores. Limpar os dados do navegador ou usar um navegador/dispositivo diferente começa do zero.

Progresso de Aprendizado

Seu progresso de leitura e execução é rastreado localmente no seu navegador. Páginas visitadas exibem ✓ na barra lateral; notebooks executados exibem ▶.

Nenhum progresso rastreado ainda. Visite tutoriais e guias para começar a rastrear.

Bookmarks

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
  1. Crie uma conta IBM Cloud em cloud.ibm.com (nível gratuito disponível)
  2. Acesse o IBM Cloud Code Engine console e crie um novo projeto na sua região preferida
  3. 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)
  4. Defina as variáveis de ambiente: JUPYTER_TOKEN para um token seguro (mínimo 32 caracteres) e CORS_ORIGIN para o seu domínio (ex.: https://doqumentation.org)

Para detalhes de dimensionamento de workshop, consulte a documentação de configuração do workshop.

Binder Packages

When running on GitHub Pages, code executes via MyBinder. The Binder environment includes core Qiskit packages pre-installed:

qiskit[visualization], qiskit-aer,
qiskit-ibm-runtime, pylatexenc,
qiskit-ibm-catalog, qiskit-addon-utils, pyscf

Some notebooks require additional packages. You can install them on demand by running this in a code cell:

!pip install -q <package>

Or install all optional packages at once:

!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-sat

Setup Help

RasQberry Setup

If you're running on a RasQberry Pi, the Jupyter server should be automatically detected. If not, ensure the jupyter-tutorials service is running:

sudo systemctl status jupyter-tutorials

Local Jupyter Setup

Start a Jupyter server with CORS enabled:

jupyter server --ServerApp.token='rasqberry' \
  --ServerApp.allow_origin='*' \
  --ServerApp.disable_check_xsrf=True

Docker Setup

The Docker container generates a random Jupyter token at startup. Code execution through the website (port 8080) works automatically — no token needed. The token is only required for direct JupyterLab access on port 8888.

To retrieve the token from container logs:

docker compose --profile jupyter logs | grep "Jupyter token"

To set a fixed token:

JUPYTER_TOKEN=mytoken docker compose --profile jupyter up

Servidor 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 = '*'
c.ServerApp.allow_credentials = True