Installation

Requirements

qiskit-qulacs works in the following environments.

  • Python： >=3.8, <3.10

  • Qiskit： >=0.32.1, <0.33.0

    • If you want to use Qiskit applications library, please use the following version.

      • Qiskit Nature： 0.2.2

      • Qiskit Machine Learning： >=0.2.1, <0.3.0

      • Qiskit Finance： >=0.3.1, <0.4.0

      • Qiskit Optimization： 0.2.3

  • mpiQulacs： >=1.0.0, <2.0.0

Qiskit and mpiQulacs are automatically installed when you pip install qiskit-qulacs. If you have installed other versions of Qiskit and mpiQulacs, uninstall them first.

If you want to use a version of Python that is not installed on your system by default, see Install of pyenv .

Installing qiskit-qulacs

qiskit-qulacs can be installed via pip.
If you use the Python virtual environment, you can install it, for example:.
# Interactive from login server
[username@loginvm-XXX ~]$ salloc -N 1 -p Interactive --time=1:00:00
[username@fx-XX-XX-XX ~]

# Create virtual environment and activate
[username@fx-XX-XX-XX ~]$ mkdir example
[username@fx-XX-XX-XX ~]$ cd example
[username@fx-XX-XX-XX example]$ python3.8 -m venv qenv
[username@fx-XX-XX-XX example]$ source ./qenv/bin/activate
(qenv) [username@fx-XX-XX-XX example]$

# Install the latest version of pip and wheel
(qenv) [username@fx-XX-XX-XX example]$ pip install --upgrade pip wheel
# Install the qiskit-qulacs (For the first installation, it takes about 15 min.)
(qenv) [username@fx-XX-XX-XX example]$ pip install qiskit-qulacs

# If you want to use the Qiskit applications library, please install the following version.
# (For example, if you only need qiskit-nature, you do not need to install anything other than qiskit-nature.)
(qenv) [username@fx-XX-XX-XX example]$ pip install qiskit-nature==0.2.2
(qenv) [username@fx-XX-XX-XX example]$ pip install qiskit-machine-learning==0.2.1
(qenv) [username@fx-XX-XX-XX example]$ pip install qiskit-optimization==0.2.3
# If you want to install qiskit-finance, install qiskit-optimization first.
(qenv) [username@fx-XX-XX-XX example]$ pip install qiskit-finance==0.3.1
(qenv) [username@fx-XX-XX-XX example]$
(qenv) [username@fx-XX-XX-XX example]$ exit

Note

Due to installation on aarch64, wheel files are often missing from pypi.org. As a result, pip install can run the source build and take a relatively long time to complete the installation. For subsequent installations, the wheel files are cached under your home directory, reducing installation time.