Skip to content

Commit 4db79df

Browse files
committed
some intro
1 parent 6641979 commit 4db79df

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

docs/guis/betabeat/beam_selection.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
# The beam selection Window
1+
# The Beam Selection Window
2+
3+
<figure>
4+
<img src="../../assets/images/betabeat_gui/beam_selection.png" width="100%" />
5+
<figcaption>The Beam Selection Window.</figcaption>
6+
</figure>
7+
8+
The Beam Selection Window is your entry point to the GUI.
9+
Here, you set which machine you will be using and which `python` backend to run.
10+
The options chosen here will also define the **folder-structure** you will be using during your current analysis session.
211

312
!!! tip "Setting Your Defaults"
413
You can set all entries in this window to your preferred defaults for a quick start!
514
Check the [Defaults Page](defaults.md) for more details.
615

7-
!!! todo
8-
Include screenshot of Beam-Selection Window and describe the settings.
16+
## Beam
17+
18+
## Output
919

10-
### Python
20+
## Input
21+
22+
## Python Executable
1123

1224
In the Beam-Selection Window you need to give it a python-binary (e.g. `venv/bin/python`).
1325
Best would be if you have a local virtual environment.
@@ -20,4 +32,3 @@ This is because python calls are now made by module, i.e.:
2032
```bash
2133
python -m omc3.module arg1 arg2 ...
2234
```
23-

docs/guis/betabeat/defaults.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ consoleLogging=False # activate additional logging (visible if started from t
3838
checkFreeSpace=False # check fee space at GUI start (visible if started from terminal)
3939

4040
# BPM-Panel
41-
runOptics=False # set the tickbox next to the `Analyse` button
41+
runOptics=False # set the tickbox next to the `Run Analysis` button
4242

4343
# Analysis-Panel
44-
autoclean.limit=0.1 # set the autoclean limit
45-
clean.sigmas=2 # set the number of sigmas for the autoclean
44+
autoclean.limit=0.1 # keep points within this limit, even if they are outliers
45+
clean.sigmas=2 # remove points beyond this many sigmas from the mean
4646
clean.bounds=0.7 # this ratio of points needs to remain otherwise cleaning aborts
4747

4848
# Amplitude-Detuning-Window
4949
ampdet.tunecut=0.05 # limit around the given tune to exclude from the BBQ tune
5050
ampdet.window=100 # length of the moving average window for the BBQ tune
51-
ampdet.outlierLimit=0.0002 # Cut on outliears around the mean
51+
ampdet.outlierLimit=0.0002 # Cut on outliers around the mean
5252
ampdet.usePreviousBBQ=False # Use previously extraced BBQ data if present
5353
```
5454

0 commit comments

Comments
 (0)