Arahan pemasangan

Halaman ini menerangkan cara memasang API Python. API C belum tersedia untuk pakej ini.

Prasyarat

Mula-mula, cipta persekitaran minimum dengan hanya Python dipasang di dalamnya. Gunakan persekitaran maya Python.

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

Aktifkan persekitaran baharu anda.

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

Terdapat dua cara utama untuk memasang pakej ini: daripada PyPI atau daripada sumber. Kaedah yang digalakkan ialah memasang daripada PyPI:

Pasang daripada PyPI

pip install qiskit-bosons

Pasang daripada sumber

Jika anda merancang untuk membangun dalam repositori, anda harus memasang daripada sumber.

Mula-mula, Qiskit mesti dipasang dalam persekitaran Python yang sama tempat anda memasang qiskit-bosons. Cara paling mudah ialah daripada PyPI, tetapi anda boleh memasang Qiskit daripada sumber jika mahu.

$ pip install qiskit

Seterusnya, klon repositori qiskit-bosons.

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

Sekarang, pasang rantai alat Rust, naik taraf pip, dan masuk ke repositori. Rujuk dokumentasi Rust untuk arahan memasang rantai alat tersebut.

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

Pasang kebergantungan build yang selebihnya. Jika anda merancang untuk membangun dalam repositori, pasang kebergantungan dev.

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

Langkah seterusnya ialah memasang qiskit-bosons ke dalam persekitaran maya.

pip install .

Petunjuk

Anda juga boleh melakukan pemasangan boleh edit sambil masih mengkompil crate Rust asas dalam mod release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Petunjuk

Sesetengah ciri bergantung pada kebergantungan pilihan. Untuk memasang kesemuanya, gunakan tambahan all:

pip install ".[all]"

Rujuk bahagian [project.optional-dependencies] dalam pyproject.toml untuk melihat kumpulan kebergantungan yang tersedia.

Anda boleh mengesahkan secara pilihan bahawa pemasangan berjaya. Ujian paling mudah ialah cuba mengimport salah satu kelas yang disediakan oleh pakej qiskit-bosons, seperti dalam contoh berikut:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Jika ini selesai dengan jayanya, pemasangan anda berfungsi.

Petunjuk

Anda juga boleh menjalankan keseluruhan suite ujian Python:

pip install --group test
make testpython

Untuk turut menjalankan ujian yang menguji kebergantungan pilihan, pasang tambahan dan gunakan sasaran testoptional:

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