Petunjuk instalasi

Sebelum menginstal package, pilih dulu bagaimana kamu akan menjalankan dan menginstal package. Ada dua cara utama:

• Opsi 1: Instal dari PyPI

• Opsi 2: Instal dari source

Pra-instalasi

Pertama, buat environment minimal yang hanya berisi Python. Kami menyarankan memakai Python virtual environment.

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

Aktifkan environment barumu.

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

Catatan: Kalau kamu memakai Windows, gunakan perintah berikut di PowerShell:

python3 -m venv c:\path\to\virtual\environment
c:\path\to\virtual\environment\Scripts\Activate.ps1

Opsi 1: Instal dari PyPI

Cara paling mudah untuk menginstal package qiskit-addon-obp adalah dengan PyPI.

pip install 'qiskit-addon-obp'

Opsi 2: Instal dari source

Pengguna yang ingin mengembangkan di dalam repositori atau menjalankan notebook secara lokal mungkin ingin menginstal dari source.

Kalau begitu, langkah pertama adalah meng-clone repositori qiskit-addon-obp.

git clone git@github.com:Qiskit/qiskit-addon-obp.git

Selanjutnya, upgrade pip dan masuk ke repositori.

pip install --upgrade pip
cd qiskit-addon-obp

Langkah berikutnya adalah menginstal qiskit-addon-obp ke virtual environment. Kalau kamu berencana menjalankan notebook, instal dependensi notebook supaya bisa menjalankan visualisasi. Kalau kamu berencana mengembangkan di repositori, mungkin kamu perlu menginstal dependensi dev.

Sesuaikan opsi di bawah ini dengan kebutuhanmu.

pip install tox notebook -e '.[notebook-dependencies,dev]'

Kalau kamu sudah menginstal dependensi notebook, kamu bisa mulai dengan menjalankan notebook di direktori docs.

cd docs/
jupyter lab