Python APIのインストール

前提条件

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

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

作成した新しい環境を有効化します。

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

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

pip install qiskit-fermions

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

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

$ pip install qiskit

次に、qiskit-fermions リポジトリをクローンします。

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

次に、Rustツールチェーンをインストールし、pipをアップグレードして、リポジトリに移動します。ツールチェーンのインストール方法については、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 .

ヒント

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

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

ヒント

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

pip install ".[all]"

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

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

python -c "from qiskit_fermions.circuit import FermionicCircuit"

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

ヒント

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

pip install --group test
make testpython

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

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