התקנת ה-Python API

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

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

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

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

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

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

התקנה מ-PyPI

pip install qiskit-fermions

התקנה מקוד המקור

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

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

$ pip install qiskit

בשלב הבא, שכפלו (clone) את המאגר qiskit-fermions.

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

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

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

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

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

השלב הבא הוא להתקין את qiskit-fermions בסביבה הווירטואלית.

pip install .

רמז

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

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

רמז

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

pip install ".[all]"

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

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

python -c "from qiskit_fermions.circuit import FermionicCircuit"

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

רמז

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

pip install --group test
make testpython

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

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