Tool for parsing, encoding, decoding and executing NetQASM applications
Project description
NetQASM (0.8.6)
Utilities for writing, compiling, and running quantum network applications.
Intro
NetQASM is an instruction set architecture that allows one to interface with quantum network controllers and run applications on a quantum network.
Applications may be written directly in the NetQASM language, which resembles assembly code. However, this package also provides an SDK which allows writing application code in Python.
Applications written with this SDK may be run on a simulator backend, like squidasm,
or on a hardware backend consisting of real implementations of quantum network controllers, like QNodeOS.
Installation
From PyPI
NetQASM is available as a package on PyPI and can be installed with
pip install netqasm
From source
To install the package:
make install
To verify the installation:
make verify
Documentation
See the docs README for information about building and rendering docs.
Examples
Example applications can be found in netqasm/examples.
Applications can be run in two ways:
- From the command line, using
netqasm simulate. This requires the application code to be organized in a directory with a specific format (see theApplication file structurepage in the docs). - By running a Python script that contains code to start the application.
Examples of applications organized in a directory can be found in netqasm/examples/apps.
They can be run on a simulator using
netqasm simulate --app-dir netqasm/examples/<app>
Examples of Python scripts that can run applications can be found in netqasm/examples/sdk_scripts. These files can be run directly using python <filename>.
netqasm/examples/sdk_compilation contains SDK scripts that use a debug backend. Running these files does not involve an actual simulation of the application code but can be used to see the NetQASM subroutines that are compiled from the Python application code.
For more information, check the documentation.
CLI
Once installed, netqasm can be used as a command-line interface (CLI) to perform various operations.
See netqasm --help and netqasm <command> --help for the options.
For example you can use the --simulator=<simulator> to specify the simulator.
Currently support for:
Development
For code formatting, black and isort are used.
Type hints should be added as much as possible.
Types are checked using mypy.
Before code is pushed, make sure that the make lint command succeeds, which runs black, isort, flake8 and mypy.
Contributors
In alphabetical order:
- Axel Dahlberg
- Carlo Delle Donne
- Wojciech Kozlowski
- Martijn Papendrecht
- Ingmar te Raa
- Bart van der Vecht (b.vandervecht[at]tudelft.nl)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
