bosonic-qiskit 14.2

National Quantum Initiative Co-design Center for Quantum Advantage bosonic Qiskit simulator

PACKAGE DEPRECIATION WARNING

The way to import bosonic-qiskit will be changing from import c2qa to import bosonic_qiskit. This change will occur on release of version 15.0 on November 16, 2025.

Please update any use of c2qa in your code accordingly

Bosonic Qiskit

NQI C2QA project to simulate hybrid boson-qubit systems within QisKit.

Installation

Virtual Environment

It is recommended to install bosonic-qiskit in a virtual environment:

python3 -m venv venv
source venv/bin/activate

PyPi Installation

The easiest way to install bosonic-qiskit is through PyPi:

pip install bosonic-qiskit

Development

Source code installation of bosonic-qiskit for development is possible with the install-dependencies.sh convenience script:

git clone https://github.com/C2QA/bosonic-qiskit.git
cd bosonic-qiskit
./install-dependencies.sh

The above script does the following:

1. Creates a virtual environment with the name venv and activates it.
2. The bosonic-qiskit library is installed in editable mode with developer requirements from requirements_dev.txt which include tools such as flake8, black, and pre-commit to aid in satisfying code style and format requirements.
3. The tool pre-commit is installed which automatically runs flake8 and black upon the git commit command.

Code Style Requirements

Any changes or additions to bosonic-qiskit must be black and flake8 compliant. These tools can be run manually, however with pre-commit these tools automatically check for code style compliance when commiting code. If black shows non-compliant code formatting, changes must be be manually made and altered files must be recommitted.

Dependency Version Compatibility

The Bosonic Qiskit software has not been extensively tested with different versions of its dependencies; however, some success has been achieved with both newer and older versions of Qiskit. Do note that some features require newer versions. For example, the noise modelling requires Qiskit v0.34.2+. Using older versions will cause ModuleNotFoundError at runtime.

Tutorials

Jupyter Notebook tutorials can be found in the tutorials folder. JupyterLab is a dependency found in requirements.txt, so after installing and activating the virtual environment, to run the tutorials simply start Jupyter with jupyter lab and then navigate to the desired tutorial.

See our paper presented at IEEE HPEC 2022 on arXiv for more information on using bosonic-qiskit.

How to add gates

The code is structured to separate generation of the operator matrices from creating instances of QisKit Gate.

The first step in adding a new gate is to develop software to build a unitary operator matrix. These matrices must be unitary in order for QisKit to simulate them. Non unitary matrices will fail during simulation. Existing operator matrices are built in the CVOperators class found in operators.py. Included in CVOperators are functions to build the bosonic creation and annihilation operators based on a provided cutoff. The order of the data in your operators must match the order of the qumodes (QisKit qubits) sent in as QisKit gate parameters found in circuit.py, as described next.

Once you've written software to build the operator matrix, a new function is added to the CVCircuit class found in circuit.py. This class extends the QisKit QuantumCircuit class to add the bosonic gates available in this library. The previusly defined operators are parameterized by user input, as needed, and appended to the QuantumCircuit as unitary gates. The CVCircuit class includes functions to easily make your new gates conditional based on a control qubit.

See examples of software building new gates in the previously mentioned operators.py and circuit.py. Examples using the library's gates can be found in both the PyTest test cases and Jupyter Notebook tutorials folders

Available Gates

Current gates available for simulation are documented at https://c2qa.github.io/bosonic-qiskit/c2qa.circuit.CVCircuit.html