ติดตั้ง Python API
สิ่งที่ต้องมีก่อน
ก่อนอื่น สร้าง environment ขั้นต่ำที่มีเพียง Python ติดตั้งอยู่ ใช้ Python virtual environment
python3 -m venv /path/to/virtual/environment
เปิดใช้งาน environment ใหม่ของคุณ
source /path/to/virtual/environment/bin/activate
มีสองวิธีหลักในการติดตั้งแพ็กเกจนี้: จาก PyPI หรือจากซอร์ส วิธีที่แนะนำคือติดตั้งจาก PyPI:
ติดตั้งจาก PyPI
pip install qiskit-fermions
ติดตั้งจากซอร์ส
หากคุณวางแผนจะพัฒนาใน repository ควรติดตั้งจากซอร์ส
ก่อนอื่น ต้องติดตั้ง Qiskit ใน Python environment เดียวกับที่คุณติดตั้ง qiskit-fermions วิธีที่ง่ายที่สุดคือติดตั้งจาก PyPI แต่คุณจะติดตั้ง Qiskit จากซอร์สก็ได้หากต้องการ
$ pip install qiskit
ถัดไป โคลน repository qiskit-fermions
git clone git@github.com:Qiskit/qiskit-fermions.git
ตอนนี้ ติดตั้ง Rust toolchain อัปเกรด pip และเข้าไปใน repository ดู เอกสาร Rust สำหรับวิธีติดตั้ง toolchain
### <INSTALL RUST HERE> ###
pip install --upgrade pip
cd qiskit-fermions
ติดตั้งส่วนที่เหลือของ dependency แบบ build หากคุณวางแผนจะพัฒนาใน repository ให้ติดตั้ง dependency แบบ dev ด้วย
pip install --group build
pip install --group dev # optional
ขั้นตอนถัดไปคือติดตั้ง qiskit-fermions ลงใน 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-fermions มีให้ ดังตัวอย่างต่อไปนี้:
python -c "from qiskit_fermions.circuit import FermionicCircuit"
หากทำงานเสร็จโดยไม่มีข้อผิดพลาด แสดงว่าการติดตั้งใช้งานได้
คุณยังรันชุดทดสอบ Python ทั้งหมดได้ด้วย:
pip install --group test
make testpython
หากต้องการรันการทดสอบที่ใช้ dependency ที่เป็นตัวเลือกเพิ่มเติม ให้ติดตั้ง extra และใช้ target testoptional:
pip install -e ".[all]"
make testoptional