คำแนะนำการติดตั้ง

หน้านี้อธิบายวิธีติดตั้ง Python API ขณะนี้แพ็กเกจนี้ยังไม่มี C API

สิ่งที่ต้องมีก่อน

ก่อนอื่น ให้สร้างสภาพแวดล้อมขั้นต่ำที่ติดตั้งแค่ Python ใช้Python virtual environments

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

เปิดใช้งานสภาพแวดล้อมใหม่ของคุณ

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

มีสองวิธีหลักในการติดตั้งแพ็กเกจนี้: จาก PyPI หรือจากซอร์ส วิธีที่แนะนำคือติดตั้งจาก PyPI:

ติดตั้งจาก PyPI

pip install qiskit-bosons

ติดตั้งจากซอร์ส

หากคุณวางแผนพัฒนาใน repository ควรติดตั้งจากซอร์ส

ก่อนอื่น ต้องติดตั้ง Qiskit ในสภาพแวดล้อม Python เดียวกับที่คุณติดตั้ง qiskit-bosons วิธีที่ง่ายที่สุดคือติดตั้งจาก PyPI แต่คุณจะติดตั้ง Qiskit จากซอร์สก็ได้หากต้องการ

$ pip install qiskit

จากนั้น clone repository qiskit-bosons

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

ตอนนี้ ติดตั้ง Rust toolchain อัปเกรด pip และเข้าไปใน repository ดูคำแนะนำการติดตั้ง toolchain ได้ในเอกสาร Rust

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

ติดตั้ง dependency build ที่เหลือ หากคุณวางแผนพัฒนาใน repository ให้ติดตั้ง dependency dev ด้วย

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

ขั้นตอนถัดไปคือติดตั้ง qiskit-bosons ลงใน virtual environment

pip install .

คำแนะนำ

คุณยังสามารถติดตั้งแบบ editable ได้ โดยยังคงคอมไพล์ Rust crate ข้างใต้ในโหมด release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

คำแนะนำ

บางฟีเจอร์ต้องพึ่ง dependency ที่เป็นทางเลือก หากต้องการติดตั้งทั้งหมด ให้ใช้ extra all:

pip install ".[all]"

ดูส่วน [project.optional-dependencies] ของ pyproject.toml เพื่อดูว่ามีกลุ่ม dependency ใดบ้าง

คุณสามารถตรวจสอบได้ว่าการติดตั้งสำเร็จหรือไม่ การทดสอบที่ง่ายที่สุดคือลอง import หนึ่งในคลาสที่แพ็กเกจ qiskit-bosons มีให้ ดังตัวอย่างต่อไปนี้:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

หากคำสั่งนี้ทำงานสำเร็จ แสดงว่าการติดตั้งใช้งานได้

คำแนะนำ

คุณยังสามารถรัน Python test suite ทั้งหมดได้:

pip install --group test
make testpython

หากต้องการรันการทดสอบที่ใช้ dependency ทางเลือกเพิ่มเติม ให้ติดตั้ง extras และใช้ target testoptional:

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