QIBO Server On Qick (qibosoq) is the server component of qibolab to be run on RFSoC boards
Project description
Qibosoq
Repository for developing server side of RFSoC fpga boards Qibosoq is a server for integrating Qick in the Qibolab ecosystem for executing arbitrary pulses sequences on QPUs.
The complete documentation for can be found at qibo.science/qibosoq/stable
Installation
The package can be installed by source:
git clone https://github.com/qiboteam/qibosoq.git
cd qibosoq
pip install .
Developer instructions
For development make sure to install the package using poetry
and to install the pre-commit hooks:
git clone https://github.com/qiboteam/qibosoq.git
cd qibosoq
poetry install
pre-commit install
Configuration parameters
In configuration.py
some default qibosoq parameters are hardcoded. They can be changed using environment variables (see documentation).
- IP of the server
- Port of the server
- Paths of log files
- Name of python loggers
- Path of bitstream
- Type of readout (multiplexed or not, depending on the loaded bitstream)
Run the server
The simplest way of executing the server is:
sudo -E python -m qibosoq
and the server can be closed with Ctrl-C
.
Note that with this command the script will close as soon as the terminal where it's running it's closed.
To run the server in detached mode you can use:
nohup sudo -E python -m qibosoq &
And the server can be closed with sudo kill <PID>
(PID will be saved in log).
TII boards
With TII boards the server can also be executed using the alias server-run-bkg
.
Also, two additional command are added in .bashrc
: serverinfo
and serverclose
.
serverinfo
will print the PID if the server is running, otherwise will print "No running server".
serverclose
will close the server, if it is running.
All these commands require sudo privileges.
Contributing
Contributions, issues and feature requests are welcome!
Feel free to check
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.