From c24e1d23d3cac441e2fa1dcc51d09663352ec972 Mon Sep 17 00:00:00 2001 From: Benjamin Labrecque Date: Tue, 30 Jun 2026 15:53:13 +0200 Subject: [PATCH] docs: extract docs to docs/ --- README.md | 42 ------------------------------------------ docs/hla.md | 17 +++++++++++++++++ docs/ioc.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 42 deletions(-) create mode 100644 docs/hla.md create mode 100644 docs/ioc.md diff --git a/README.md b/README.md index 4fe57bd..9cf9a0a 100644 --- a/README.md +++ b/README.md @@ -19,45 +19,3 @@ ping sls-lca.psi.ch - sls-lc9 - sls-vserv-bd-01-dev - sls-vserv-bd-hla01-dev - -## IOCs - -Start up an IOC shell: - -```shell -iocsh AGEBD-CPCL-MASTER_main.subs -``` - -then you can run commands to interact with EPICS. - -List available PVs: - -```shell -> dbl -``` - -### Install - -On `sls-lc*` - -```shell -ioc install -V --ioc AGEBD-CPCL-TUNEFBX –clean -``` - -Result: on ioc host, e.g. `sls-vserv-bd-01-dev` - -```shell -vim /etc/shellbox/ -``` - -## TODOS / Notes (to be removed/moved) - - Had to manually do - - ``` - pip install uv - ``` - - on `sls-vserv-bd-hla01-dev` - - which installs in `~/.local/bin/uv` diff --git a/docs/hla.md b/docs/hla.md new file mode 100644 index 0000000..a8b3050 --- /dev/null +++ b/docs/hla.md @@ -0,0 +1,17 @@ +# HLA - High Level Application + +## Hosts + +sls-vserv-bd-hla01(-dev) + +## Setup + +Had to manually do + + ``` + pip install uv + ``` + + on `sls-vserv-bd-hla01-dev` + + which installs in `~/.local/bin/uv` diff --git a/docs/ioc.md b/docs/ioc.md new file mode 100644 index 0000000..747745b --- /dev/null +++ b/docs/ioc.md @@ -0,0 +1,35 @@ +# IOC + +## Host + +sls-vserv-bd-01(-dev) + +## Shell + +Start up an IOC shell: + +```shell +iocsh AGEBD-CPCL-MASTER_main.subs +``` + +then you can run commands to interact with EPICS. + +List available PVs: + +```shell +> dbl +``` + +## Install + +On `sls-lc*` + +```shell +ioc install -V --ioc AGEBD-CPCL-TUNEFBX –clean +``` + +Result: on ioc host, e.g. `sls-vserv-bd-01-dev` + +```shell +vim /etc/shellbox/ +```