QCircPy is a Quantum Computer Simulation and Benchmarking package on Python with GPU and CPU flexibility and performance. It allows the user to benchmark and run simple Quantum Circuits on a GPU or CPU with numpy
and cupy
.
This project is for educational purposes.
QCircPy requires numpy
, which is installed automatically, and cupy
, which the user should install manually based on their CUDA version.
For users using CUDA 11.x:
pip install cupy-cuda11x
or:
py -m pip install cupy-cuda11x
For users using CUDA 12.x:
pip install cupy-cuda12x
or:
py - m pip install cupy-cuda12x
Then, finally:
pip install qcircpy
or:
py -m pip install qcircpy
It is recommended to use the engine
subpackage as an interface to QCircPy's functionalities.
import qcircpy.engine as qp
Detailed usage can be found in USAGE.md