Look up cqed_sim API before writing simulation code. Use when: planning a simulation, checking if functionality exists in cqed_sim, finding the right model/function/class, writing pulse sequences, configuring simulation parameters, or mapping a first-principles analytic model onto cqed_sim. Provides the API reference and usage guidance.
The canonical API reference is maintained alongside the cqed_sim source code:
C:\Users\dazzl\Box\Shyam Shankar Quantum Circuits Group\Users\Users_JianJun\cQED_simulation\API_REFERENCE.mdAlways read the local file — it reflects the installed version and avoids network dependencies.
Before searching the API, write down the minimal first-principles model you are trying to simulate:
This step tells you what capabilities the API must support and prevents API-driven rather than physics-driven study design.
Read the local API_REFERENCE.md file. If looking for specific functionality, search for keywords related to:
DispersiveTransmonCavityModel, DispersiveReadoutTransmonStorageModel, UniversalCQEDModelPulse, envelopes (GaussianEnvelope, FlatTopEnvelope, etc.), PulseBuildersimulate_sequence, SimulationConfig, SimulationResult, SimulationSessionNoiseSpec, Lindblad operators, T1/T2 parameterscqed_sim.analysis modulecqed_sim.gates, ideal gate operatorscqed_sim.tomoUnitarySynthesizer, optimal controlcqed_sim.calibration, cqed_sim.calibration_targetscqed_sim.plottingAfter reading, classify the required functionality:
| Coverage | Action |
|---|---|
| Fully supported | Use cqed_sim directly. Do not write standalone code. |
| Partially supported | Use cqed_sim as the foundation and extend. Document the gap in the study README. |
| Not supported | Write standalone code. Document the gap and add a ## Suggested Upstreaming section to the README. |
In the study README ## Methods and ## Analytic Preliminary sections, list:
For sign definitions, Hamiltonian algebra, and rotating-frame conventions, consult:
C:\Users\dazzl\Box\Shyam Shankar Quantum Circuits Group\Users\Users_JianJun\cQED_simulation\physics_and_conventions\physics_conventions_report.tex_hz or _ns suffixes accept those specific units.SimulationConfig.backend.