Plan for Basic Runner project

[BECATRUE]

I wrote this for discussing about the plan for Basic Runner project.

Summary

Basic experiment runner GUI project, which includes the experiment explorer and builder.

Goal

Experiment explorer

• Show the directory structure where artiq_master is running.
• Able to reload the directory structure. (It may be updated during operation)
• Open the experiment builder once an experiment clicked.

Experiment builder

• Able to submit the experiment to the scheduler.
• Able to edit the build params.

Implement

Experiment explorer

1. Show the directory structure viewer using PyQt package.
2. Add a button to reload the structure.

Experiment builder

1. Add a button to submit the experiment.
2. Add several controllers to update the build params.

[BECATRUE]

In this project, we will not implement all functions of the explorer and builder yet.
For example, editing the schedule options, scan params, etc. are not in this, but the later project.

Nevertheless, if there is a function that you think is necessary or needs to be improved, please feel free to leave your opinion.

[BECATRUE]

Before I started this project, I found out several questions.
Originally, I wrote them in the Obsidian, but as we discussed in #12, I move them in GitHub.

Experiment explorer

1. How to get the location where artiq_master is running.
   • If we want to know the specific directory structure, use artiq_client ls [directory].
   • However, we can't know the location where artiq_master is running with the command line.
     It can only be implemented with sipyco and convoluted codes, not only the command line.
2. How to check and get the experiment class from a file.
   • It is not necessary because our interest is an experiment file, not an experiment class and artiq_client submit FILE needs a file path.
3. What are the limitations/default options in terms of the file structure?
   • Refer to artiq_master
     • device database file (default: "device_db.py"): --device-db
     • dataset file (default: "dataset_db.pyo"): --dataset-db
     • path to the repository (default: "repository"): -r, --repository
     • path to the experiment foler from the repository root (default: ""): --experiment-subdir
   • First of all, use only the default options and cannot modify them, yet.

Experiment builder

TBC

[BECATRUE]

I make a note about functions not yet planned or assigned.

• In the explorer, able to modify the artiq_master options, such as device database file.
• In the experiment builder, able to edit the schedule options, scan params, etc.