/pyqtorch

PyTorch-based state vector simulator

Primary LanguagePythonApache License 2.0Apache-2.0

pyqtorch

pyqtorch is a PyTorch-based state vector simulator designed for quantum machine learning. It acts as the main backend for Qadence, a digital-analog quantum programming interface. pyqtorch allows for writing fully differentiable quantum programs using both digital and analog operations; enabled via a intuitive, torch-based syntax.

Linting / Tests/ Documentation License Pypi

Installation guide

pyqtorch can be installed from PyPI with pip as follows:

pip install pyqtorch

Install from source

We recommend to use the hatch environment manager to install pyqtorch from source:

python -m pip install hatch

# get into a shell with all the dependencies
python -m hatch shell

# run a command within the virtual environment with all the dependencies
python -m hatch run python my_script.py

Please note that hatch will not combine nicely with other environment managers such Conda. If you want to use Conda, install pyqtorch from source using pip:

# within the Conda environment
python -m pip install -e .

Contributing

Please refer to CONTRIBUTING to learn how to contribute to pyqtorch.