Instalace Python API

Předpoklady

Nejprve vytvoř minimální prostředí, ve kterém je nainstalovaný 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

Tento balíček lze nainstalovat dvěma hlavními způsoby: z PyPI nebo ze zdrojového kódu. Preferovaná metoda je instalace z PyPI:

Instalace z PyPI

pip install qiskit-fermions

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 Python prostředí, do kterého instaluješ qiskit-fermions. Nejjednodušší je instalace z PyPI, ale Qiskit můžeš nainstalovat i ze zdrojového kódu, pokud chceš.

$ pip install qiskit

Dále naklonuj repozitář qiskit-fermions.

git clone git@github.com:Qiskit/qiskit-fermions.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-fermions

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-fermions do virtuálního prostředí.

pip install .

Tip

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

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Tip

Některé funkce závisí na volitelných závislostech. Pro instalaci všech z nich 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-fermions, jako v následujícím příkladu:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Pokud se to dokončí bez chyby, instalace funguje.

Tip

Můžeš také spustit celou sadu Python testů:

pip install --group test
make testpython

Pro spuštění testů, které navíc využívají volitelné závislosti, nainstaluj extra balíčky a použij cíl testoptional:

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