Skip to main content

cavsqueeze

Tests PyPI License DOI

Beyond-mean-field simulation of cavity-mediated spin squeezing (one-axis twisting) for solid-state clock-transition ensembles, and of squeezing by measurement of the spin population through the resonator. Developed for 171Yb3+:CaWO4 and applicable to any spin ensemble coupled to a resonator.

cavsqueeze implements

  • the adiabatically eliminated Tavis-Cummings model with collective emission, collective thermal absorption, single-spin dephasing and coupling inhomogeneity (resonator.py);
  • discretization of Gaussian, Lorentzian and Voigt lines into frequency classes with tail resolution (ensemble.py);
  • a class-resolved second-order cumulant expansion in connected variables, whose cost is set by the number of classes rather than by N, so that N = 1e15 is no harder than N = 1e3, and which loses no precision to cancellation at large N because the means are subtracted analytically (cumulant.py), together with the raw-moment form used as a test reference (cumulant_raw.py); the solver can condition the ensemble on a continuous measurement of J_z through the resonator (Rates.meas, Rates.meas_eta);
  • exact references: QuTiP master equation for distinguishable spins and the permutation-invariant Dicke solver PIQS (exact.py);
  • pulse sequences: echo twist, Ramsey, twist-untwist readout, plain squeezed readout (protocols.py);
  • far-detuned spectator spins propagated analytically, which removes the stiffness of heavy-tailed lines (ensemble.tail_resolved_classes, cumulant.evolve);
  • an independent solver for cross-checking: discrete truncated Wigner trajectories (dtwa.py), which truncate the equations of motion rather than the statistics.

Installation

From PyPI:

pip install cavsqueeze          # core solver (numpy, scipy, matplotlib)
pip install cavsqueeze[exact]   # adds QuTiP for the exact reference solvers

Or from source, to run the tests:

git clone https://github.com/TaN-MM-Org/cavsqueeze
cd cavsqueeze
pip install -e .[test]
pytest tests              # validation testbench (about 2 minutes)

The test suite validates the cumulant solver against exact QuTiP and PIQS references, against closed-form limits, and against the independent discrete truncated Wigner solver; it runs in CI on every push and pull request.

Minimal example

import numpy as np
from cavsqueeze import from_hz, homogeneous
from cavsqueeze.protocols import optimal_squeezing
N = 1e10
p = from_hz(g_hz=1e6/np.sqrt(N), kappa_hz=1e4, Delta_hz=30e6, T=0.02, T2=0.15)
best = optimal_squeezing(p, homogeneous(N), 1e-6, 1e-2)
print(10*np.log10(best["xi2"]), "dB at", best["t"], "s")

Metrology projections

The metrology module turns the solver's collective moments into the quantities an experiment is designed against, for any platform the solver can describe: Kitagawa-Ueda and Wineland squeezing parameters, single-shot phase sensitivity, the projection-noise-limited Allan deviation of a Ramsey clock, and the field sensitivity of a Ramsey magnetometer.

from cavsqueeze import (squeezing_parameters, clock_allan_deviation,
                        metrological_gain_db)
m = squeezing_parameters(state, ens.n)          # xi2_S, xi2_R, contrast, dphi
print(metrological_gain_db(m["xi2_R"]), "dB over the SQL")
print(clock_allan_deviation(m["dphi"], nu0=4.29e14, T_ramsey=0.1, tau=1.0))

The formulas are the standard ones (Kitagawa-Ueda 1993; Wineland 1992; Itano 1993; Ludlow RMP 2015) and are tested against the solver's own exact references and closed-form limits. oat_closed_form (v1.10) provides the exact unitary Kitagawa-Ueda one-axis-twisting moments -- mean spin, extremal transverse variances, optimal angle and both squeezing parameters -- as the decoherence-free benchmark the dissipative solver is compared against; every returned quantity is asserted against brute-force exact evolution in the tests. The pulse-sequence layer (css_x, twist, twist_untwist, optimal_squeezing, plain_squeezed_readout, ...) is exported at the package root as of v1.10.

Squeezing from measured count data (new in v1.11)

Every other module predicts squeezing from a model; estimate_squeezing estimates it from an experiment. Feed it the standard Ramsey tomography record -- per-angle shot arrays of the measured population difference J_z = (N_up - N_down)/2 -- plus the atom number and the fringe contrast, and it returns Kitagawa-Ueda and Wineland parameters with honest uncertainties. The fit leans only on exact structure: the rotation law of a 2x2 covariance makes V(theta) = c + a cos 2theta

  • b sin 2theta exactly (no Gaussian assumption), so the tomography fit is closed-form weighted linear least squares, and V_min = c - sqrt(a^2 + b^2) is an eigenvalue identity asserted against numpy.linalg.eigvalsh. The single Gaussian assumption (the exact 2 s^4/(M-1) sample-variance error bar) is stated, not hidden. A known detection variance can be subtracted per angle -- opt-in, recorded in the result, and refused with an explanation when it over-subtracts into unphysical territory.
from cavsqueeze import estimate_squeezing, metrological_gain_db
est = estimate_squeezing(angles, shots, N=480, contrast=0.92,
                         contrast_sigma=0.01, detection_variance=v_det)
print(est.xi2_R, "+/-", est.xi2_R_sigma,
      "->", metrological_gain_db(est.xi2_R), "dB")

Anchors in the tests: exact covariance recovery with eigenvalues from an independent numpy path; the exact Kitagawa-Ueda one-axis-twisting closed form recovered from sampled shots; a coherent-spin-state sample estimating the standard quantum limit xi2_R = 1; Monte-Carlo scatter matching the reported sigma; the detection-noise round trip; and degenerate-design refusals.

Into the bosonic quantum stack

The interop module extracts the Holstein-Primakoff mode of the collective spin from any solver state: the 2x2 Gaussian quadrature covariance (a coherent spin state maps to the vacuum), its symplectic eigenvalue, squeezing parameter, angle, thermal occupation and purity, and an export to a QuTiP density matrix that reproduces that covariance. The export verifies itself against the target covariance so Fock truncation can never silently corrupt it, and the QuTiP squeeze-phase convention is locked by a test rather than assumed.

from cavsqueeze import bosonic_mode, to_qutip
mode = bosonic_mode(state, ens.n)     # Sigma, nu, r, theta, n_th, purity
rho, mode = to_qutip(state, ens.n)    # QuTiP density matrix of the mode

Associated paper

The physics, the conventions and the validation of this package are described in: T. M. Mahim, M. M. Rahman, A. S. M. Mohsin, Synchronization sets the coherence and the squeezing limit of a spin ensemble in a cavity. The paper's companion repository, yb-cawo4-cavity-squeezing, contains the scripts, datasets and figures that reproduce the paper and is archived on Zenodo; this repository is the software's home for development, releases and support.

Contributing and support

Bug reports, questions and pull requests are welcome through GitHub issues; see CONTRIBUTING.md for the development setup and the testing requirements. Tagged releases are published to PyPI by CI.

License

Apache-2.0 (see LICENSE). Please cite the paper if you use this code; citation metadata is in CITATION.cff.

Metadata

Release files for cavsqueeze 1.11.0

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

Source distribution (sdist)

Source distribution for cavsqueeze 1.11.0
File Size Uploaded
cavsqueeze-1.11.0.tar.gz 51.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cavsqueeze 1.11.0
File Interpreter ABI Platform
cavsqueeze-1.11.0-py3-none-any.whl Python 3 none any Details

Total release size: 96.3 kB

Release files / cavsqueeze-1.11.0.tar.gz

Download URL cavsqueeze-1.11.0.tar.gz
Size 51.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a85ab92019123ae84b16c2eec655d71a678b663d4787637c5dff27189130c3a9
BLAKE2b-256 checksum
How to use checksums
74af805eacf8be8c8376871e6ad8dd2cf52f072a61334fc430c88f053f5f65b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Sep 11, 2026.

Transparency log

Release files / cavsqueeze-1.11.0-py3-none-any.whl

Download URL cavsqueeze-1.11.0-py3-none-any.whl
Size 44.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c685542bb9a6144e60614e129ca47735ac1403626fbf7bbfbc9abb6ec8475088
BLAKE2b-256 checksum
How to use checksums
1547baccfd007b0344d8b5a3ae8a75500f23e0fb9479a1cba71b2ae493e54ff5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Sep 11, 2026.

Transparency log

Release history Release notifications | RSS feed

1.17.0

2 release files

1.16.0

2 release files

1.15.1

2 release files

1.15.0

2 release files

1.14.0

2 release files

1.13.0

2 release files

1.12.0

2 release files

This release

1.11.0 This release

2 release files

1.9.0

2 release files

1.8.0

2 release files

1.7.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