Instrukcja instalacji

Ta strona wyjaśnia, jak zainstalować API Pythona. API w C nie jest jeszcze dostępne dla tego pakietu.

Wymagania wstępne

Najpierw utwórz minimalne środowisko, w którym zainstalowany jest tylko Python. Użyj wirtualnych środowisk Pythona.

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

Aktywuj nowe środowisko.

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

Istnieją dwa główne sposoby instalacji tego pakietu: z PyPI lub ze źródeł. Zalecana metoda to instalacja z PyPI:

Instalacja z PyPI

pip install qiskit-bosons

Instalacja ze źródeł

Jeśli planujesz rozwijać kod w repozytorium, zainstaluj pakiet ze źródeł.

Najpierw Qiskit musi być zainstalowany w tym samym środowisku Pythona, w którym instalujesz qiskit-bosons. Najprościej zrobić to z PyPI, ale jeśli chcesz, możesz zainstalować Qiskit ze źródeł.

$ pip install qiskit

Następnie sklonuj repozytorium qiskit-bosons.

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

Teraz zainstaluj toolchain Rusta, zaktualizuj pip i wejdź do repozytorium. Instrukcje instalacji toolchaina znajdziesz w dokumentacji Rusta.

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

Zainstaluj pozostałe zależności build. Jeśli planujesz rozwijać kod w repozytorium, zainstaluj zależności dev.

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

Następnym krokiem jest zainstalowanie qiskit-bosons w środowisku wirtualnym.

pip install .

Wskazówka

Możesz też wykonać instalację edytowalną, nadal kompilując bazowy crate Rusta w trybie release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Wskazówka

Niektóre funkcje wymagają opcjonalnych zależności. Aby zainstalować je wszystkie, użyj dodatku all:

pip install ".[all]"

Zajrzyj do sekcji [project.optional-dependencies] pliku pyproject.toml, aby zobaczyć, jakie grupy zależności są dostępne.

Opcjonalnie możesz sprawdzić, czy instalacja się powiodła. Najprostszy test polega na próbie zaimportowania jednej z klas udostępnianych przez pakiet qiskit-bosons, jak w poniższym przykładzie:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Jeśli to zakończy się powodzeniem, instalacja działa.

Wskazówka

Możesz też uruchomić cały zestaw testów Pythona:

pip install --group test
make testpython

Aby dodatkowo uruchomić testy, które korzystają z opcjonalnych zależności, zainstaluj dodatki i użyj celu testoptional:

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