FIREQ-Client

FIREQ-Client is the Python client-side component of the FIREQ platform.

It provides the user-facing interface used to configure, launch, and monitor FIREQ experiments through the FIREQ-Server.

Role in FIREQ

FIREQ is organized into three main repositories:

• FIREQ-Client: Python client interface.
• FIREQ-Server: Python server and control layer.
• FIREQ: HDL firmware for RFSoC 4x2 and ZCU216 board.

This repository contains the client-side software used to interact with the FIREQ platform.

Documentation

The complete FIREQ documentation is available at:

https://vlsi-nanocomputing.github.io/FIREQ-docs/

Client-specific documentation is maintained in this repository under:

docs/

The central FIREQ documentation site automatically imports the content of this directory and publishes it together with the documentation of the server and firmware repositories.

Repository structure

FIREQ-Client/
├── FIREQ_CLIENT/                                    Python client package
├── FIREQ_PLOTTER/                                   Plotting utilities and REPL
├── yaml_experiment_configurations_examples/         Example experiment YAML configurations
├── testing/                                         Test scripts
├── docs/                                            Client-specific documentation
├── run_client.py                                    Minimal client entry point
├── run_plotter.py                                   Plotter entry point
├── requirements.txt                                 Python dependencies
└── README.md

Getting started

Clone the repository:

git clone https://github.com/vlsi-nanocomputing/FIREQ-Client.git
cd FIREQ-Client

Create a Python virtual environment:

python -m venv .venv

Activate the virtual environment:

source .venv/bin/activate

On Windows PowerShell:

.venv\Scripts\Activate.ps1

Upgrade pip inside the virtual environment:

python -m pip install --upgrade pip

Install the required dependencies:

python -m pip install -r requirements.txt

Quick start

A minimal client execution can be started with:

python run_client.py

Example experiment YAML configurations are available in:

yaml_experiment_configurations_examples/

Contributing and Support

Contributions to FIREQ-Client are welcome.

You can contribute by:

• improving the client implementation;
• adding or updating examples in yaml_experiment_configurations_examples/;
• improving the documentation in docs/;
• reporting bugs or unexpected behavior;
• suggesting new features or use cases.

If you find a problem, please open an issue on GitHub:

https://github.com/vlsi-nanocomputing/FIREQ-Client/issues

If you have questions, ideas, or need support, feel free to create a discussion or open an issue on GitHub.

Client-specific documentation should be updated in:

docs/

The central documentation site automatically imports the content of this repository's docs/ directory and publishes it together with the documentation of the server and firmware repositories.