Jupyter examples¶
Worked tutorials are in the pyPalace repository:
Clone the repo so notebook paths to mesh/, config/, and *_output/ resolve:
git clone https://github.com/FirasAbouzahr/pyPalace.git
cd pyPalace
Each folder has a README with figures and run notes. Before simulating, set palace (or
path_to_palace) to your local palace-x86_64.bin.
The notebooks are written for superconducting-qubit workflows, but the same pattern—config,
Simulation.run, then postprocess Palace output—applies to any Palace problem type you
configure.
Example index¶
Example 00 — Quantum Metal → pyPalace¶
example_00_Quantum_Metal_to_pyPalace
Mesh a coplanar Qiskit Metal design, build a config, run Palace, and analyze results.
Main file: example00_notebook.ipynb. Requires gmsh, shapely, qiskit-metal (Install).
Example 01 — Eigenmode & EPR¶
Cavity–qubit eigenmode simulation and EPR Hamiltonian extraction.
example01_script.py (HPC), example01_analysis_notebook.ipynb, example01_field_visualization.py.
ParaView field dumps are not on GitHub; CSVs are provided for analysis-only runs.
Example 02 — Electrostatics & LOM¶
Capacitance matrices and LOM for transmon-style qubits.
example02_notebook_TransmonCross.ipynb and example02_notebook_pocketTransmon.ipynb (plus script versions).
Example 03 — Driven resonator and S21¶
example_03_fdomain_driven_resonator
Frequency-domain driven simulation and lineshape fitting.
example03_script.py and example03_analysis_notebook.ipynb; sample output under example03_output/.
Running simulations¶
After a Config is saved, use Simulation:
from pypalace.simulation import Simulation
sim = Simulation(cfg, palace)
sim.run(n=10)
Slurm options: HPC_options() and the
Examples README.
Suggested order¶
Example 00 — meshing + end-to-end QM workflow
Example 02 — electrostatics & LOM (friendly notebooks)
Example 01 — eigenmodes & EPR
Example 03 — driven ports & \(S_{21}\)