Instalacja API Pythona

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ł. Preferowaną metodą jest instalacja z PyPI:

Instalacja z PyPI

pip install qiskit-fermions

Instalacja ze źródeł

Jeśli planujesz pracować nad kodem w repozytorium, zainstaluj pakiet ze źródeł.

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

$ pip install qiskit

Następnie sklonuj repozytorium qiskit-fermions.

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

Teraz zainstaluj zestaw narzędzi Rust, zaktualizuj pip i wejdź do repozytorium. Instrukcje instalacji zestawu narzędzi znajdziesz w dokumentacji Rust.

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

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

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

Kolejnym krokiem jest zainstalowanie qiskit-fermions w środowisku wirtualnym.

pip install .

Wskazówka

Możesz też wykonać instalację w trybie edytowalnym, nadal kompilując podstawowy crate Rust w trybie release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Wskazówka

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

pip install ".[all]"

Zajrzyj do sekcji [project.optional-dependencies] w 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-fermions, jak w poniższym przykładzie:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Jeśli to się powiedzie, 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 korzystające z opcjonalnych zależności, zainstaluj dodatki i użyj celu testoptional:

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