|
1 | 1 | # Defaults |
2 | 2 |
|
3 | | -## Beam Selection Defaults |
| 3 | +Defaults can be set by a file named `bbgui_user.properties` (with the above syntax) in either the **current working directory** (from where you run the GUI), or in **your home folder**. |
| 4 | +The latter is only used if there is no such file in the current working directory. |
4 | 5 |
|
5 | | -(For details see the [Beam Selection](beam_selection.md) page) |
| 6 | +If you want to use a specific file named anything and located anywhere, you can also **give the path to this file as the first and only argument** when starting the GUI. |
| 7 | +It is also possible to set each of these default values by passing them as flag arguments to the GUI call, e.g: |
| 8 | + |
| 9 | +```bash |
| 10 | +--beam LHCB1 --inputPath /some/afs/location/with/your/data/ |
| 11 | +``` |
| 12 | + |
| 13 | +## Beam Selection Defaults |
6 | 14 |
|
7 | 15 | The GUI defaults to specific locations for which `python` binary to use, the input path of you data, etc. |
8 | 16 | Different key-value pairs can be set inside for the desired defaults, for example: |
9 | 17 |
|
10 | | -```bash |
11 | | -beam = LHCB1 |
| 18 | +```ini |
| 19 | +beam = LHCB2 |
12 | 20 | inputPath = /some/afs/location/with/your/data/ |
13 | 21 | outputPath = /some/afs/location/with/your/results/ |
14 | 22 | pythonPath = /some/afs/location/with/your/python-env/bin/python |
15 | | -loadData=False # True: Load already existing data in the outputPath into the GUI |
16 | | -oldFolderStructure=False # True: Put `models` folder at top level instead of the current machine folder (BBS legacy) |
| 23 | +loadData=False # Load already existing data in the outputPath into the GUI |
| 24 | +oldFolderStructure=False # Put `models` folder at top level (BBS legacy) |
17 | 25 | ``` |
18 | | -These values can be set by a file named `bbgui_user.properties` (with the above syntax) in either the **current working directory** (from where you run the GUI), or in **your home folder**. |
19 | | -The latter is only used if there is no such file in the current working directory. |
20 | | - |
21 | | -If you want to use a specific file located anywhere, you can also give the path to this file as the first and only argument when starting the GUI. |
22 | | -It is also possible to set each of these default values by passing them as flag arguments to the GUI call, e.g: |
23 | 26 |
|
24 | | -``` |
25 | | ---beam LHCB1 --inputPath /some/afs/location/with/your/data/ |
26 | | -``` |
| 27 | +For details see the [Beam Selection](beam_selection.md) page. |
27 | 28 |
|
28 | 29 | ## Additional GUI Defaults |
29 | 30 |
|
30 | 31 | Additionally, there are some GUI settings that can either only be set via arguments or |
31 | | -modify the default value in the GUI: |
| 32 | +modify/set the default value in the GUI fields: |
32 | 33 |
|
33 | | -```bash |
34 | | -consoleLogging=True # activate additional logging into the terminal (only visible if started from terminal) |
35 | | -checkFreeSpace=True # check fee space at GUI start (only visible if started from terminal) |
| 34 | +```ini |
| 35 | +consoleLogging=False # activate additional logging (visible if started from terminal) |
| 36 | +checkFreeSpace=False # check fee space at GUI start (visible if started from terminal) |
36 | 37 |
|
37 | 38 | # BPM-Panel |
38 | | -runOptics=True # set the tickbox next to the `Analyse` button to also run the optics analysis by default |
| 39 | +runOptics=False # set the tickbox next to the `Analyse` button |
39 | 40 |
|
40 | 41 | # Analysis-Panel |
41 | | -autoclean.limit=0.1 # set the autoclean limit |
42 | | -clean.sigmas=2 # set the number of sigmas for the autoclean |
43 | | -clean.bounds=0.7 # when cleaning, this ratio needs to remain otherwise the cleaning is aborted |
44 | | - |
45 | | -# Amplitude-Detuning-Window |
46 | | -ampdet.tunecut=0.05 # limit around the given tune to exclude from the natural tune when fitting |
47 | | -ampdet.window=100 # length of the moving average window for the natural tune |
48 | | -ampdet.outlierLimit=0.0002 # Cut on outliears around the mean |
49 | | -ampdet.usePreviousBBQ=True # Do not extract BBQ data if there is already data present |
| 42 | +autoclean.limit=0.1 # set the autoclean limit |
| 43 | +clean.sigmas=2 # set the number of sigmas for the autoclean |
| 44 | +clean.bounds=0.7 # this ratio of points needs to remain otherwise cleaning aborts |
| 45 | + |
| 46 | +# Amplitude-Detuning-Window |
| 47 | +ampdet.tunecut=0.05 # limit around the given tune to exclude from the BBQ tune |
| 48 | +ampdet.window=100 # length of the moving average window for the BBQ tune |
| 49 | +ampdet.outlierLimit=0.0002 # Cut on outliears around the mean |
| 50 | +ampdet.usePreviousBBQ=False # Use previously extraced BBQ data if present |
50 | 51 | ``` |
51 | 52 |
|
52 | 53 | For more details about these functions see the [BPM-Panel](bpm_panel.md), [Analysis-Panel](analysis_panel.md) and [Amplitude-Detuning](ampdet.md) pages. |
53 | 54 |
|
54 | 55 | ## Default Settings |
55 | 56 |
|
56 | | -(For details see the [Settings](settings.md) page) |
57 | | - |
58 | 57 | When saving the GUI settings, a similar file `settings_xxx.properties` is created. |
59 | | -Instead of loading these settings manually, you can also copy all or a selection of these settings |
60 | | -from the output file into the `bbgui_user.properties` and they will be set automatically when the GUI is started. |
| 58 | +Instead of loading these settings manually, you can also copy all or a selection of the entries |
| 59 | +from the output file into your `bbgui_user.properties` and they will be set automatically when the GUI is started. |
| 60 | + |
| 61 | +For details see the [Settings](settings.md) page. |
0 commit comments