Guidelines for Beginners

[BECATRUE]

This is a simple guideline for beginners.
If you have any questions, feel free to leave it😃

What is artiq-proxy?

It is a proxy server between client (currently for iquip) and artiq system.
It offers a server based on HTTP protocol using fastapi.

How to install artiq-proxy

1. Install ARTIQ

For this server, first of all you should install ARTIQ.
In my experience, I strongly recommend using conda system unless you are familiar with nix system.
And running it on Linux is better (but not compulsory) because the artiq PC also runs on Linux.

After installing it, extract examples.zip and run the master server in the extracted directory (the same level as device_db.py).

$ artiq_master

Create another terminal and enter the following command.

$ artiq_client submit repository/simple_simulation.py

If no problem, the master terminal will show the result and the client one will print the rid number.

2. Clone this repo to your local.

$ git clone ${url}

To make your own branch for development, please checkout from develop branch.

How to run the server

First, please modify master_path in config.json to your appropriate directory.
It should indicate the extracted directory.

Second, enter the below command.

./server.sh

Before this step, several external package should be installed such as fastapi and uvicorn.
Please refer the documentation.

If you want to run the server in the background, you can probabilty use some commands such as nohup.
However, we cannot guarantee its stability.

To check if the server runs well, open your browser and access the following url:

http://127.0.0.1:8000/experiment/info/?file=build_simulation.py

It will return several infomations about the experiment file.

[Aijuh]

I am not sure where to put questions. If this place is not for an additional question, I will make another discussion session.
I followed FastAPI tutorial for the ARTIQ, but cannot figure out how to install ARTIQ.
If I install fastapi and uvicorn, then ARTIQ automatically available?

[BECATRUE]

Oh, I'm sorry seriously😥 I put the wrong link..

I modified it and the correct link is here.
Also, you can write any questions in this place just like you did!