Die Python-API installieren

Voraussetzungen

Erstelle zuerst eine minimale Umgebung, in der nur Python installiert ist. Verwende 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-fermions

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-fermions installierst. Am einfachsten geht das von PyPI, aber du kannst Qiskit auch aus dem Quellcode installieren, wenn du möchtest.

$ pip install qiskit

Klone als Nächstes das Repository qiskit-fermions.

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

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

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

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 die Installation von qiskit-fermions in die virtuelle Umgebung.

pip install .

Hinweis

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

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Hinweis

Einige Funktionen hängen von optionalen Abhängigkeiten ab. Um alle zu installieren, verwende das Extra all:

pip install ".[all]"

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

Optional kannst du überprüfen, ob die Installation erfolgreich war. Der einfachste Test besteht darin, eine der vom Paket qiskit-fermions bereitgestellten Klassen zu importieren, wie im folgenden Beispiel:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Wenn dies erfolgreich abgeschlossen wird, 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 nutzen, installiere die Extras und verwende das Target testoptional:

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