Running ICON

ICON runs on Linux and requires Python 3 to start. The easiest way to start is by downloading the binary from the releases page. Make it executable and run it:

$ chmod +x icon-linux-amd64
$ ./icon-linux-amd64 --help
Usage: icon-linux-amd64 [OPTIONS]

  Start the ICON server

Options:
  -V, --version      Print version.
  -v, --verbose      Increase verbosity (-v, -vv)
  -q, --quiet        Decrease verbosity (-q)
  -c, --config FILE  Path to the configuration file [default: ~/.config/icon/config.yaml]
  -h, --help         Show this message and exit

If you prefer to run ICON from source, clone the repository and use uv as the dependency manager:

git clone https://github.com/tiqi-group/icon.git
cd icon
uv sync --extra server --extra zedboard
uv run python -m icon.server

Ionpulse

To be able to run experiments, ICON must connect to Ionpulse, the server application running on the control system such QuENCH RFSoC, QuENCH MicroTCA or M-ACTION. Configure the URL or IP and port under Settings -> Hardware.

Development

If you are testing/developing ICON without the control system, you can use the ionpulse emulator. See the Ionpulse sw test README for more info on how to set up the emulator.