From b2bb7064d8d7f274b6c451dcaeb26f41660f6629 Mon Sep 17 00:00:00 2001
From: e20639 <e20639@x12sa-comp-1.psi.ch>
Date: Wed, 13 Sep 2023 17:12:27 +0200
Subject: [PATCH] fix: update readme documentation

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 42 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 633daa2..00f0a12 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,8 @@ You might want to run cSAXS copy scripts before in case you want to have the for
 3. Start Epics iocs 
 4. Start BEC, BEC server and load/modify the device config with relevant hardware
 5. BEC commands
-6. Troubleshooting and common problems
+6. Start BEC widgets (GUI for motor control, eiger live plot)
+7. Troubleshooting and common problems
 
 ## 1. Clone cSAXS BEC repository
 
@@ -67,6 +68,8 @@ ssh gac-x12sa@localhost
 cd ~/Software/Eiger/
 ./launch_ioc
 ```
+A live view of status and images for std_daq can be found here [xbl-daq-29:5000](xbl-daq-29:5000).
+
 ### Pilatus_2
 
 First, start the cam server. 
@@ -104,13 +107,23 @@ tmux attach -t bec
 
 Open another teminal on pc15543 and start BEC:
 ``` bash
+cd ~/Data10/software
+source bec_venv/bin/activate
 bec
 ```
 
+Note: In case there is a warning after starting BEC that it was not able to import *scilog*, you will have to pip install scilog in the bec_venv to be able to send printouts to scilog from the command line.
+Within a new terminal:
+```bash
+cd ~/Data10/software
+source bec_venv/bin/activate
+pip install scilog
+```
+
 Device config from csaxs-bec plugins
 ```bash
 bec.config.update_session_with_file('/sls/X12SA/data/e20639/Data10/software/csaxs-bec/bec_plugins/configs/bec_device_config_sastt.yaml')
-bec.config.save_current_session('~/Data10/software/current_config')
+bec.config.save_current_session('~/Data10/software/current_config.yaml')
 ```
 The second command is helpful if you adjust limits of motors, which will then be stored in the config and loaded if a reload of the configuration is needed.
 
@@ -134,7 +147,33 @@ scans.line_scan(dev.samx, -1, 1, dev.samy, -1, 1, steps=20, exp_time=0.5, readou
 scans.sgalil_grid(start_y = , end_y = , interval_y = , start_x=, end_x=, interval_x =, exp_time=0.5, readout_time=3e-3, relative=True)
 ```
 
-## 6. Troubleshooting and common problems
+## 6. Start BEC widgets (GUI for motor control, eiger live plot)
+
+To start the BEC widgets, the first step is to make the bec_widgets_venv using the start startup script. 
+Follow the commands below:
+``` bash
+cd ~/Data10/software/csaxs-bec/bin
+./setup_bec_widgets.sh
+```
+Afterwards, activate the environment on either cons-01 comp-1/2
+``` bash
+cd ~/Data10/software/
+source activate bec_widgets_venv/bin/activate
+```
+Each Plot needs their own shell with activate environment
+
+1. Eiger Plot
+``` bash
+cd ~/Data10/software/bec-widgets/bec_widgets/examples/eiger_plot
+python eiger_plot.py
+```
+2. Motor Controller
+``` bash
+cd ~/Data10/software/bec-widgets/bec_widgets/examples/motor_movement
+python motor_example.py --config csaxs_config.yaml
+```
+
+## 7. Troubleshooting and common problems
 
 Sometimes the data backend for the Eiger gets stuck or misses frames, this will result in an error
 ``` python
@@ -146,5 +185,3 @@ This happens more likely after CTRL C of a scan. To recover from this more relia
 scans.acquire(exp_time=0.02, frames_per_trigger=100, readout_time= 3e-3)
 ```
 Afterwards, you should be good to continue with 2D gridscans.
-
-