Snippets

NetSquid snippets are extensions for NetSquid contributed by users and developers. They are wholly maintained by their contributors, and NetSquid developers take no responsibility for their stability, correctness, etc.

Snippets are intended to be shared with others, and we encourage contributors to choose for an open source license. We also list snippets that are not publicly available, including a link to the private git repository in this case — please contact the snippet maintainer for access.

For snippets that can be installed using the Python package installer pip an install command is also listed.

Please use the user forum to contact us if you want to add a snippet to this online collection. A snippet template, including instructions, is available to get you started.

NetSquid-PhysLayer

Description: General physical components, such as nodes, fibres, heralded connections for entanglement generation.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-physlayer
Documentation: https://docs.netsquid.org/snippets/netsquid-physlayer
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-physlayer
Maintainer(s): David Maier

NetSquid-NV

Description: Components and models for generating and processing quantum information using nitrogen-vacancy centers. in diamond
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-nv
Documentation: https://docs.netsquid.org/snippets/netsquid-nv
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-nv
Maintainer(s): Tim Coopmans

NetSquid-AE

Description: Snippet for various Atomic-Ensemble (AE) components used in a quantum network.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-ae
Documentation: https://docs.netsquid.org/snippets/netsquid-ae
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-ae
Maintainer(s): David Maier

NetSquid-Magic

Description: Tools for generating states between remote nodes by ‘magic’, i.e. from an analytical model or existing simulation data, without simulating every attempt.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-magic
Documentation: https://docs.netsquid.org/snippets/netsquid-magic
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-magic
Maintainer(s): Tim Coopmans

NetSquid-SimulationTools

Description: Tools for storing and processing quantum-repeater-chain simulations.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-simulationtools
Documentation: https://docs.netsquid.org/snippets/netsquid-simulationtools
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-simulationtools
Maintainer(s): Guus Avis

NetSquid-NetConf

Description: Configuration tools which can be used to create, set up and connect nodes in a simulated quantum network.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-netconf
Documentation: https://docs.netsquid.org/snippets/netsquid-netconf
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-netconf
Maintainer(s): Guus Avis

NetSquid-QSwitch

Description: Tools for simulating a quantum switch as central node in a star network.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-qswitch
Documentation: https://docs.netsquid.org/snippets/netsquid-qswitch
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-qswitch
Maintainer(s): Tim Coopmans

NetSquid-NVRepchain

Description: Tools for simulating repeater chains of nitrogen-vacancy (NV) centers in diamond.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-nvrepchain
Documentation: https://docs.netsquid.org/snippets/netsquid-nvrepchain
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-nvrepchain
Maintainer(s): Tim Coopmans

NetSquid-QMM

Description: Memory manager that can be used to administer and arbitrate access to a quantum nodes’ memory
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-qmm
Documentation: https://docs.netsquid.org/snippets/netsquid-qmm
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-qmm
Maintainer(s): Wojciech Kozlowski

NetSquid-QPM

Description: Program manager that can be used to administer and arbitrate access to a quantum node's processor to execute local quantum programs.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-qpm
Documentation: https://docs.netsquid.org/snippets/netsquid-qpm
Repository: https://gitlab.com/softwarequtech/netsquid-snippets/netsquid-qpmm
Maintainer(s): Wojciech Kozlowski

NetSquid-CartesiusSim

Description: Snippet for running simulations on the cartesius system of SURFsara.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-cartesiussim
Documentation: https://docs.netsquid.org/snippets/netsquid-cartesiussim
Repository: https://gitlab.tudelft.nl/qinc-wehner/netsquid-snippets/netsquid-cartesiussim
Maintainer(s): Not available.

NetSquid-QRepeater

Description: Provides example protocols for a single quantum repeater, including entanglement purification protocols for filtering and distillation. Also includes a tutorial.
Install command:
pip3 install --user --extra-index-url https://:@pypi.netsquid.org netsquid-qrepeater
Repository: https://ci.tno.nl/gitlab/QuTech/Netsquid-QRepeater
Maintainer(s): Rob Knegjens