Petunjuk instalasi

Halaman ini menjelaskan cara menginstal Python API. C API belum tersedia untuk paket ini.

Prasyarat

Pertama, buat environment minimal yang hanya berisi Python. Gunakan virtual environment Python.

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

Aktifkan environment barumu.

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

Ada dua cara utama untuk menginstal paket ini: dari PyPI atau dari source. Cara yang disarankan adalah menginstal dari PyPI:

Instal dari PyPI

pip install qiskit-bosons

Instal dari source

Kalau kamu berencana mengembangkan di dalam repositori, instal dari source.

Pertama, Qiskit harus terinstal di environment Python yang sama dengan tempat kamu menginstal qiskit-bosons. Cara paling mudah adalah dari PyPI, tapi kamu juga bisa menginstal Qiskit dari source kalau mau.

$ pip install qiskit

Selanjutnya, clone repositori qiskit-bosons.

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

Sekarang, instal toolchain Rust, upgrade pip, lalu masuk ke repositori. Lihat dokumentasi Rust untuk petunjuk menginstal toolchain.

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

Instal dependensi build yang tersisa. Kalau kamu berencana mengembangkan di dalam repositori, instal juga dependensi dev.

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

Langkah berikutnya adalah menginstal qiskit-bosons ke virtual environment.

pip install .

Petunjuk

Kamu juga bisa melakukan editable install sambil tetap mengompilasi Rust crate di bawahnya dalam mode release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Petunjuk

Beberapa fitur bergantung pada dependensi opsional. Untuk menginstal semuanya, gunakan extra all:

pip install ".[all]"

Lihat bagian [project.optional-dependencies] di pyproject.toml untuk melihat grup dependensi apa saja yang tersedia.

Kamu bisa memverifikasi secara opsional bahwa instalasi berhasil. Tes paling sederhana adalah mencoba mengimpor salah satu class yang disediakan paket qiskit-bosons, seperti pada contoh berikut:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Kalau ini selesai tanpa error, instalasimu berhasil.

Petunjuk

Kamu juga bisa menjalankan seluruh test suite Python:

pip install --group test
make testpython

Untuk menjalankan tambahan tes yang menguji dependensi opsional, instal extras dan gunakan target testoptional:

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