Інструкції зі встановлення

На цій сторінці пояснено, як встановити Python API. C API для цього пакета поки що недоступний.

Передумови

Спершу створи мінімальне середовище, у якому встановлено лише Python. Використовуй віртуальні середовища Python.

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

Активуй своє нове середовище.

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

Є два основні способи встановити цей пакет: з PyPI або з вихідного коду. Бажаний спосіб — встановлення з PyPI:

Встановлення з PyPI

pip install qiskit-bosons

Встановлення з вихідного коду

Якщо ти плануєш розробляти в репозиторії, встанови з вихідного коду.

Спершу Qiskit має бути встановлено в те саме середовище Python, у яке ти встановлюєш qiskit-bosons. Найпростіше зробити це з PyPI, але за бажання можна встановити Qiskit з вихідного коду.

$ pip install qiskit

Далі клонуй репозиторій qiskit-bosons.

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

Тепер встанови інструментарій Rust, оновни pip і перейди до репозиторію. Інструкції зі встановлення інструментарію див. у документації Rust.

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

Встанови решту залежностей build. Якщо ти плануєш розробляти в репозиторії, встанови залежності dev.

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

Наступний крок — встановити qiskit-bosons у віртуальне середовище.

pip install .

Підказка

Ти також можеш виконати редаговане встановлення, водночас компілюючи базовий crate Rust у режимі release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Підказка

Деякі можливості залежать від необов'язкових залежностей. Щоб встановити їх усі, використай додаток all:

pip install ".[all]"

Дивись розділ [project.optional-dependencies] у pyproject.toml, щоб побачити, які групи залежностей доступні.

За бажання можна перевірити, що встановлення пройшло успішно. Найпростіший тест — спробувати імпортувати один із класів, які надає пакет qiskit-bosons, як у наведеному нижче прикладі:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Якщо це завершується успішно, твоє встановлення працює.

Підказка

Ти також можеш запустити весь набір тестів Python:

pip install --group test
make testpython

Щоб додатково запустити тести, які використовують необов'язкові залежності, встанови додатки та скористайся ціллю testoptional:

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