Skip to main content

chalmers-qubit

Tests Documentation documentation license PyPI - Python Version

A simulation framework for Chalmers devices that can be used to simulate the running of quantum algorithms with realistic noise. We follow qutip-qip to build a processor that can take in a quantum circuit (e.g., a QASM cicruit) and performs a master equation simulation adding noise such as T1 and T2. It is also possible to perform a Monte-Carlo trajectory simulation and customize the processor to add various types of noise such as ZZCrossTalk.

The package is under development and testing.

Installation

The main requirement to use this package is qutip-qip based on qutip: The Quantum Toolbox in Python. The requirements are already specified in the setup.cfg file and you can install the package chalmers_qubit simply by downloading this folder or cloning this repository and running:

pip install .

to get the minimal installation. However, it might be beneficial to install an editable version. In the editable version, changes to the code are reflected system-wide without requiring a reinstallation.

pip install -e .

If you do not care about making changes to the source code and just want to try out the package (e.g., from Google Colab), you can do a git+ install with

pip install git+https://github.com/aqp-mc2-chalmers/chalmers-qubit.git

Usage

The usage of the package follows qutip-qip where first, a quantum circuit is defined using qutip-qip and then run on one of the custom Chalmers processors, e.g., the processor called sarimner. The custom processor is defined in chalmers_qubit.devices.sarimner.processor and can be initialized with a model, compiler and noise.

Note that only gates with compilation instructions in chalmers_qubit/sarimner/compiler.py will work for this particular processor.

Notebooks exploring the usage of the simulator is available in docs/examples/.

import numpy as np
from qutip import basis, tensor
from qutip_qip.circuit import QubitCircuit
from chalmers_qubit.devices.sarimner import (
    SarimnerProcessor,
    SarimnerModel,
    SarimnerCompiler,
    DecoherenceNoise,
    ZZCrossTalk,
)

# Define a quantum circuit
qc = QubitCircuit(2)
qc.add_gate("RX", targets=0, arg_value=np.pi / 2)
qc.add_gate("RY", targets=1, arg_value=np.pi / 2)
qc.add_gate("CZ", controls=0, targets=1)

# All frequencies are defined in GHz, and times in ns.
transmon_dict = {
    0: {"frequency": 5.0, "anharmonicity": -0.30},
    1: {"frequency": 5.4, "anharmonicity": -0.30},
}
coupling_dict = {
    (0, 1): 0.04,
}
# Construct model
model = SarimnerModel(transmon_dict=transmon_dict,
                      coupling_dict=coupling_dict)

# Load a compiler
compiler = SarimnerCompiler(model=model)

# Define all the noise objects as a list.
decoherence_dict = {
    0: {"t1": 60e3, "t2": 80e3},
    1: {"t1": 100e3, "t2": 105e3},
}
cross_talk_dict = {
    (0, 1): 1e-4,
}
noise = [
    DecoherenceNoise(decoherence_dict=decoherence_dict),
    ZZCrossTalk(cross_talk_dict=cross_talk_dict),
]

# Initialize the processor
processor = SarimnerProcessor(model=model, compiler=compiler, noise=noise)

# Load the circuit that generates the pulses to run the simulation
tlist, coeffs = processor.load_circuit(qc)

# Initial state for the simulation.
# The default assumptions is that each transmon is a qudit with 3 levels.
init_state = tensor(basis(3, 1), basis(3, 1))

# Run master equation simulation
result = processor.run_state(init_state)
print("Final state", result.states[-1])

# Run the same circuit but with mcsolve using 100 trajectories.
result = processor.run_state(init_state, solver="mcsolve", ntraj=100)
print("Final state", result.states[-1])

It is also possible to import QASM circuits.

Development

In order to add new custom pulses or modify the device, edit the processor, or compiler the tutorials and detailed instructions in qutip-qip.

The tutorials show examples of how to customize the processor. If you have installed the package in the develop mode, any changes to the processor, e.g., adding a new gate will be reflected immediately system-wide without requiring a reinstallation of the package.

Support

This package was built from contributions by Pontus Vikstål and Shahnawaz Ahmed.

Contact vikstal@chalmers.se, shahnawaz.ahmed95@gmail.com or anton.frisk.kockum@chalmers.se for help and support.

Metadata

Release files for chalmers-qubit 2.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chalmers-qubit 2.1.3
File Size Uploaded
chalmers_qubit-2.1.3.tar.gz 33.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chalmers-qubit 2.1.3
File Interpreter ABI Platform
chalmers_qubit-2.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 74.5 kB

Release files / chalmers_qubit-2.1.3.tar.gz

Download URL chalmers_qubit-2.1.3.tar.gz
Size 33.9 kB
Tags Source
SHA-256 checksum
How to use checksums
05cfa55265c83d753799fed1550e6a18d9cb27682c2f6e5f57cedc6d0a0f9957
BLAKE2b-256 checksum
How to use checksums
90ade1a4ccd313b0d50b48147e5e6958a4ece37cbf284596db1515e3548fb451
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2025.

Transparency log

Release files / chalmers_qubit-2.1.3-py3-none-any.whl

Download URL chalmers_qubit-2.1.3-py3-none-any.whl
Size 40.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9c2f6368baa719f8d7953ebb90943cd305a409ac8b5ce8ae543106a6c64235d8
BLAKE2b-256 checksum
How to use checksums
46a4c0cfad05eda009768238d807861f0e075d8dbe907fded9cc37dc22afda89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

2.1.3 This release

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page