1.3. Executing Your First Virtual Prototype

Now that we created our first virtual prototype we can execute it.

For this we make use of the SimBricks CLI, i.e. the simbricks-cli package. This package provides a command-line interface for managing SimBricks virtual prototypes. It is ideal when working in a terminal environment if a lightweight way to interact with the SimBricks Backend is needed.

In our case we can use it to send the virtual prototype we just created to the SimBricks Backend for execution. For this we save our virtual prototype script in a file called my-simple-experiment.py.

Then we submit the script to the Backend and follow its execution. In case of success you should see output like the following (the run id and exact paths on the Runner will differ):

$ simbricks-cli runs submit --follow my-simple-experiment.py
                      Run
  ┏━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
  ┃ id ┃ instantiation_id ┃ state            ┃
  ┡━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
  │ 10 │ 10               │ RunState.PENDING │
  └────┴──────────────────┴──────────────────┘
  [host.QemuSim-25] Formatting '/wrk/run-10-767b3eb9-f93f-495a-80ee-d9754981d7aa/tmp/imgs/2_hdcopy.qcow2', fmt=qcow2 cluster_size=65536 extended_l2=off compression_type=zlib size=42949672960
  backing_file=/global_input/images/base/base backing_fmt=qcow2 lazy_refcounts=off refcount_bits=16
  [host.QemuSim-25] prepare command exited with code 0
  [host.QemuSim-26] Formatting '/wrk/run-10-767b3eb9-f93f-495a-80ee-d9754981d7aa/tmp/imgs/10_hdcopy.qcow2', fmt=qcow2 cluster_size=65536 extended_l2=off compression_type=zlib size=42949672960
  backing_file=/global_input/images/base/base backing_fmt=qcow2 lazy_refcounts=off refcount_bits=16
  [host.QemuSim-26] prepare command exited with code 0
  [net.SwitchNet-29] Switch connecting to: /wrk/run-10-767b3eb9-f93f-495a-80ee-d9754981d7aa/tmp/shm/eth-5.21.20
  [net.SwitchNet-29] Switch connecting to: /wrk/run-10-767b3eb9-f93f-495a-80ee-d9754981d7aa/tmp/shm/eth-13.23.22
  [host.QemuSim-25] qemu-system-x86_64: warning: host doesn't support requested feature: CPUID.07H:EBX.hle [bit 4]
  ...

With that you executed your first SimBricks virtual prototype.

Hint

When executing the command above you might be prompted to authenticate yourself:

Please visit https://auth.simbricks.io/realms/SimBricks/device in the browser
There, enter the code: GZPU-FEAP
Waiting...

In that case visit the given link and enter the code above.

Tip

Instead of the CLI you can also submit and follow runs programmatically through the Client Library — see Running Virtual Prototypes for an example, and the prog-api-demo directory in the examples repository for a complete workflow including result plotting.