ติดตั้ง Qiskit

ไม่ว่าจะทำงานในเครื่อง local หรือในสภาพแวดล้อม cloud ขั้นตอนแรกสำหรับทุกคนคือการติดตั้ง Qiskit

อัปเกรดจาก Qiskit 0.x เป็น Qiskit 1.0 และเวอร์ชันใหม่กว่า

(ถ้าเพิ่งติดตั้ง Qiskit เป็นครั้งแรก ข้ามไปยังส่วน ติดตั้งและตั้งค่า ได้เลย ข้อความนี้เกี่ยวข้องเฉพาะกับผู้ที่ติดตั้ง Qiskit ไว้แล้วก่อนหน้านี้เท่านั้น)

สำหรับผู้ที่อัปเกรดจากเวอร์ชัน 0.x เป็น 1.0 หรือใหม่กว่า: โปรดทราบว่า Qiskit v1.0 ใช้โครงสร้างแพ็กเกจใหม่ ดังนั้น ไม่สามารถ ใช้ pip install -U qiskit เพื่ออัปเกรดจาก Qiskit 0.x เวอร์ชันใดก็ตามเป็น 1.0 ได้

ดูรายละเอียดและคำแนะนำได้ที่ Qiskit 1.0 migration guide

การอัปเดตในอนาคตตั้งแต่ Qiskit 1.0 เป็นต้นไปจะรองรับการอัปเกรดแบบ in-place

ติดตั้ง Qiskit SDK และ Qiskit Runtime client

1. ติดตั้ง Python ตรวจสอบส่วน "Programming Language" ในหน้า Qiskit PyPI project เพื่อดูว่า Python เวอร์ชันใดบ้างที่รองรับใน release ล่าสุด สำหรับคำแนะนำการดาวน์โหลด ดูที่ Python Beginners Guide

   แนะนำให้ใช้ Python virtual environments เพื่อแยก Qiskit ออกจากแอปพลิเคชันอื่น

   หมายเหตุ

   คำแนะนำเหล่านี้ใช้ Python distribution มาตรฐานจาก pypi.org อย่างไรก็ตาม สามารถใช้ Python distribution อื่นได้ เช่น Anaconda หรือ miniconda รวมถึง dependency management workflow อื่น เช่น Poetry

   ถ้าเพิ่งเริ่มใช้ virtual environments คลิกที่นี่เพื่อดูข้อมูลเพิ่มเติม

   Python virtual environment คือพื้นที่ที่แยกออกมาสำหรับทำงานกับ Python เพื่อวัตถุประสงค์เฉพาะ — ติดตั้ง package ที่ต้องการได้ ตั้งค่า library และ dependency ต่าง ๆ โดยไม่ส่งผลกระทบต่อ Python environment "หลัก" บนเครื่อง

   ข้อดีสำคัญของ virtual environment คือถ้า Python environment เกิดปัญหาขึ้นมา ลบ virtual environment ทิ้งแล้วเริ่มใหม่ได้เลย

   เลือก location ที่ต้องการสำหรับจัดเก็บข้อมูล virtual environments โดยทั่วไปจะเก็บไว้ใน directory ชื่อ .venv ภายใน project directory แต่ละอัน

   ก่อนอื่น ไปยัง project directory และสร้าง environment เบื้องต้นที่มีแค่ Python ติดตั้งอยู่

   macOS

   python3 -m venv .venv

   Linux

   python3 -m venv .venv

   Windows

   python -m venv .venv

   จากนั้น เปิดใช้งาน environment ใหม่

   macOS

   source .venv/bin/activate

   Linux

   source .venv/bin/activate

   Windows

   ถ้าใช้ PowerShell:

   .venv\Scripts\Activate.ps1

   ถ้าใช้ Git Bash:

   source .venv/scripts/activate

   ถ้าใช้ command prompt:

   .venv\Scripts\activate

2. ติดตั้ง pip ถ้ายังไม่มีใน environment ของคุณ Pip คือ Python package manager ที่ใช้ติดตั้ง Qiskit และ Python package อื่น ๆ ใช้ pip list เพื่อดูว่ามีอะไรใน virtual environment บ้าง ใน Python environment ส่วนใหญ่ pip ติดตั้งมาพร้อมกันอยู่แล้ว

3. ติดตั้ง Qiskit SDK ถ้าต้องการรัน jobs บน quantum hardware ให้ติดตั้ง Qiskit Runtime ด้วย

   pip install qiskit

   pip install qiskit-ibm-runtime

   เพิ่มการรองรับการแสดงผล

   ถ้าต้องการใช้ visualization หรือ Jupyter notebooks ให้ติดตั้ง module qiskit.visualization ด้วย ดูข้อมูลเพิ่มเติมได้ที่ Visualizations API reference

1. ถ้าต้องการรัน Jupyter notebook พร้อม Qiskit package ที่เพิ่งติดตั้ง ต้องติดตั้ง Jupyter ใน environment ด้วย

   pip install jupyter

   จากนั้นเปิด notebook:

   jupyter notebook <path/to/notebook.ipynb>

ถ้าวางแผนจะทำงานในเครื่องและใช้ simulator ที่มีใน Qiskit การติดตั้งก็เสร็จสมบูรณ์แล้ว ถ้าต้องการรัน jobs บน IBM QPUs ให้ดำเนินการต่อที่ ตั้งค่า IBM Cloud account

อัปเดตให้ทันกับเวอร์ชันล่าสุดเสมอ

ตรวจสอบ Qiskit release notes และ Qiskit Runtime release notes เป็นระยะ ๆ เพื่อดู release ใหม่ แนะนำให้อัปเดต requirements ของ qiskit และ qiskit-ibm-runtime บ่อย ๆ เช่น เปลี่ยนเวอร์ชันใน requirements.txt เป็นเวอร์ชันล่าสุด แล้วรัน pip install -r requirements.txt หรือคำสั่งที่เหมาะสมสำหรับ dependency management workflow ของคุณ

Need help? Try asking Qiskit Code Assistant.

การแก้ปัญหา

เกิด error "No Module 'qiskit'" ใน Jupyter Notebook

ถ้าใช้ pip install qiskit และตั้งค่า virtual environment ใน Anaconda อาจพบ error No Module 'qiskit' เมื่อรัน tutorial ใน Jupyter Notebook ถ้ายังไม่ได้ติดตั้ง Qiskit หรือตั้งค่า virtual environment ทำตามขั้นตอน การติดตั้ง ได้เลย

error นี้เกิดขึ้นเมื่อพยายาม import Qiskit package ใน environment ที่ไม่ได้ติดตั้ง Qiskit ถ้าเปิด Jupyter Notebook จาก Anaconda-Navigator อาจเป็นไปได้ว่า Jupyter Notebook กำลังรันใน environment หลัก (root) แทนที่จะเป็น virtual environment ให้เลือก virtual environment ใน Anaconda-Navigator จาก dropdown menu Applications on ในเมนูนี้จะเห็น virtual environments ทั้งหมดใน Anaconda และสามารถ เลือก environment ที่ติดตั้ง Qiskit ไว้เพื่อเปิด Jupyter Notebook

เกิด compilation error ระหว่างการติดตั้ง

Qiskit ขึ้นอยู่กับ Python package แบบ open-source อื่น ๆ จำนวนหนึ่ง ซึ่งติดตั้งอัตโนมัติเมื่อรัน pip install qiskit ขึ้นอยู่กับ platform และ Python version ของระบบ อาจเป็นไปได้ที่ package บางตัว ไม่มี pre-built binary สำหรับระบบนั้น ดูได้ที่ การรองรับระบบปฏิบัติการ สำหรับรายการ platform ที่ Qiskit รองรับ บางส่วนอาจต้องใช้ compiler เพิ่มเติม ในกรณีที่ไม่มี binary ที่ compile ไว้ล่วงหน้า pip จะพยายาม compile package จากซอร์ส ซึ่งอาจต้องใช้ dependency เพิ่มเติมที่ต้องติดตั้งด้วยตนเอง

ถ้าผลลัพธ์ของ pip install qiskit มีข้อความคล้าย:

Failed building wheel for SOME_PACKAGE
...
build/temp.linux-x86_64-3.5/_openssl.c:498:30: fatal error
compilation terminated.
error: command 'x86_64-linux-gnu-gcc' failed with exit status 1

โปรดตรวจสอบเอกสารของ package ที่ติดตั้งไม่สำเร็จ (ในตัวอย่างนี้คือ SOME_PACKAGE) เพื่อดูวิธีติดตั้ง library ที่จำเป็นสำหรับการ compile จากซอร์ส

การรองรับระบบปฏิบัติการ

Qiskit พยายามรองรับระบบปฏิบัติการให้มากที่สุดเท่าที่จะเป็นไปได้ แต่เนื่องจากข้อจำกัดของทรัพยากรการทดสอบและความพร้อมใช้งานของระบบปฏิบัติการ จึงไม่สามารถรองรับได้ทั้งหมด การรองรับระบบปฏิบัติการของ Qiskit แบ่งออกเป็น 3 ระดับ โดยแต่ละระดับมีระดับการรองรับที่แตกต่างกัน สำหรับ platform ที่นอกเหนือจากนี้ เช่น FreeBSD หรือ WebAssembly (WASI) อาจยังติดตั้ง Qiskit ได้ แต่ไม่มีการทดสอบและต้องสร้าง Qiskit (และน่าจะรวม dependency ของ Qiskit ด้วย) จากซอร์ส

นอกจากนี้ Qiskit รองรับเฉพาะ CPython implementation ของภาษา Python เท่านั้น การใช้งาน Python interpreter อื่น เช่น PyPy ไม่ได้รับการรองรับ

Qiskit v2.x

ใน Qiskit v2.x release series platform ที่รองรับมีดังนี้:

Tier 1

ระบบปฏิบัติการ Tier 1 ได้รับการทดสอบอย่างเต็มรูปแบบเป็นส่วนหนึ่งของกระบวนการ development เพื่อให้แน่ใจว่าการเปลี่ยนแปลงที่เสนอมาจะทำงานได้อย่างถูกต้อง Pre-compiled binary จะถูก build ทดสอบ และเผยแพร่ไปยัง PyPI เป็นส่วนหนึ่งของกระบวนการ release โดยทั่วไป ตราบที่มี Python environment ที่ทำงานได้ ก็สามารถติดตั้ง Qiskit บนระบบปฏิบัติการเหล่านี้โดยไม่ต้องติดตั้ง dependency เพิ่มเติม

ระบบปฏิบัติการ Tier 1:

• Linux x86_64 (distributions ที่รองรับกับ manylinux 2014 packaging specification)
• macOS ARM64 (11.0 หรือใหม่กว่า)
• Windows 64-bit (รองรับ Windows 10 และใหม่กว่า)
• Linux AArch64 (distributions ที่รองรับกับ manylinux 2014 packaging specification)

Tier 2

ระบบปฏิบัติการ Tier 2 ไม่ได้รับการทดสอบเป็นส่วนหนึ่งของกระบวนการ development อย่างไรก็ตาม pre-compiled binary จะถูก build ทดสอบ และเผยแพร่ไปยัง PyPI เป็นส่วนหนึ่งของกระบวนการ release และ package เหล่านี้คาดว่าติดตั้งได้โดยมีแค่ Python environment ที่ทำงานได้เท่านั้น อาจมีความล่าช้าในการเผยแพร่ package สำหรับระบบเหล่านี้ เนื่องจากความล้มเหลวในการทดสอบอาจไม่ถูกตรวจพบจนกว่าจะผ่านไปนาน และความล้มเหลวระหว่างการเผยแพร่จะไม่บล็อคการเผยแพร่ package สำหรับระบบ Tier 1

ระบบปฏิบัติการ Tier 2:

• macOS x86_64 (10.12 หรือใหม่กว่า)

Tier 3

ระบบปฏิบัติการ Tier 3 ไม่ได้รับการทดสอบเป็นส่วนหนึ่งของกระบวนการ development Pre-compiled binary จะถูก build และเผยแพร่ไปยัง PyPI เป็นส่วนหนึ่งของกระบวนการ release แต่ไม่ได้รับการทดสอบ อาจติดตั้งไม่ได้โดยมีแค่ Python environment ที่ทำงานได้ และอาจต้องใช้ C/C++ compiler หรือโปรแกรมเพิ่มเติมเพื่อ build dependency จากซอร์สเป็นส่วนหนึ่งของกระบวนการติดตั้ง การรองรับระบบปฏิบัติการเหล่านี้เป็นแบบ best effort เท่านั้น

ระบบปฏิบัติการ Tier 3:

• Linux ppc64le (distributions ที่รองรับกับ manylinux 2014packaging specification)
• Linux s390x (distributions ที่รองรับกับ manylinux 2014 packaging specification)

ตั้งแต่ Qiskit v2.0.0 รองรับเฉพาะ platform 64-bit เท่านั้น ไม่รองรับ platform 32-bit และไม่สามารถ build จากซอร์สบน platform 32-bit ได้เช่นกัน เนื่องจาก Qiskit Rust code ภายในสมมติว่า pointer width เป็น 64-bit

Qiskit v1.x

ใน Qiskit v1.x release series platform ที่รองรับมีดังนี้:

Tier 1

ระบบปฏิบัติการ Tier 1 ได้รับการทดสอบอย่างเต็มรูปแบบเป็นส่วนหนึ่งของกระบวนการ development เพื่อให้แน่ใจว่าการเปลี่ยนแปลงที่เสนอมาจะทำงานได้อย่างถูกต้อง Pre-compiled binary จะถูก build ทดสอบ และเผยแพร่ไปยัง PyPI เป็นส่วนหนึ่งของกระบวนการ release โดยทั่วไป ตราบที่มี Python environment ที่ทำงานได้ ก็สามารถติดตั้ง Qiskit บนระบบปฏิบัติการเหล่านี้โดยไม่ต้องติดตั้ง dependency เพิ่มเติม

ระบบปฏิบัติการ Tier 1:

• Linux x86_64 (distributions ที่รองรับกับ manylinux 2014 packaging specification)
• macOS x86_64 (10.12 หรือใหม่กว่า)
• macOS ARM64 (11.0 หรือใหม่กว่า)
• Windows 64-bit (รองรับ Windows 10 และใหม่กว่า)

Tier 2

ระบบปฏิบัติการ Tier 2 ไม่ได้รับการทดสอบเป็นส่วนหนึ่งของกระบวนการ development อย่างไรก็ตาม pre-compiled binary จะถูก build ทดสอบ และเผยแพร่ไปยัง PyPI เป็นส่วนหนึ่งของกระบวนการ release และ package เหล่านี้คาดว่าติดตั้งได้โดยมีแค่ Python environment ที่ทำงานได้เท่านั้น

ระบบปฏิบัติการ Tier 2:

• Linux AArch64 (distributions ที่รองรับกับ manylinux 2014 packaging specification)

Tier 3

ระบบปฏิบัติการ Tier 3 ไม่ได้รับการทดสอบเป็นส่วนหนึ่งของกระบวนการ development Pre-compiled binary จะถูก build และเผยแพร่ไปยัง PyPI เป็นส่วนหนึ่งของกระบวนการ release แต่ไม่ได้รับการทดสอบ อาจติดตั้งไม่ได้โดยมีแค่ Python environment ที่ทำงานได้ และอาจต้องใช้ C/C++ compiler หรือโปรแกรมเพิ่มเติมเพื่อ build dependency จากซอร์สเป็นส่วนหนึ่งของกระบวนการติดตั้ง การรองรับระบบปฏิบัติการเหล่านี้เป็นแบบ best effort เท่านั้น

ระบบปฏิบัติการ Tier 3:

• Linux ppc64le (distributions ที่รองรับกับ manylinux 2014packaging specification)
• Linux s390x (distributions ที่รองรับกับ manylinux 2014 packaging specification)
• Linux i686 (distributions ที่รองรับกับ manylinux 2014 packaging specification)
• Windows 10 32-bit

ขั้นตอนถัดไป

Recommendations

• ตั้งค่า IBM Cloud account

• ตั้งค่า Qiskit ในเครื่อง

• ทำตามขั้นตอนใน Hello world เพื่อเขียนและรัน quantum program

• ลอง IBM Quantum Learning tutorial