S. R. Jha, S. Chowdhury, M. Hays, J. A. Grover, W. D. Oliver
Docs: equs.github.io/bosonic
Community Discord: discord.gg/frWqbjvZ4s
We present bosonic as a framework with which to simulate quantum circuits built using bosonic quantum-error-correctable code qubits, such as the Gottesman, Kitaev and Preskill (GKP) code. As such, we build bosonic on top of JAX to enable the auto differentiable and (CPU, GPU, TPU) accelerated unitary and hamiltonian simulation of these quantum circuits under experimentally realistic noise and dissipation.
Recommended: As this is a rapidly evolving project, we recommend installing the latest version of bosonic from source as follows:
pip install git+https://github.com/EQuS/bosonic.git
After installing bosonic, update the jaxquantum dependency to its latest version from source:
pip install git+https://github.com/EQuS/jaxquantum.git
If you are interested in contributing to the package, please clone this repository and install this package in editable mode after changing into the root directory of this repository:
pip install -e ".[dev]"
This will also install extras from the dev flag, which can be useful when developing the package. Since this is installed in editable mode, the package will automatically be updated after pulling new changes in the repository.
After installing bosonic, update the jaxquantum dependency to its latest version from source:
pip install git+https://github.com/EQuS/jaxquantum.git
bosonic is also published on PyPI. Simply run the following code to install the package:
pip install bosonicFor more details, please visit the getting started > installation section of our docs.
Here's an example on how to use bosonic:
from bosonic import BosonicRegister, GKPQubit, Qubit, BosonicCircuit, PhaseRotationGate, CDGate, execute
import jax.numpy as jnp
breg = BosonicRegister([GKPQubit(),Qubit()]) # [q0,q1]
bcirc = BosonicCircuit(breg)
bcirc.x(1) # add an X Gate on q1
bcirc.add(PhaseRotationGate, 0, {"phi": jnp.pi/4})
bcirc.add(CDGate, (0,1), {"beta": 1}) # q0 is the control
results = execute(bcirc, "unitary_jax")
results.plot(bcirc, 0)
results.plot(bcirc, 1)Core Devs: Shantanu A. Jha, Shoumik Chowdhury
This package was initially developed without JAX in the fall of 2021. Then, bosonic was rebuilt on JAX in early 2022. This package was briefly announced to the world at APS March Meeting 2023 and released to a select few academic groups shortly after. Since then, this package has been open sourced and developed while conducting research in the Engineering Quantum Systems Group at MIT with invaluable advice from Prof. William D. Oliver.
Thank you for taking the time to try our package out. If you found it useful in your research, please cite us as follows:
@software{jha2024jaxquantum,
author = {Shantanu R. Jha and Shoumik Chowdhury and Max Hays and Jeff A. Grover and William D. Oliver},
title = {An auto differentiable and hardware accelerated software toolkit for quantum circuit design, simulation and control},
url = {https://github.com/EQuS/jaxquantum, https://github.com/EQuS/bosonic, https://github.com/EQuS/qcsys},
version = {0.1.0},
year = {2024},
}S. R. Jha, S. Chowdhury, M. Hays, J. A. Grover, W. D. Oliver. An auto differentiable and hardware accelerated software toolkit for quantum circuit design, simulation and control (2024), in preparation.
This package is open source and, as such, very open to contributions. Please don't hesitate to open an issue, report a bug, request a feature, or create a pull request. We are also open to deeper collaborations to create a tool that is more useful for everyone. If a discussion would be helpful, please email [email protected] to set up a meeting.