تعليمات التثبيت

هذه الصفحة تشرح كيف تثبّت واجهة Python البرمجية. واجهة C API غير متاحة لهذه الحزمة حتى الآن.

المتطلبات الأساسية

أولًا، أنشئ بيئة بسيطة فيها Python فقط. استخدم بيئات Python الافتراضية.

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

فعّل بيئتك الجديدة.

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

فيه طريقتان رئيسيتان لتثبيت هذه الحزمة: من 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 .

تلميح

بعض الميزات تعتمد على تبعيات اختيارية. لتثبيتها كلها، استخدم الإضافة 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

لتشغيل الاختبارات التي تستخدم التبعيات الاختيارية أيضًا، ثبّت الإضافات واستخدم الهدف testoptional:

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