The qsim-Cirq Python interface is available as a PyPI package for Linux, MacOS and Windows users. For all others, Dockerfiles are provided to install qsim in a contained environment.
Before installation
Prior to installation, consider opening a virtual environment.
Prerequisites are included in the
requirements.txt
file, and will be automatically installed along with qsimcirq.
If you'd like to develop qsimcirq, a separate set of dependencies are includes
in the
dev-requirements.txt
file. You can install them with pip3 install -r dev-requirements.txt or
pip3 install qsimcirq[dev].
Linux installation
We provide qsimcirq Python wheels on 64-bit x86 architectures with Python 3.{7,8,9,10,11,12}.
Simply run pip3 install qsimcirq.
MacOS installation
We provide qsimcirq Python wheels on x86 architectures with Python 3.{7,8,9,10,11,12}.
Simply run pip3 install qsimcirq.
Windows installation
We provide qsimcirq Python wheels on 64-bit x86 and amd64 architectures with Python 3.{7,8,9,10,11,12}.
Simply run pip3 install qsimcirq.
There's no compatible wheel for my machine!
If existing wheels do no meet your needs please open an issue with your machine configuration (i.e. CPU architecture, Python version) and consider using the Docker config provided with this repository.
Conda Installation
qsimcirq is now also available on conda-forge for Linux x86 including CUDA builds and MacOS x86 and Apple Silicon ARM64.
To install qsimcirq using conda, you can use the following command:
conda install -c conda-forge qsimcirq
This will install the qsimcirq package from the conda-forge channel.
Testing
After installing qsimcirq on your machine, you can test the installation by
copying qsimcirq_tests/qsimcirq_test.py
to your machine and running python3 -m pytest qsimcirq_test.py.
It also has examples of how how to use this package.