インストール手順

このページでは、Python API のインストール方法を説明します。このパッケージ向けの C API は、まだ利用できません。

前提条件

まず、Python だけがインストールされた最小限の環境を作成します。Python 仮想環境を使用してください。

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

新しい環境をアクティベートします。

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

このパッケージをインストールする主な方法は、PyPI からインストールする方法とソースからインストールする方法の2つです。推奨される方法は PyPI からのインストールです。

pip install qiskit-bosons

リポジトリで開発する予定の場合は、ソースからインストールしてください。

まず、qiskit-bosons をインストールするのと同じ Python 環境に Qiskit をインストールしておく必要があります。最も簡単な方法は PyPI からインストールすることですが、希望する場合は Qiskit をソースからインストールすることもできます。

$ pip install qiskit

次に、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 .

ヒント

基盤となる Rust クレートを release モードでコンパイルしながら、編集可能インストールを実行することもできます。

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

ヒント

一部の機能はオプションの依存関係に依存しています。すべてをインストールするには、all エクストラを使用します。

pip install ".[all]"

利用可能な依存関係グループについては、pyproject.toml の [project.optional-dependencies] セクションを参照してください。

必要に応じて、インストールが成功したことを確認できます。最も簡単なテストは、次の例のように、qiskit-bosons パッケージが提供するクラスの1つをインポートしてみることです。

python -c "from qiskit_bosons.circuit import BosonicCircuit"

これが正常に完了すれば、インストールは成功です。

ヒント

Python のテストスイート全体を実行することもできます。

pip install --group test
make testpython

オプションの依存関係を使用するテストも追加で実行するには、エクストラをインストールし、testoptional ターゲットを使用します。

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