pyEPR — Energy-Participation-Ratio Framework#

Version: 0.9.6 | License: BSD-3-Clause | GitHub | PyPI

pyEPR overview

pyEPR is an open-source Python library for the automated design and quantization of Josephson quantum circuits. It bridges classical distributed microwave simulation (Ansys HFSS) and quantum circuit Hamiltonians using the energy-participation ratio (EPR) method.

Simulate

Run an eigenmode simulation in Ansys HFSS with junction inductances. No manual circuit diagram needed — just the 3-D geometry.

Extract

Compute energy participation ratios pmj and zero-point phase fluctuations φzpf for every mode and junction.

Diagonalize

Numerically diagonalize the full Josephson Hamiltonian to get dressed frequencies, anharmonicities, and the χ matrix.

HFSS junction setup animation — Xmon qubit

Quick install#

pip install pyEPR-quantum
conda install -c conda-forge pyepr-quantum
uv pip install pyEPR-quantum

No Ansys licence? Start with Using pyEPR without Ansys HFSS or open Tutorial 6 on Binder.


Five-line quickstart#

import pyEPR as epr

pinfo = epr.ProjectInfo(project_path=r'C:\sims', project_name='my_chip',
                         design_name='qubit_cavity')
pinfo.junctions['jQ'] = {'Lj_variable':'Lj1', 'rect':'junc_rect',
                          'line':'junc_line', 'Cj_variable':'Cj1'}
eprd = epr.DistributedAnalysis(pinfo)
eprd.do_EPR_analysis()
epra = epr.QuantumAnalysis(eprd.data_filename)
epra.analyze_all_variations(cos_trunc=8, fock_trunc=15)

See the Quick-start examples page for more complete examples including the no-HFSS numerical workflow.


Contents#

Indices and tables#