sequence 1.3.0

Quantum Networking in SeQUeNCe: Customizable, Scalable, Easy Debugging

SeQUeNCe: Simulator of QUantum Network Communication

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.

Installation

For Users

SeQUeNCe requires Python 3.12 or later. You can install SeQUeNCe using pip:

pip install sequence

Development Environment Setup

If you wish to modify the source code, use an editable installation with either pip or uv:

Editable installations let Python use your local source tree directly, so changes you make to the SeQUeNCe code are available without reinstalling the package after each edit. The pip option is a lightweight way to install the local package into an environment you already manage, while uv can create and synchronize a reproducible virtual environment from the project's dependency files.

(1) Using pip

git clone https://github.com/sequence-toolbox/SeQUeNCe.git
cd SeQUeNCe
make install_editable

In the Makefile, install_editable will run the following:

pip install --editable . --config-settings editable_mode=strict

The --config-settings editable_mode=strict setting makes the editable install behaves more like a real packaged install.

(2) Using uv

Install uv (Astral Instructions)

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Clone the repository and create the virtual environment

Here we clone the repository and let uv configure the development environment with the target python version.

git clone https://github.com/sequence-toolbox/SeQUeNCe.git
cd SeQUeNCe
uv sync

Activate the virtual environment

Now that the virtual environment is created with all dependencies installed, you can activate it using the following command.

source .venv/bin/activate # macOS/Linux
source .venv\Scripts\activate # Windows

Running the test suite

SeQUeNCe includes a comprehensive test suite, this can be ran with the following command

uv run pytest tests

Citation

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},
}

Usage Examples

Many examples of SeQUeNCe in action can be found in the example folder. The example includes jupyter notebook demos, and code used in published papers.

Additional Tools

Network Visualization

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, 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.

Contact

If you have questions, please contact Caitao Zhan at czhan@anl.gov.

Here is the updated table with the Code column populated:

Papers that Used and/or Extended SeQUeNCe

Please do a Pull Request to add your paper here!