Welcome to SimQN’s documentation!

Welcome to SimQN’s documentation. SimQN is a discrete-event based network simulation platform for quantum networks. SimQN enables large-scale investigations, including QKD protocols, entanglement distributions protocols, and routing algorithms in quantum networks.

SimQN can be accelerated with Cython.

Get Help

Having trouble? We’d like to help!

• This documentation many answer most questions.

• Try the Module Index or Index the detailed table of contents.

• Welcome to report bugs at Github.

Users' Guide:

• Introduction
  • Overview
  • Module Design
  • Develop Status
• Install Guide
  • Install stable version using pip
  • Install develop version from source
  • Compile with Cython acceleration
• Tutorials
  • Quick start
  • Parallel Simulation: to run multiple simulations and leverage multiple CPUs
  • Physical models
  • Entities in quantum networks
  • Construct large-scale networks
  • The discrete-event simulator
  • Logging and random generator
• Develop Guide
  • Code requirements
  • Develop and Compile Instruction
  • Compile API documents
• qns
  • qns package