Installationsanleitung

Diese Seite erklärt, wie du die Python-API installierst. Eine C-API ist für dieses Paket noch nicht verfügbar.

Voraussetzungen

Erstelle zunächst eine minimale Umgebung, in der nur Python installiert ist. Verwende dafür virtuelle Python-Umgebungen.

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

Aktiviere deine neue Umgebung.

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

Es gibt zwei Hauptwege, dieses Paket zu installieren: von PyPI oder aus dem Quellcode. Die bevorzugte Methode ist die Installation von PyPI:

Von PyPI installieren

pip install qiskit-bosons

Aus dem Quellcode installieren

Wenn du im Repository entwickeln möchtest, solltest du aus dem Quellcode installieren.

Zuerst muss Qiskit in derselben Python-Umgebung installiert sein, in der du qiskit-bosons installierst. Am einfachsten geht das über PyPI, du kannst Qiskit aber auch aus dem Quellcode installieren, wenn du möchtest.

$ pip install qiskit

Klone als Nächstes das Repository qiskit-bosons.

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

Installiere nun die Rust-Toolchain, aktualisiere pip und wechsle in das Repository. Anleitungen zur Installation der Toolchain findest du in der Rust-Dokumentation.

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

Installiere die übrigen build-Abhängigkeiten. Wenn du im Repository entwickeln möchtest, installiere die dev-Abhängigkeiten.

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

Der nächste Schritt ist, qiskit-bosons in die virtuelle Umgebung zu installieren.

pip install .

Hinweis

Du kannst auch eine editierbare Installation durchführen und dabei das zugrunde liegende Rust-Crate weiterhin im release-Modus kompilieren:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Hinweis

Einige Funktionen beruhen auf optionalen Abhängigkeiten. Um alle zu installieren, verwende das Extra all:

pip install ".[all]"

Im Abschnitt [project.optional-dependencies] von pyproject.toml siehst du, welche Abhängigkeitsgruppen verfügbar sind.

Du kannst optional prüfen, ob die Installation erfolgreich war. Der einfachste Test ist, eine der vom Paket qiskit-bosons bereitgestellten Klassen zu importieren, wie im folgenden Beispiel:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Wenn das erfolgreich durchläuft, hat deine Installation funktioniert.

Hinweis

Du kannst auch die gesamte Python-Testsuite ausführen:

pip install --group test
make testpython

Um zusätzlich die Tests auszuführen, die optionale Abhängigkeiten beanspruchen, installiere die Extras und verwende das Target testoptional:

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