Plan for Visualizer project

[BECATRUE]

(Updated)

I wrote this for discussing about the plan for Visualizer project.
Feel free to leave your opinion!

Summary

The project covers the code viewer and the sequence viewer.
Two viewers will be included a new app, visualizer.

Goal

Visualizer app

• Similar to the explorer app, there is a tree widget to show the list of completed experiments.
  (Exactly, completed and checked to show.)
• Once an user clicks an experiment, two viewers would open.

Code viewer

• Show the experiment code as it is with each line number.

Sequence viewer

• Similar to the current sequence visualizer in QuIQCL.
• Show whether each device is on or off in series.
• This is not a simulation, but a real result after the experiment is done.

Scenario

1. Submit an experiment to the proxy server.
2. In the proxy server, the experiment file is copied and modified to add several codes, e.g., marking logs and generating a vcd file.
3. The proxy server has an DB with the original codes and vcd files.
4. When the visualzer app requests the code and vcd file, the server would return them.
5. Using them, show two viewers.

Implement

Code viewer

1. Just a QListView for indicating each line number.

Sequence viewer

1. Using pyvcd, decode the vcd file.
2. Show the viewer as QTableWidget.

[BECATRUE]

@kangz12345 Please change the visiblity of this project to public!

[BECATRUE]

@kangz12345 I ran into a problem.

As we discussed, to submit the experiment with rtio_log(), it should be modifed using ast in the builder app.
So it looks better to show the code viewer using ast in the builder app, not the visualizer app.

However, we can only get the vcd file after the experiment is done, and the sequence(block) viewer cannot be shown in the builder app.
Then, the code viewer must be created twice in spite of the inefficiency.

[BECATRUE]

Nevertheless, if it is okay to parse the code twice, never mind!
But, I think we should determine the direction of this problem first.

[kangz12345]

You can use the qiwis broadcast system or file system to communicate between apps.
For example: Show code viewer in the builder app, and communicate with the visualizer app.

By the way, how will you modify the code? As far as I understand, the code is in the miniPC (artiq master). Are you going to use artiq-proxy?

[BECATRUE]

For example: Show code viewer in the builder app, and communicate with the visualizer app.

I will reconsider this method😃

[BECATRUE]

By the way, how will you modify the code? As far as I understand, the code is in the miniPC (artiq master). Are you going to use artiq-proxy?

Yes! I plan to use the proxy server. I will let you know the details at the project meeting tomorrow.

[kangz12345]

Good!

[BECATRUE]

I updated this plan! @kangz12345

[BECATRUE]

I found an amazing Python library, QScintilla, which shows the code like an editor!
How about using this package? I searched several PyQt code viewer package, but it looks best.

[kangz12345]

It looks good! You can consider using it for this project.