Instructions d'installation

Cette page explique comment installer l'API Python. Une API C n'est pas encore disponible pour ce package.

Prérequis

Commence par créer un environnement minimal contenant uniquement Python. Utilise des environnements virtuels Python.

python3 -m venv /path/to/virtual/environment

Active ton nouvel environnement.

source /path/to/virtual/environment/bin/activate

Il existe deux façons principales d'installer ce package : depuis PyPI ou depuis les sources. La méthode recommandée est d'installer depuis PyPI :

Installer depuis PyPI

pip install qiskit-bosons

Installer depuis les sources

Si tu prévois de développer dans le dépôt, tu devrais installer depuis les sources.

D'abord, Qiskit doit être installé dans le même environnement Python que celui où tu installes qiskit-bosons. Le plus simple est de l'installer depuis PyPI, mais tu peux installer Qiskit depuis les sources si tu le souhaites.

$ pip install qiskit

Ensuite, clone le dépôt qiskit-bosons.

git clone git@github.com:Qiskit/qiskit-bosons.git

Maintenant, installe la chaîne d'outils Rust, mets à jour pip et place-toi dans le dépôt. Consulte la documentation de Rust pour les instructions d'installation de la chaîne d'outils.

### <INSTALL RUST HERE> ###
pip install --upgrade pip
cd qiskit-bosons

Installe les dépendances build restantes. Si tu prévois de développer dans le dépôt, installe les dépendances dev.

pip install --group build
pip install --group dev  # optional

L'étape suivante consiste à installer qiskit-bosons dans l'environnement virtuel.

pip install .

Astuce

Tu peux aussi faire une installation éditable tout en compilant la crate Rust sous-jacente en mode release :

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Astuce

Certaines fonctionnalités reposent sur des dépendances optionnelles. Pour les installer toutes, utilise l'extra all :

pip install ".[all]"

Consulte la section [project.optional-dependencies] de pyproject.toml pour voir quels groupes de dépendances sont disponibles.

Tu peux éventuellement vérifier que l'installation a réussi. Le test le plus simple consiste à essayer d'importer l'une des classes fournies par le package qiskit-bosons, comme dans l'exemple suivant :

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Si cela se termine sans erreur, ton installation a fonctionné.

Astuce

Tu peux aussi exécuter toute la suite de tests Python :

pip install --group test
make testpython

Pour exécuter en plus les tests qui exercent les dépendances optionnelles, installe les extras et utilise la cible testoptional :

pip install -e ".[all]"
make testoptional