Guide officiel 2026

Installation et premiers pas

SPARC s'installe rapidement avec Docker ou un environnement Python local, selon le niveau de contrôle souhaité.

Choisissez votre chemin

La méthode Docker reste recommandée pour un démarrage rapide et un environnement reproductible. L'installation Python local est idéale pour le développement, les tests et la personnalisation avancée.

Docker (recommandé)

Démarre l'interface web, Redis, les workers et les commandes utiles avec un environnement reproductible.

Python local

Parfait pour le développement, les tests unitaires et l'itération sur les composants scientifiques.

Recherche avancée

Ajoutez les extras TCAD, optimisation, matériaux ou LLM selon le besoin réel de l'étude.

Chemin minimal recommandé. Après le clone, préparez .env, lancez soit docker compose up, soit python -m web.app pour la version locale, puis vérifiez /api/health avant toute campagne scientifique.

Prérequis

  • Python 3.10+ (3.11 ou 3.12 recommandé)
  • pip (gestionnaire de packages Python)
  • Docker Engine 24+ et Docker Compose 2.20+ si vous choisissez la voie conteneurisée
  • 4 Go de RAM minimum, 8 Go recommandés pour BoTorch et les simulations longues

Option A — Package PyPI (Recommandée & Ultra-rapide)

SPARC est distribué comme package Python autonome contenant directement le moteur Sesame (NIST Vendored). Zéro compilateur C/C++ nécessaire :

Terminal
pip install sparc-pv

Commandes globales disponibles après installation

  • Mode TUI Interactif : sparc ui (ou sparc interactif)
  • Mode Web Graphique : sparc web (ouvre http://localhost:5000)
  • Mode Batch / Script : sparc run configs/silicon_homo.json
  • Mode Optimiseur : sparc optimize configs/opt_config.json --engine botorch

Option B — Conteneur Docker

Cette méthode fournit un environnement conteneurisé isolant l'application et ses dépendances.

Terminal
git clone https://github.com/Quantum-ARISE-Acad/SPARC.git
cd sparc
cp .env.example .env
# Définissez au minimum SESAME_WEB_SECRET dans .env
docker compose up -d web
À savoir : Le conteneur web s'exécute sur le port 5000. Vous pouvez aussi lancer le CLI interactif dans Docker via docker compose run --rm cli sparc ui.
Terminal
git clone https://github.com/Quantum-ARISE-Acad/SPARC.git
cd sparc
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\Activate.ps1
python -m pip install --upgrade pip setuptools wheel
python -m pip install -e .
cp .env.example .env
# puis ajuster .env selon votre besoin
Extras recommandés : ajoutez .[tcad,botorch,llm-local,materials] uniquement si ces fonctions sont nécessaires.

Commandes utiles

  • python -m web.app pour lancer l'interface web
  • python -m cli_interactif pour le mode interactif
  • python -m cli --help pour consulter les commandes du CLI
  • python main.py configs/silicon_homo.json pour une exécution batch simple

Vérification rapide

Après le démarrage, vérifiez que l'application web répond bien et que les points d'entrée essentiels sont accessibles.

Terminal
curl http://localhost:5000/api/health
# ou ouvrir http://localhost:5000 dans votre navigateur

Dépannage courant

Symptôme Cause probable Correctif
ModuleNotFoundError: sesame Le moteur TCAD n'a pas été installé python -m pip install -e .[tcad] ou docker compose up
Port 5000 déjà utilisé Un autre service écoute sur le port docker compose down ou changer la variable SPARC_WEB_PORT
L'API health ne répond pas L'application web n'a pas fini son démarrage Vérifiez les logs avec docker compose logs -f web ou relancez l'app
Le modèle Ollama n'est pas disponible Le service LLM n'est pas lancé docker compose --profile llm up puis docker compose exec ollama ollama pull llama3.2
Bonnes pratiques : gardez votre fichier .env à jour, conservez les sorties sous outputs/ et utilisez des configurations JSON propres pour les études réplicables.