SeQUeNCe is an open source, discrete-event simulator for quantum networks. As described in our paper, the simulator includes 5 modules on top of a simulation kernel:
- Hardware
- Entanglement Management
- Resource Management
- Network Management
- Application
These modules can be edited by users to define additional functionality and test protocol schemes, or may be used as-is to test network parameters and topologies.
SeQUeNCe requires an installation of Python 3.8 or later. This can be found at the Python Website.
You can install with:
pip install sequence
Or, download the package, navigate to its directory, and install with
git clone https://github.com/sequence-toolbox/SeQUeNCe.git
cd SeQUeNCe
pip install .
Please cite us, thank you!
@article{sequence,
author = {Xiaoliang Wu and Alexander Kolar and Joaquin Chung and Dong Jin and Tian Zhong and Rajkumar Kettimuthu and Martin Suchara},
title = {SeQUeNCe: a customizable discrete-event simulator of quantum networks},
journal = {Quantum Science and Technology},
volume = {6},
year = {2021},
month = {sep},
doi = {10.1088/2058-9565/ac22f6},
url = {https://dx.doi.org/10.1088/2058-9565/ac22f6},
publisher = {IOP Publishing},
}
Once SeQUeNCe has been installed as described above, simply run the gui.py
script found in the root of the project directory
$ python gui.py
Many examples of SeQUeNCe in action can be found in the example folder. These include both quantum key distribution and entanglement distribution examples.
Code for the experiments performed in our paper can be found in the file starlight_experiments.py
. This script uses the starlight.json
file (also within the example folder) to specify the network topology.
The example folder contains several scripts that can be run with jupyter notebook for easy editing and visualization. These files require that the notebook package be installed (Anaconda recommended):
$ pip install notebook
$ pip install ipywidgets
To run each file, simply run
$ jupyter notebook <filename>
These examples include:
BB84_eg.ipynb
, which uses the BB84 protocol to distribute secure keys between two quantum nodestwo_node_eg.ipynb
, which performs entanglement generation between two adjacent quantum routersthree_node_eg_ep_es.ipynb
, which performs entanglement generation, purification, and swapping for a linear network of three quantum routers
The example directory contains an example json file starlight.json
to specify a network topology, and the utils directory contains the script draw_topo.py
to visualize json files. To use this script, the Graphviz library must be installed. Installation information can be found on the Graphviz website.
To view a network, simply run the script and specify the relative location of your json file:
$ python utils/draw_topo.py example/starlight.json
This script also supports a flag -m
to visualize BSM nodes created by default on quantum links between routers.
This project includes a modified fork of the Quantum++ library version 2.6.
Please see the Quantum++ LICENSE
file for more information.
If you have questions, please contact Caitao Zhan at czhan@anl.gov.
-
X. Wu et al., "Simulations of Photonic Quantum Networks for Performance Analysis and Experiment Design", IEEE/ACM Workshop on Photonics-Optics Technology Oriented Networking, Information and Computing Systems (PHOTONICS), 2019
-
X. Wu, A. Kolar, J. Chung, D. Jin, T. Zhong, R. Kettimuthu and M. Suchara. "SeQUeNCe: A Customizable Discrete-Event Simulator of Quantum Networks", Quantum Science and Technology, 2021
-
V. Semenenko et al., "Entanglement generation in a quantum network with finite quantum memory lifetime", AVS Quantum Science, 2022
-
A. Zang et al., "Simulation of Entanglement Generation between Absorptive Quantum Memories", IEEE QCE 2022
-
M.G. Davis et al., "Towards Distributed Quantum Computing by Qubit and Gate Graph Partitioning Techniques", IEEE QCE 2023
-
R. Zhou et al., "A Simulator of Atom-Atom Entanglement with Atomic Ensembles and Quantum Optics", IEEE QCE 2023
-
X. Wu et al., "Parallel Simulation of Quantum Networks with Distributed Quantum State Management", ACM Transactions on Modeling and Computer Simulation, 2024
Please do a Pull Request to add your paper here!