1+ # Description
12
23In this example, we have only two nodes: Alice and Bob.
34
@@ -10,3 +11,49 @@ Bob proceeds to recover the teleported qubit.
1011
1112In this example, we simply print out the initial state to be teleported, as well as the final state received by
1213Bob to check whether the teleportation worked correctly.
14+
15+
16+ # How to run
17+
18+ To run this example, first make sure that the python virtual environment is activated. You can easily check this
19+ with the terminal command prompt, which shows the active python virtual environment in parentheses:
20+ ```
21+ (simulaqron) user@machine_name:~$
22+ ```
23+ If you don't see the name of the virtual environment, please check the SimulaQron README file to know how to
24+ create and activate it.
25+
26+ Once the environment is active, we need to start the simulaqron network:
27+ ```bash
28+ siumulaqron start --nodes Alice,Bob
29+ ```
30+
31+ This will read the JSON configuration files and start the SimulaQron virtual nodes for nodes `Alice` and `Bob`.
32+
33+ After this, you can simply run the example by using the `run` script:
34+ ```bash
35+ ./run.sh
36+ ```
37+
38+ # How to stop the execution in case the test execution stalls.
39+
40+ To fully stop the execution, you can use the `doNew` script. This will stop the current execution and run the
41+ example once again:
42+ ```bash
43+ ./doNew.sh
44+ ```
45+
46+
47+ # Troubleshooting
48+
49+ ## Trying to start the network gives "Network with name <name> is already running" message
50+
51+ This usually happens when you stopped the network "manually" by killing processes (`kill -9`). If this happens,
52+ please make sure that you kill all related processes (use `ps aux | grep python` to search) and then delete the
53+ PID file for the running network. This file is located in `~/simulaqron_pids` and it is called
54+ `simulaqron_network_<network_name>.pid`:
55+ ```bash
56+ rm ~/simulaqron_pids/simulaqron_network_<network_name>.pid
57+ ```
58+
59+ After this, you can try to start the network again
0 commit comments