aare_launcher/README.md

aare_launcher

CLI/TUI launcher for the AareDAQ server and GUI on MX beamline consoles at PSI.

Installed as the aarel command. It detects the current beamline and launches the matching application, opens a TUI to pick one, or deploys a new checkout.

Usage

aarel pick          # open the TUI to choose what to launch
aarel gui           # launch the GUI for the detected beamline
aarel server        # launch the server for the detected beamline
aarel deploy <name> # clone the repos and install them into a new virtualenv

Each command has a single-letter alias (p, g, s, d). --config <path> selects a different config file; it defaults to data/defaults.json.

Launching

gui and server pick their config entry from the detected beamline. Use --entry <name> to launch a different one.

Deploying

deploy <name> clones aaredaq and aarecommon into <apps_base>/<name>, then installs both editable into a fresh uv virtualenv at <venvs_base>/<name>. It requires git and uv on the PATH.

Flag	Effect
--upgrade	Update an existing deployment (git pull + reinstall) instead of refusing to overwrite it.
--force	Deploy a production name from a machine on another beamline.

The production names x06da, x06sa and x10sa may only be deployed from their own beamline's machines. Any other name is a test or development deployment and can be deployed anywhere. This is a guard against mistakes, not a security boundary, and --force bypasses it.