usov_i-org/bec
1
0
Fork 0
mirror of https://github.com/ivan-usov-org/bec.git synced 2025-04-22 02:20:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update outdated yaml for simulated gauss in user section

Browse Source
This commit is contained in:
appel_c 2024-10-07 10:09:17 +02:00
parent 5196e8eaca
commit eb84c67324
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/source/user/devices.md
View File

@ -33,7 +33,7 @@ bec.config.save_current_session("./config_saved.yaml")
which will save a file `config_saved.yaml` in the directory in which the client is running. which will save a file `config_saved.yaml` in the directory in which the client is running.
To modify and add a new device to the config, open `config_saved.yaml` with a suitable editor, for instance *VSCode*, and add a new device to the device config. To modify and add a new device to the config, open `config_saved.yaml` with a suitable editor, for instance *VSCode*, and add a new device to the device config.
For this, you may use the device gauss_bpm which is shown below. For this, you may use the device gauss_bpm which is shown below.
For more information about fields within the device config, you can check out the section [Ophyd](#developer.ophyd) in our developer guide.
``` {code-block} yaml ``` {code-block} yaml
--- ---
name: user.devices.add_gauss_bpm name: user.devices.add_gauss_bpm
@ -41,16 +41,21 @@ name: user.devices.add_gauss_bpm
gauss_bpm: gauss_bpm:
readoutPriority: monitored readoutPriority: monitored
deviceClass: sim:sim:SynGaussBEC deviceClass: ophyd_devices.sim.sim_monitor.SimMonitor
deviceConfig: deviceConfig:
sigma: 1 sim_init:
noise: 'uniform' model: GaussianModel
noise_multiplier: 0.4 params:
amplitude: 500
center: 0
sigma: 1
deviceTags: deviceTags:
- beamline - beamline
enabled: true enabled: true
readOnly: False readOnly: false
softwareTrigger: true
``` ```
For more information about various topics linked to Ophyd and the simulation, please also check our developer section of the documentation. In particular, [Ophyd](#developer.ophyd), the [Ophyd device configuration](#developer.ophyd_device_config) and the [simulation framework](#developer.bec_sim).
### Upload a new device config ### Upload a new device config
From the client, you can now run the follow command to update the session with a new device config file. From the client, you can now run the follow command to update the session with a new device config file.