You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guis/rdt_feeddown/correction.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ This part of the GUI allows you to quantify the RDT correction predicted from a
4
4
5
5
## The Tabs Explained
6
6
7
-
-[Graph](#__tabbed_1_1){.tab-link} tab: Displays the RDT feeddown data and the correction prediction graphically.
7
+
-[Graph](#__tabbed_1_1){.rdtfeeddown_tab-link} tab: Displays the RDT feeddown data and the correction prediction graphically.
8
8
9
-
-[Response](#__tabbed_1_2){.tab-link} tab (optional): Allows you to quantify the RDT shift predicted from a specific corrector.
9
+
-[Response](#__tabbed_1_2){.rdtfeeddown_tab-link} tab (_optional_): Allows you to quantify the RDT shift predicted from a specific corrector.
10
10
11
11
=== "Graph Tab"
12
12
@@ -19,11 +19,11 @@ This part of the GUI allows you to quantify the RDT correction predicted from a
19
19
20
20
**Main Features:**
21
21
22
-
- <span class="guilabel">Load Files</span>: Load the corrector response files generated by the [Response](#__tabbed_1_2){.tab-link} tab.
22
+
- <span class="rdtfeeddown_guilabel">Load Files</span>: Load the corrector response files generated by the [Response](#__tabbed_1_2){.rdtfeeddown_tab-link} tab.
23
23
24
-
- ``Analysis File to Match``: Select the output file from the [Input](input.md){.tab-link} tab that you want to match with the corrector response.
24
+
- ``Analysis File to Match``: Select the output file from the [Input](input.md){.rdtfeeddown_tab-link} tab that you want to match with the corrector response.
25
25
26
-
- <span class="guilabel" style="--guilabel-bg: #5C62D6;">Plot</span>: Plot the RDT data and the correction prediction. This will trigger a list of corrector knobs to be shown beneath the **Knob Manager** section. These will default to a value of 0. Values can be changed by entering a number and pressing <kbd>Enter</kbd> or clicking <span class="guilabel" style="--guilabel-bg: #5C62D6;">Update Knobs and Re-Plot</span>.
26
+
- <span class="rdtfeeddown_guilabel" style="--rdtfeeddown_guilabel-bg: #5C62D6;">Plot</span>: Plot the RDT data and the correction prediction. This will trigger a list of corrector knob names to be shown beneath the **Knob Manager** section. These will default to a value of 0. Values can be changed by entering a number and pressing <kbd>Enter</kbd> or clicking <span class="rdtfeeddown_guilabel" style="--rdtfeeddown_guilabel-bg: #5C62D6;">Update Knobs and Re-Plot</span>.
27
27
28
28
=== "Response Tab"
29
29
@@ -34,16 +34,19 @@ This part of the GUI allows you to quantify the RDT correction predicted from a
34
34
</center>
35
35
</figure>
36
36
37
-
Similar to the [Input](input.md){.tab-link} tab, this tab allows you to load measurement folders and reference data in the format outputted by the [OMC analysis tools](https://pylhc.github.io/packages/omc3/about.html) for results of measurements.
37
+
Similar to the [Input](input.md){.rdtfeeddown_tab-link} tab, this tab allows you to load measurement folders and reference data in the format outputted by the [OMC analysis tools](omc_homepage) to quantify the RDT response for a constant corrector strength between 2 different crossing angles.
- ``Reference Folder``: Select the reference measurement folder containing the measurement data with the corrector strength applied and the reference crossing angle.
42
45
43
46
- ``Response Folder``: Select the measurement folder containing the data with the <span class="warning-colored">same corrector strength</span> as the <span class="warning-colored">reference measurement</span> applied, and a <span class="warning-colored">different crossing angle</span> to the <span class="warning-colored">reference measurement</span>
44
-
!!! tip
45
-
Will need to input the difference in crossing angle!
46
47
47
48
- ``LHCB1 same as LHCB2 mode``: If this option is selected, the response will be calculated assuming that the corrector name is the same for both LHC beams. This is useful when the corrector name is not beam-specific.
48
49
49
-
- <span class="guilabel" style="--guilabel-bg: green;">Find Response</span>: This button will calculate the response of the RDT to the crossing angle with the corrector strength applied. The output will be in the format that can be used in the [Graph](#__tabbed_1_1){.tab-link} tab.
50
+
- <span class="rdtfeeddown_guilabel" style="--rdtfeeddown_guilabel-bg: green;">Find Response</span>: This button will calculate the response of the RDT to the crossing angle with the specified corrector strength applied. The output will be in the format that can be used in the [Graph](#__tabbed_1_1){.rdtfeeddown_tab-link} tab.
Copy file name to clipboardExpand all lines: docs/guis/rdt_feeddown/gui.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,16 @@ To launch and use the RDTfeeddown GUI, use the following command:
13
13
python -m pip install omc3
14
14
```
15
15
16
+
<imgsrc="../../assets/images/rdtfeeddown_gui/help.png"alt="Help Icon"width="20"> or <imgsrc="../../assets/images/rdtfeeddown_gui/help2.png"alt="Help Icon"width="20"> : shows some quick tips for using the GUI.
17
+
16
18
<imgsrc="../../assets/images/rdtfeeddown_gui/errorlog.png"alt="Error Log Icon"width="20"> : shows the error log for debugging.
17
19
18
-
!!! tip
20
+
!!! tip "Navigating Plots Tip"
19
21
To pan in any of the plots, use <kbd>Ctrl</kbd>+<kbd>LeftClick</kbd> and drag the mouse.
20
22
21
23
The following pages are available detailing the tabs and how to use them:
22
24
23
-
-[Input](input.md){.tab-link} tab: for how to input files to produce an analysable format.
24
-
-[Validation](validation.md){.tab-link} tab: for how to use that analysable format to plot the RDT response as a function of crossing angle amongst another analyses.
25
-
-[Correction](correction.md){.tab-link} tab: for how to quantify the response of RDT with a corrector across crossing angles and use that to match to the analysable format measurement.
25
+
-[Input](input.md){.rdtfeeddown_tab-link} tab: for how to input files to produce an analysable format.
26
+
-[Validation](validation.md){.rdtfeeddown_tab-link} tab: for how to use that analysable format to plot the RDT response as a function of crossing angle amongst another analyses.
27
+
-[Correction](correction.md){.rdtfeeddown_tab-link} tab: for how to quantify the response of RDT for a constant corrector powering, between two crossing angles (i.e. assuming linearity) and use that to match to the analysable format measurement.
Copy file name to clipboardExpand all lines: docs/guis/rdt_feeddown/input.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
</center>
8
8
</figure>
9
9
10
-
The [Input](input.md){.tab-link} tab (i.e. the landing page) of the GUI provides an interface to input data for the RDTfeeddown analysis.
10
+
The [Input](input.md){.rdtfeeddown_tab-link} tab (i.e. the landing page) of the GUI provides an interface to input data for the RDTfeeddown analysis.
11
11
12
12
You can load measurement folders, reference data, and crossing angle knob data directly through the GUI.
13
13
@@ -33,18 +33,22 @@ You can provide input to the RDTfeeddown GUI using the following methods:
33
33
1.``File Input``: Load input files by clicking the relevant button in the GUI and selecting the appropriate file.
34
34
2.``Manual Input``: Manually enter file paths in the provided fields within the GUI (except for measurement folders).
35
35
36
-
!!! warning
37
-
All folder inputs should be in the form used for the results of measurements in the [OMC analysis tools](https://pylhc.github.io/packages/omc3/about.html).
36
+
!!! warning "Input Format Warning"
37
+
All folder inputs should be in the form used for the results directory of measurements in the [OMC analysis tools](omc_homepage).
38
38
39
39
## Input Fields Explained
40
40
41
-
-``Model``: Requires any model folder generated by the [OMC tools](https://pylhc.github.io/packages/omc3/about.html). Its only purpose is to provide the list of BPMs to look at.
41
+
-``Model``: Requires any model folder generated by the [OMC tools](omc_homepage). Its only purpose is to provide the list of BPMs to look at.
42
42
-``Reference Measurement Folder``: The measurement folder that contains the reference data.
43
43
-``Measurement Folders``: Folders containing the data you want to compare with the reference measurement.
44
+
-``Xing Knob Name``: The name of the crossing angle knob to use for the analysis in the exact form required by the `Timber` database.
44
45
45
46
## Simulation Mode
46
47
47
-
``Simulation Mode``: allows you to use simulation data when no crossing angle knob data is available from `Timber`. In this case, the GUI will <spanclass="warning-colored">not</span> attempt to load any crossing angle knob data from `Timber` and will only use the provided properties file.
48
+
``Simulation Mode``: allows you to use simulation data when no crossing angle knob data is available from `Timber`. In this case, the GUI will <spanclass="warning-colored">not</span> attempt to load any crossing angle knob data from `Timber` and will only use the provided properties file.
49
+
50
+
!!! warning "Xing Knob Name Consistency"
51
+
It will use the knob name given with <spanclass="warning-colored">no checks</span>, and this must be consistent across all measurements since plotting will fail if knob names are inconsistent.
48
52
49
53
## Properties File
50
54
@@ -54,12 +58,14 @@ The ``Properties File`` is a CSV file that contains the crossing angles used in
Where <spanstyle="background: var(--md-code-bg-color); color: #339AF0; font-family: monospace; font-size: 0.95em; border: 1pxsolidvar(--color-background-border); padding: 2px6px; border-radius: 0px;">MATCH</span> is the name of the measurement folder, and <spanstyle="background: var(--md-code-bg-color); color: green; font-family: monospace; font-size: 0.95em; border: 1pxsolidvar(--color-background-border); padding: 2px6px; border-radius: 0px;">KNOB</span> is the value of the crossing angle knob for that measurement.
61
+
Where <spanstyle="background: var(--md-code-bg-color); color: #339AF0; font-family: monospace; font-size: 0.95em; border: 1pxsolidvar(--color-background-border); padding: 2px6px; border-radius: 0px;">MATCH</span> is the name of the measurement folder, and <spanstyle="background: var(--md-code-bg-color); color: green; font-family: monospace; font-size: 0.95em; border: 1pxsolidvar(--color-background-border); padding: 2px6px; border-radius: 0px;">KNOB</span> is the corresponding value of the relevant crossing angle knob.
58
62
59
63
## Running the Analysis
60
64
61
-
<spanclass="guilabel"style="--guilabel-bg: green;">Run Analysis</span>: Runs the analysis on the provided data (i.e. collating crossing angle knob values and the RDT values), and displays the output files in the GUI on the [Validation](validation.md){.tab-link} tab.
65
+
<spanclass="rdtfeeddown_guilabel"style="--rdtfeeddown_guilabel-bg: green;">Run Analysis</span>: Runs the analysis on the provided data (i.e. collating crossing angle knob values and the RDT values), and displays a list of the output files in the GUI on the [Validation](validation.md){.rdtfeeddown_tab-link} tab.
62
66
63
67
## Other Features
64
68
65
-
- <spanclass="guilabel">Validate Knob</span>: <spanclass="warning-colored">Not required</span> unless you want to check that the crossing angle knob name exists in the `Timber` database for the measurement.
69
+
- <spanclass="rdtfeeddown_guilabel">Validate Knob</span>: <spanclass="warning-colored">Not required</span> unless you want to check that the crossing angle knob name exists in the `Timber` database for the measurement.
Copy file name to clipboardExpand all lines: docs/guis/rdt_feeddown/validation.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,17 @@
7
7
</center>
8
8
</figure>
9
9
10
-
The [Validation](validation.md){.tab-link} tab of the GUI provides a way to load data in the format created by the [Input](input.md){.tab-link} tab, and display it to validate it.
10
+
The [Validation](validation.md){.rdtfeeddown_tab-link} tab of the GUI provides a way to load data in the format created by the [Input](input.md){.rdtfeeddown_tab-link} tab, and display it to validate it.
11
11
12
12
## Input Fields Explained
13
13
14
-
- <spanclass="guilabel">Add Files</span>: Add the generated files from the [Input](input.md){.tab-link} tab of the GUI containing the RDT data you want to plot (this simply adds the filenames to a list).
15
-
- <spanclass="guilabel">Load Selected Files for Plotting</span>: Load the selected files to display their data in the plotting tabs (this then checks that the files are compatible to be plotted together). The loaded files will be displayed in the box below the button.
14
+
- <spanclass="rdtfeeddown_guilabel">Add Files</span>: Add the generated files from the [Input](input.md){.rdtfeeddown_tab-link} tab of the GUI containing the RDT data you want to plot (this simply adds the filenames to a list for easy access).
15
+
- <spanclass="rdtfeeddown_guilabel">Load Selected Files for Plotting</span>: Load the selected files to display their data in the plotting tabs (this then checks that the files are compatible to be plotted together). The loaded files will be displayed in the box below the button.
16
16
17
17
## Plotting Tabs Explained
18
18
19
19
!!! warning
20
-
Ignore the error message below for both the [RDT](#__tabbed_1_2){.tab-link} and [RDT shift](#__tabbed_1_3){.tab-link} tab, if you only have RDT data from one beam loaded (in this example it would only be LHCB1 data) - this should not affect the plotting.
20
+
Ignore the error message below for both the [RDT](#__tabbed_1_2){.rdtfeeddown_tab-link} and [RDT shift](#__tabbed_1_3){.rdtfeeddown_tab-link} tab, if you only have RDT data from one beam loaded (in this example it would only be LHCB1 data) - this should not affect the plotting.
21
21
22
22
```text
23
23
Error accessing LHCB2 RDT data: 'NoneType' object is not subscriptable
@@ -35,10 +35,10 @@ The [Validation](validation.md){.tab-link} tab of the GUI provides a way to load
35
35
36
36
This tab displays the RDT as a function of crossing angle for a BPM of your choice.
37
37
38
-
!!! tip
39
-
You can search for a BPM by typing its name in the search box and pressing the <span class="guilabel">Search BPM</span> button. This just checks if the BPM exists in the list of BPMs.
38
+
!!! tip "Searching for BPMs Tip"
39
+
You can search for a BPM by typing its name in the search box and pressing the <span class="rdtfeeddown_guilabel">Search BPM</span> button. This just checks if the BPM exists in the list of BPMs.
40
40
41
-
Either pressing <kbd>Enter</kbd> or <span class="guilabel" style="--guilabel-bg: #5C62D6;">Plot BPM</span> will plot the RDT at that BPM as a function of crossing angle.
41
+
Either pressing <kbd>Enter</kbd> or <span class="rdtfeeddown_guilabel" style="--rdtfeeddown_guilabel-bg: #5C62D6;">Plot BPM</span> will plot the RDT at that BPM as a function of crossing angle.
42
42
43
43
=== "RDT"
44
44
@@ -49,7 +49,7 @@ The [Validation](validation.md){.tab-link} tab of the GUI provides a way to load
49
49
</center>
50
50
</figure>
51
51
52
-
This tab displays the RDT as a function of position *s* for all crossing angles when <span class="guilabel" style="--guilabel-bg: #5C62D6;">Plot RDT</span> is pressed.
52
+
This tab displays the RDT as a function of position *s* for all crossing angles when <span class="rdtfeeddown_guilabel" style="--rdtfeeddown_guilabel-bg: #5C62D6;">Plot RDT</span> is pressed.
53
53
54
54
=== "RDT shift"
55
55
@@ -60,6 +60,6 @@ The [Validation](validation.md){.tab-link} tab of the GUI provides a way to load
60
60
</center>
61
61
</figure>
62
62
63
-
This tab displays the average RDT shift as a function of crossing angle when <span class="guilabel" style="--guilabel-bg: #5C62D6;">Plot RDT shifts</span> is pressed.
63
+
This tab displays the average RDT shift as a function of crossing angle when <span class="rdtfeeddown_guilabel" style="--rdtfeeddown_guilabel-bg: #5C62D6;">Plot RDT shifts</span> is pressed.
0 commit comments