Add template for creating quantum local applications using the new SDK

Author: dieriver

examples/new-sdk/template-quantum-local/doNew.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+./terminate.sh
+./run.sh

examples/new-sdk/template-quantum-local/nodeTest.py

@@ -0,0 +1,57 @@
+from asyncio import StreamReader, StreamWriter
+from pathlib import Path
+
+from simulaqron.general.host_config import SocketsConfig
+from simulaqron.sdk.protocol import SimulaQronClassicalClient
+from simulaqron.settings import network_config, simulaqron_settings
+from simulaqron.settings.network_config import NodeConfigType
+
+# This is recipe to use NetQASM with simulaqron backend.
+from netqasm.runtime.settings import set_simulator
+set_simulator("simulaqron")
+
+# Importing NetQASM connection, Qubit and EPR socket must be *after*
+# setting the simulator for NetQASM
+from netqasm.sdk.external import NetQASMConnection  # noqa: E402
+from netqasm.sdk import Qubit, EPRSocket  # noqa: E402
+
+
+# This function contains the code of the classical client
+def quantum_program(this_node_name: str) -> int:
+    # To start executing quantum operations, we need to create a NetQASM connection
+    with NetQASMConnection(this_node_name, epr_sockets=[epr_socket]) as alice:
+        # Create a qubit
+        q = Qubit(alice)
+
+        # Perform some local quantum operations
+        q.H()
+        q.X()
+        m1 = q.measure()
+    # Any value that comes from NetQASM *need* to be retrieved ("casted" to int)
+    # *after* the connection is closed (or after flushing the connection, untested)
+    m1_val = int(m1)
+    return m1_val
+
+
+if __name__ == "__main__":
+    # Load the simulaqron settings file
+    simulaqron_config_file = Path("simulaqron_settings.json")
+    simulaqron_settings.read_from_file(simulaqron_config_file)
+
+    # Load the file network configuration file
+    # We still need this file to correctly interact with the SimulaQron backend (QNodeOS and Virtual Node)
+    network_config_file = Path("simulaqron_network.json")
+    network_config.read_from_file(network_config_file)
+
+    # Some data for this node:
+    network_name = "default"  # A network with this name *must* exist in "simulaqron_network.json"
+    node_name = "YourName"  # A node with this name *must* exist in "simulaqron_network.json"
+
+    # Get the socket configuration for the sockets used for the application layer
+    sockets_config = SocketsConfig(network_config, network_name, NodeConfigType.APP)
+
+    # Name of one node to classically connect to
+    server_name = "Bob"
+
+    result = quantum_program()
+    print(result)

examples/new-sdk/template-quantum-local/run.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# Flag used to determine whether to start simulaqron backend or not
+# This is useful when using this script to run the application in different machines.
+START_SIMULAQRON=true
+
+# Process the arguments, if any
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        -n|--no-start-simulaqron)
+            START_SIMULAQRON=false
+            shift
+            ;;
+    esac
+done
+
+if [ "$START_SIMULAQRON" = true ]; then
+    # Check if SimulaQron is already running
+    if [ ! -f ~/.simulaqron_pids/simulaqron_network_default.pid ]; then
+        # TODO - Modify the list of nodes to start on this machine
+        # TODO - Change the filename of the network configuration if you changed that
+        # TODO - Change the filename of the simulaqron configuration if you changed that
+        # If not, start simulaqron backend for both nodes
+        simulaqron start --nodes=Alice --network-config-file simulaqron_network.json --simulaqron-config-file simulaqron_settings.json
+    fi
+fi
+
+python3 nodeTest.py

examples/new-sdk/template-quantum-local/simulaqron_network.json

@@ -0,0 +1,36 @@
+[
+    {
+        "name": "default",
+        "nodes":  [
+            {
+                "Alice": {
+                    "app_socket": ["localhost", 8821],
+                    "qnodeos_socket": ["localhost", 8822],
+                    "vnode_socket": ["localhost", 8823]
+                }
+            },
+            {
+                "Bob": {
+                    "app_socket": ["localhost", 8831],
+                    "qnodeos_socket": ["localhost", 8832],
+                    "vnode_socket": ["localhost", 8833]
+                }
+            },
+            {
+                "Charlie": {
+                    "app_socket": ["localhost", 8841],
+                    "qnodeos_socket": ["localhost", 8842],
+                    "vnode_socket": ["localhost", 8843]
+                }
+            },
+            {
+                "David": {
+                    "app_socket": ["localhost", 8871],
+                    "qnodeos_socket": ["localhost", 8872],
+                    "vnode_socket": ["localhost", 8873]
+                }
+            }
+        ],
+        "topology": null
+    }
+]

examples/new-sdk/template-quantum-local/simulaqron_settings.json

@@ -0,0 +1,14 @@
+{
+    "max_qubits": 20,
+    "max_registers": 1000,
+    "conn_retry_time": 0.5,
+    "conn_max_retries": 10,
+    "recv_timeout": 100,
+    "recv_retry_time": 0.1,
+    "recv_max_retries": 10,
+    "log_level": 30,
+    "sim_backend": "projectq",
+    "noisy_qubits": false,
+    "max_app_waiting_time": -1.0,
+    "t1": 1.0
+}

examples/new-sdk/template-quantum-local/terminate.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+TEST_PIDS=$(ps aux | grep python | grep -E "Test" | awk {'print $2'})
+if [ "$TEST_PIDS" != "" ]
+then
+        kill -9 $TEST_PIDS
+fi
+
+# Check if SimulaQron is running
+if [ -f ~/.simulaqron_pids/simulaqron_network_default.pid ]; then
+    if ! simulaqron stop
+    then
+        # Kill the process, only if simulaqron could not be stopped gracefully
+        cat $HOME/.simulaqron_pids/simulaqron_network_default.pid | xargs kill -9
+    fi
+fi
+

simulaqron/sdk/protocol.py

@@ -62,6 +62,18 @@ async def connected_handler(reader: StreamReader, writer: StreamWriter):
 
 class SimulaQronClassicalServer:
     def __init__(self, sockets_config: SocketsConfig, name: str):
+        """
+        Classical server used to server classical clients to remote nodes. The given socket configs
+        object contains the specification of the available nodes on the network that this server can
+        interact with. Please note that this configuration *does not limit* the clients that can
+        connect to this server.
+
+        :param sockets_config: The sockets configuration for the whole network.
+        :type sockets_config: SocketsConfig
+        :param name: The name of the server to connect to. The name *must* exist in the
+                     configuration file given when constructing this server.
+        :type name: str
+        """
         self._node_name = name
         self._sockets_data = sockets_config.hostDict[self._node_name]
         self._connection_handler: Optional[Callable[[StreamReader, StreamWriter], Awaitable[None]]] = None