הוראות התקנה

בעמוד הזה מוסבר איך להתקין את ה-API של Python. API ב-C עדיין אינו זמין לחבילה הזו.

דרישות מוקדמות

קודם כול, צרו סביבה מינימלית שמותקן בה רק Python. השתמשו ב-סביבות וירטואליות של Python.

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

הפעילו את הסביבה החדשה שלכם.

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

יש שתי דרכים עיקריות להתקין את החבילה הזו: מ-PyPI או ממקור. השיטה המועדפת היא התקנה מ-PyPI:

התקנה מ-PyPI

pip install qiskit-bosons

התקנה ממקור

אם אתם מתכננים לפתח במאגר, כדאי להתקין ממקור.

קודם כול, Qiskit חייבת להיות מותקנת באותה סביבת Python שבה אתם מתקינים את qiskit-bosons. הדרך הפשוטה ביותר היא מ-PyPI, אבל אפשר גם להתקין את Qiskit ממקור אם רוצים.

$ pip install qiskit

עכשיו, שכפלו (clone) את המאגר qiskit-bosons.

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

עכשיו התקינו את שרשרת הכלים של Rust, שדרגו את pip, ועברו לתיקיית המאגר. הוראות להתקנת שרשרת הכלים מופיעות בתיעוד של Rust.

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

התקינו את שאר התלויות של build. אם אתם מתכננים לפתח במאגר, התקינו גם את התלויות של dev.

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

הצעד הבא הוא להתקין את qiskit-bosons בסביבה הווירטואלית.

pip install .

רמז

אפשר גם לבצע התקנה ניתנת לעריכה (editable) ובכל זאת לקמפל את חבילת ה-Rust שבבסיס במצב release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

רמז

חלק מהיכולות תלויות בתלויות אופציונליות. כדי להתקין את כולן, השתמשו ב-extra בשם all:

pip install ".[all]"

עיינו בסעיף [project.optional-dependencies] ב-pyproject.toml כדי לראות אילו קבוצות תלויות זמינות.

אפשר לבדוק, באופן אופציונלי, שההתקנה הצליחה. הבדיקה הפשוטה ביותר היא לנסות לייבא אחת מהמחלקות שמספקת החבילה qiskit-bosons, כמו בדוגמה הבאה:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

אם זה מסתיים בהצלחה, ההתקנה עבדה.

רמז

אפשר גם להריץ את כל חבילת הבדיקות של Python:

pip install --group test
make testpython

כדי להריץ בנוסף את הבדיקות שמפעילות תלויות אופציונליות, התקינו את ה-extras והשתמשו ביעד testoptional:

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