Instal Python API

Prasyarat

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

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 sumber. Cara yang disarankan adalah instal dari PyPI:

Instal dari PyPI

pip install qiskit-fermions

Instal dari sumber

Kalau kamu berencana mengembangkan di dalam repositori, sebaiknya instal dari sumber.

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

$ pip install qiskit

Selanjutnya, clone repositori qiskit-fermions.

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

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

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

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-fermions ke virtual environment.

pip install .

Petunjuk

Kamu juga bisa melakukan instal editable sambil tetap mengompilasi crate Rust di baliknya 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 secara opsional memverifikasi bahwa instalasi berhasil. Tes paling sederhana adalah mencoba mengimpor salah satu kelas yang disediakan paket qiskit-fermions, seperti pada contoh berikut:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Kalau ini selesai tanpa error, berarti instalasimu berhasil.

Petunjuk

Kamu juga bisa menjalankan seluruh test suite Python:

pip install --group test
make testpython

Untuk menjalankan juga tes yang melibatkan dependensi opsional, instal extras-nya dan gunakan target testoptional:

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