How to use Qibocal?#
In this section we present the different commands implemented in
qibocal and how to use them.
qibocal. It can be launched from the command line using:
<path_to_runcard> is the relative path to runcard, a yaml file containing all the instructions
required to execute
xyz are three integers starting from
username is the name of the user that
is launching the job on the QRC cluster. If a folder with the same name already exists the program will try to create folder where the combination
is incremented by 1, until a new folder is created.
There is also the option to specify the name of the output folder through the
qq <path_to_runcard> -o <output_folder>
It is possible to overwrite an existing folder using the option
Inside the folder generated by
platform.yml: a yaml containing the platform runcard used at the beginning of the calibration;
new_platform.yml: a yaml containing the updated platform runcard after running the calibration routines specified in the runcard;
runcard.yml: a copy of the runcard provided when executing
index.html: web page where reports are displayed;
data: folder containing all the results divided by routines.
qq-live is the command dedicated to live-plotting. It can be launched from the command line using:
qq-live will start a flask server in local mode. By opening the correspoding web page you will see
a list with all the folders generated by
qq-live is executed.
If you select one of them you will see the page generated by
If you are opening an output folder which is currently being generated by
You can directly select the port to serve the application using the
For example in order to start the server on the port 8055 you can type.
qq-live -p 8055
It is possible to start the flask server in debug mode using the option
The following picture shows an example of the generated web page:
qq-upload it is possible to upload the output folder generated by
In the web page it is possible to visualize all reports uploaded by other users.