Pokyny k instalaci

Tato stránka vysvětluje, jak nainstalovat Python API. C API pro tento balíček zatím není k dispozici.

Předpoklady

Nejprve vytvoř minimální prostředí, ve kterém je nainstalován pouze Python. Použij virtuální prostředí Pythonu.

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

Aktivuj své nové prostředí.

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

Existují dva hlavní způsoby instalace tohoto balíčku: z PyPI nebo ze zdrojového kódu. Preferovanou metodou je instalace z PyPI:

Instalace z PyPI

pip install qiskit-bosons

Instalace ze zdrojového kódu

Pokud plánuješ vyvíjet v repozitáři, měl bys instalovat ze zdrojového kódu.

Nejprve musí být Qiskit nainstalován ve stejném prostředí Pythonu, do kterého instaluješ qiskit-bosons. Nejjednodušší je to z PyPI, ale Qiskit můžeš nainstalovat i ze zdrojového kódu, pokud chceš.

$ pip install qiskit

Dále naklonuj repozitář qiskit-bosons.

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

Nyní nainstaluj toolchain Rustu, aktualizuj pip a přejdi do repozitáře. Pokyny k instalaci toolchainu najdeš v dokumentaci Rustu.

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

Nainstaluj zbývající závislosti build. Pokud plánuješ vyvíjet v repozitáři, nainstaluj také závislosti dev.

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

Dalším krokem je instalace qiskit-bosons do virtuálního prostředí.

pip install .

Tip

Můžeš také provést editovatelnou instalaci a přitom stále kompilovat podkladový crate Rustu v režimu release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Tip

Některé funkce se opírají o volitelné závislosti. Chceš-li nainstalovat všechny, použij extra all:

pip install ".[all]"

V sekci [project.optional-dependencies] souboru pyproject.toml zjistíš, které skupiny závislostí jsou k dispozici.

Volitelně můžeš ověřit, že instalace proběhla úspěšně. Nejjednodušším testem je zkusit importovat jednu z tříd poskytovaných balíčkem qiskit-bosons, jako v následujícím příkladu:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Pokud to proběhne úspěšně, instalace fungovala.

Tip

Můžeš také spustit celou testovací sadu Pythonu:

pip install --group test
make testpython

Chceš-li navíc spustit testy, které využívají volitelné závislosti, nainstaluj extra a použij cíl testoptional:

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