piquasso 5.0.1

A simulator for photonic quantum computations.

Piquasso is an open-source Python library for simulating photonic quantum computers.

This is a research project, bugs can be expected. If you encounter any, please report it in the Issues page.

Basic example

import numpy as np
import piquasso as pq

with pq.Program() as program:
    pq.Q(0) | pq.Displacement(
        r=np.sqrt(2), phi=np.pi / 4
    )  # Displace the state on mode 0.
    pq.Q(0, 1) | pq.Beamsplitter(
        theta=0, phi=np.pi / 2
    )  # Use a beamsplitter gate on modes 0, 1.

    pq.Q(0) | pq.ParticleNumberMeasurement()  # Measurement on mode 0.

simulator = pq.GaussianSimulator(
    d=3, config=pq.Config(hbar=2)
)  # Prepare a Gaussian vacuum state

result = simulator.execute(program, shots=10)  # Apply the program with 10 shots.

print("Resulting state:", result.state)
print("Detected samples:", result.samples)

This code outputs:

Resulting state: <piquasso._simulators.gaussian.state.GaussianState object at 0x7f3ef3604ac0>
Detected samples: [(0,), (2,), (1,), (2,), (2,), (4,), (1,), (1,), (4,), (1,)]

For more details, please refer to the Piquasso documentation.

Install

Piquasso and its dependencies can be installed via pip:

pip install piquasso

If you have problems installing Piquasso as above, try installing from source with

pip install --no-binary=:all: piquasso

When installing from source does not work on your machine, please open an issue in the Issues page.

If you wish to, you can also install piquassoboost for performance improvement.

If you are doing research using Piquasso, please cite us as follows:

@misc{piquasso2024,
  title         = {Piquasso: A Photonic Quantum Computer Simulation Software Platform},
  author        = {Z. Kolarovszki and
                   T. Rybotycki and
                   P. Rakyta and
                   Á. Kaposi and
                   B. Poór and
                   Sz. Jóczik and
                   D. T. R. Nagy and
                   H. Varga and
                   K. H. El-Safty and
                   G. Morse and
                   M. Oszmaniec and
                   T. Kozsik and
                   Z. Zimborás
                   },
  year          = {2024},
  eprint        = {2403.04006},
  archiveprefix = {arXiv},
  primaryclass  = {quant-ph}
}

Documentation

The documentation is avaliable at https://piquasso.readthedocs.io/.

How to contribute?

We welcome people who want to make contributions to Piquasso, be it big or small! If you are considering larger contributions to the source code, please contact us first.

We also appreciate bug reports, suggestions, or any kind of idea regarding Piquasso.

Development guide

To install development dependencies, use:

pip install -e ".[dev]"

For document generation one should use

pip install -e ".[docs]"

and for running files under benchmarks/ or scripts/, please issue

pip install -e ".[benchmark]"

For building Piquasso, one also needs to install build dependencies:

pip install 'pybind11[global]' scikit-build-core cmake

To build Piquasso for local development, run

cmake -B build -DCMAKE_INSTALL_PREFIX=$(pwd)
cmake --build build
cmake --install build

Here, the -DCMAKE_INSTALL_PREFIX=$(pwd) flag is needed to copy shared libraries into the source tree for development.

Testing

Tests and additional checks can be run using tox. After installation, run the following command:

tox -e py312

Alternatively, you can run only the tests using pytest. After installation, run the following command:

pytest tests