qsbit-sim documentation

qsbit-sim executes RV32I programs with quantum-control instructions. It schedules quantum operations and returns measurement results to the program. Use it to study CPU timing, control queues and feedback with a mock or numerical backend.

Note

qsbit-sim is in early development. Its architecture and APIs may change without backward compatibility. Feedback and bug reports are welcome on GitHub Issues.

Start here

Run your first simulation to build the simulator, execute a measurement-feedback program and inspect its result. The default mock backend requires no Python quantum packages.

Explore the architecture or follow an execution.

You want to…	Read
Install tools or change build options	Prerequisites and building
Configure Aer, Stim, QuTiP or a custom backend	Quantum backends
Write a run configuration or interpret a trace	Program and file formats
Check a timing or ordering rule	Simulation timing contract
Synchronize multiple controllers	Distributed simulation
Run QEC with decoder feedback	Decoder feedback
Find a class or replace the CPU model	C++ interfaces and API reference
Run tests or edit the website	Testing and website development

Get started

• Run your first simulation
• Install build prerequisites
• Build and test options

User guide

• Follow a program through the controller
• Use a quantum backend
• QuTiP pulse models
• Run repeated quantum experiments
• Distributed simulation
• Decoder feedback

Architecture

• Simulation time and execution
• Architecture overview
• Single-controller architecture

Reference

• Simulation timing and event ordering
• Simulator component reference
• Implementation and default profile
• Program, configuration and trace reference
• C++ interface contracts
• C++ API reference
• Glossary

Development

• Test the simulator
• Build and preview the website