⚙️ Paramètres doQumentation
Configure le serveur Jupyter utilisé pour exécuter le code Python dans les tutoriels.
Backend du serveur
Choisis le backend à utiliser pour l'exécution de code :
Mode d'exécution
Choisis ce qui se passe quand tu cliques sur Exécuter sur les pages de tutoriels. Cela s'applique uniquement à l'exécution de code intégrée sur ce site — ouvrir un notebook dans JupyterLab utilise le runtime Qiskit standard.
Compte IBM Quantum
Instructions de configuration et notes de sécurité
save_account() décrite ci-dessous.Entre tes identifiants IBM Quantum une fois ici. Ils seront injectés automatiquement via save_account() au démarrage du noyau, tu n'as donc pas besoin de les saisir dans chaque notebook. Cela s'applique uniquement à l'exécution de code intégrée sur ce site — l'ouverture d'un notebook dans JupyterLab nécessite d'appeler save_account() manuellement.
- S'inscrire sur quantum.cloud.ibm.com/registration — aucune carte de crédit requise pour les 30 premiers jours
- Se connecter sur Instances
- Instance — Crée une instance Open Plan gratuite sur page d'accueil si tu n'en as pas encore
- Token API — Clique sur ton icône de profil (en haut à droite), puis "API token". Copie la clé.
Pour des étapes détaillées, consulte le guide Configurer l'authentification d'IBM (étape 2).
Alternative : Exécuter save_account() manuellement dans une cellule de notebook
Si tu préfères ne pas stocker les identifiants dans ce navigateur, colle ceci dans une cellule de code et exécute-la. Les identifiants sont enregistrés dans le stockage temporaire du noyau Binder et perdus à la fin de la session.
from qiskit_ibm_runtime import QiskitRuntimeService
QiskitRuntimeService.save_account(
token="YOUR_API_TOKEN",
instance="YOUR_CRN",
overwrite=True
)Préférences d'affichage
Taille de police du code
from qiskit import QuantumCircuitSorties pré-calculées
Chaque page de notebook affiche les sorties pré-calculées (images, tableaux, texte) des exécutions originales d'IBM. Lorsque tu cliques sur Run pour exécuter le code en direct, les sorties originales et tes nouveaux résultats en direct sont affichés. Désactive cette option pour masquer les sorties originales pendant l'exécution en direct et ne garder que tes résultats.
Avertissements Python
Par défaut, les avertissements Python (avis de dépréciation, indices d'exécution) sont supprimés pour une sortie de notebook plus propre. Désactive ceci pour voir tous les avertissements — utile pour le débogage ou l'apprentissage des modifications d'API.
Gérer tes données
Toutes les données restent dans ton navigateur. Sur doqumentation.org, ta progression, tes favoris et tes paramètres sont conservés dans le localStorage et dans de petits cookies qui les partagent entre les sites linguistiques ; ces cookies sont transmis à l'hébergeur web statique à chaque requête de page, jamais à un serveur doQumentation. Tes identifiants IBM Quantum ne sont jamais placés dans un cookie : ils restent dans le localStorage du site linguistique où tu les as saisis. Si tu effaces les données de ton navigateur ou si tu utilises un autre navigateur ou appareil, tu repars de zéro.
Progression d'apprentissage
Les pages visitées affichent un ✓ dans la barre latérale. Les pages de notebook affichent un </> : gris tant qu'elles ne sont pas visitées, bleu une fois visitées, vert dès que tu y as exécuté du code.
Aucune progression suivie pour le moment. Visite des tutoriels et guides pour commencer le suivi.
Favoris
Aucun favori pour l'instant. Utilise le bouton de favori sur n'importe quelle page pour la sauvegarder ici.
Affichage et interface
Sessions et identifiants
Tout réinitialiser
Supprimer toutes les données enregistrées y compris la progression, les favoris, les préférences d'affichage et les identifiants.
Paramètres avancés
IBM Cloud Code Engine
IBM Cloud Code Engine fournit un noyau Jupyter rapide et sans serveur basé sur ton propre compte IBM Cloud. Le démarrage prend des secondes au lieu de minutes. Le niveau gratuit couvre environ 14 heures/mois.
Instructions de configuration
- Crée un compte IBM Cloud sur cloud.ibm.com (niveau gratuit disponible)
- Va dans IBM Cloud Code Engine console et crée un nouveau projet dans ta région préférée
- Crée une nouvelle application avec l'image
ghcr.io/janlahmann/doqumentation-codeengine:latest, port d'écoute 8080
Dimensionnement : 1 vCPU / 2 Go pour utilisateur unique, 8 vCPU / 16 Go pour ateliers (jusqu'à 80 utilisateurs) - Définis les variables d'environnement :
JUPYTER_TOKENsur un token sécurisé (min. 32 caractères) etCORS_ORIGINsur ton domaine (ex.https://doqumentation.org)
Pour les détails de dimensionnement des ateliers, consulte la documentation de configuration de l'atelier.
Packages Binder
Lors de l'exécution sur GitHub Pages, le code s'exécute via MyBinder. L'environnement Binder inclut les packages Qiskit de base pré-installés :
qiskit[visualization], qiskit-aer,
qiskit-ibm-runtime, pylatexenc,
qiskit-ibm-catalog, qiskit-addon-utils, pyscfCertains notebooks nécessitent des packages supplémentaires. Tu peux les installer à la demande en exécutant ceci dans une cellule de code :
!pip install -q <package>Ou installer tous les packages optionnels en une fois :
!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-satAide à la configuration
Configuration RasQberry
RasQberry exécute le conteneur doQumentation (voir Configuration Docker ci-dessous). Ouvre le site depuis l'adresse du Pi, port 8080, et le code s'exécute sur le Pi sans autre configuration.
Guide d'atelier hors ligne : animer un cours depuis un seul Raspberry Pi
Configuration Jupyter locale
Démarre un serveur Jupyter qui n'accepte que ce site, avec un jeton de ton choix, puis saisis son URL et son jeton sous Serveur personnalisé ci-dessus :
jupyter server --ServerApp.token='choose-a-long-token' \
--ServerApp.allow_origin='https://doqumentation.org' \
--ServerApp.disable_check_xsrf=TrueConfiguration Docker
Le conteneur Docker génère un token Jupyter aléatoire au démarrage. L'exécution de code via le site web (port 8080) fonctionne automatiquement — aucun token nécessaire. Le token n'est requis que pour l'accès direct à JupyterLab sur le port 8888.
Pour récupérer le token depuis les logs du conteneur :
podman logs doq | grep "Jupyter token"Pour définir un token fixe :
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:jupyterServeur distant
Pour les serveurs distants, assure-toi que CORS est configuré pour autoriser les connexions depuis ce site. Ajoute ce qui suit à ta jupyter_server_config.py :
c.ServerApp.allow_origin = 'https://doqumentation.org'
c.ServerApp.allow_credentials = True