Instrucțiuni de instalare

Această pagină explică cum se instalează API-ul Python. Un API C nu este încă disponibil pentru acest pachet.

Cerințe preliminare

Mai întâi, creează un mediu minimal în care este instalat doar Python. Folosește medii virtuale Python.

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

Activează noul tău mediu.

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

Există două moduri principale de a instala acest pachet: din PyPI sau din sursă. Metoda preferată este instalarea din PyPI:

Instalare din PyPI

pip install qiskit-bosons

Instalare din sursă

Dacă intenționezi să dezvolți în depozit, ar trebui să instalezi din sursă.

Mai întâi, Qiskit trebuie instalat în același mediu Python în care instalezi qiskit-bosons. Cel mai simplu mod de a face asta este din PyPI, dar poți instala Qiskit din sursă dacă vrei.

$ pip install qiskit

Apoi, clonează depozitul qiskit-bosons.

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

Acum, instalează toolchain-ul Rust, actualizează pip și intră în depozit. Consultă documentația Rust pentru instrucțiuni despre instalarea toolchain-ului.

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

Instalează restul dependențelor build. Dacă intenționezi să dezvolți în depozit, instalează dependențele dev.

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

Pasul următor este să instalezi qiskit-bosons în mediul virtual.

pip install .

Sugestie

Poți efectua și o instalare editabilă, compilând în continuare crate-ul Rust de bază în modul release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Sugestie

Unele funcționalități depind de dependențe opționale. Pentru a le instala pe toate, folosește extra-ul all:

pip install ".[all]"

Consultă secțiunea [project.optional-dependencies] din pyproject.toml pentru a vedea ce grupuri de dependențe sunt disponibile.

Opțional, poți verifica dacă instalarea a reușit. Cel mai simplu test este să încerci să imporți una dintre clasele oferite de pachetul qiskit-bosons, ca în exemplul următor:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Dacă aceasta se finalizează cu succes, instalarea ta a funcționat.

Sugestie

Poți rula și întreaga suită de teste Python:

pip install --group test
make testpython

Pentru a rula suplimentar testele care exersează dependențele opționale, instalează extra-urile și folosește ținta testoptional:

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