perl_d
910b11947e
Check and Lint / Rustfmt (pull_request) Successful in 22s
Check and Lint / Check (pull_request) Successful in 30s
Check and Lint / Build RPM (pull_request) Successful in 22s
Check and Lint / Clippy (pull_request) Successful in 32s
Test and Coverage / Test (pull_request) Successful in 25s
Check and Lint / Check (push) Successful in 21s
Check and Lint / Rustfmt (push) Successful in 16s
Check and Lint / Clippy (push) Successful in 22s
Check and Lint / Build RPM (push) Successful in 21s
Test and Coverage / Coverage (pull_request) Failing after 3m41s
Release / Build and push RPM (push) Successful in 2m38s
Test and Coverage / Test (push) Failing after 14m43s
Test and Coverage / Coverage (push) Failing after 3m13s
47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
# aare_launcher
|
|
|
|
[](https://gitea.psi.ch/perl_d/aare_launcher/actions?workflow=check-and-lint.yaml)
|
|
[](https://gitea.psi.ch/perl_d/aare_launcher/actions?workflow=test-and-coverage.yaml)
|
|
[](LICENSE)
|
|
|
|
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.
|
|
|
|
[aaredaq]: https://gitea.psi.ch/mx/aaredaq
|
|
[aarecommon]: https://gitea.psi.ch/mx/aarecommon
|