Skip to content

Commit ef0dd1b

Browse files
author
Sasha Jade Horney
committed
Making wording clearer and fixing a repetition in css file and renaming to make it more specific
1 parent 03be141 commit ef0dd1b

File tree

6 files changed

+47
-45
lines changed

6 files changed

+47
-45
lines changed
-88 Bytes
Loading

docs/css/extra.css

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,30 +101,20 @@ a.cern_internal {
101101
cursor: pointer;
102102
}
103103

104-
.guilabel {
105-
white-space: nowrap;
106-
padding: 0.5px 6px;
107-
width: fit-content;
108-
border-radius: 4px;
109-
font-weight: bold;
110-
display: inline-block;
111-
}
112-
113-
.guilabel {
104+
.rdtfeeddown_guilabel {
114105
white-space: nowrap;
115106
padding: 0.5px 12px;
116107
width: fit-content;
117108
border-radius: 0px;
118109
font-weight: bold;
119110
display: inline-block;
120-
background: var(--guilabel-bg, #3c3c3c);
121-
color: var(--guilabel-fg, #ffffff);
111+
background: var(--rdtfeeddown_guilabel-bg, #3c3c3c);
112+
color: var(--rdtfeeddown_guilabel-fg, #ffffff);
122113
box-shadow: 0 1px 2px rgba(0,0,0,0.12);
123-
border: white;
124114
font-size: 1em;
125115
}
126116

127-
a.tab-link {
117+
a.rdtfeeddown_tab-link {
128118
display: inline-block;
129119
padding: 0.15em 0.7em;
130120
border-radius: 0px;
@@ -139,7 +129,7 @@ a.tab-link {
139129
box-shadow: 0 2px 6px rgba(21,101,192,0.08);
140130
transition: background 0.2s, color 0.2s, border-bottom 0.2s;
141131
}
142-
a.tab-link:hover, a.tab-link:focus {
132+
a.rdtfeeddown_tab-link:hover, a.rdtfeeddown_tab-link:focus {
143133
background: #484848;
144134
color: #ffffff;
145135
}

docs/guis/rdt_feeddown/correction.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This part of the GUI allows you to quantify the RDT correction predicted from a
44

55
## The Tabs Explained
66

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.
88

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.
1010

1111
=== "Graph Tab"
1212

@@ -19,11 +19,11 @@ This part of the GUI allows you to quantify the RDT correction predicted from a
1919

2020
**Main Features:**
2121

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.
2323

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.
2525

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>.
2727

2828
=== "Response Tab"
2929

@@ -34,16 +34,19 @@ This part of the GUI allows you to quantify the RDT correction predicted from a
3434
</center>
3535
</figure>
3636

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.
38+
39+
!!! warning "Response Behaviour Assumption Warning"
40+
This assumes a linear response!
3841

3942
**Main Features:**
4043

4144
- ``Reference Folder``: Select the reference measurement folder containing the measurement data with the corrector strength applied and the reference crossing angle.
4245

4346
- ``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!
4647

4748
- ``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.
4849

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.
51+
52+
[omc_homepage]: https://pylhc.github.io/packages/omc3/about.html

docs/guis/rdt_feeddown/gui.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@ To launch and use the RDTfeeddown GUI, use the following command:
1313
python -m pip install omc3
1414
```
1515

16+
<img src="../../assets/images/rdtfeeddown_gui/help.png" alt="Help Icon" width="20"> or <img src="../../assets/images/rdtfeeddown_gui/help2.png" alt="Help Icon" width="20"> : shows some quick tips for using the GUI.
17+
1618
<img src="../../assets/images/rdtfeeddown_gui/errorlog.png" alt="Error Log Icon" width="20"> : shows the error log for debugging.
1719

18-
!!! tip
20+
!!! tip "Navigating Plots Tip"
1921
To pan in any of the plots, use <kbd>Ctrl</kbd>+<kbd>LeftClick</kbd> and drag the mouse.
2022

2123
The following pages are available detailing the tabs and how to use them:
2224

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.
28+

docs/guis/rdt_feeddown/input.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</center>
88
</figure>
99

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.
1111

1212
You can load measurement folders, reference data, and crossing angle knob data directly through the GUI.
1313

@@ -33,18 +33,22 @@ You can provide input to the RDTfeeddown GUI using the following methods:
3333
1. ``File Input``: Load input files by clicking the relevant button in the GUI and selecting the appropriate file.
3434
2. ``Manual Input``: Manually enter file paths in the provided fields within the GUI (except for measurement folders).
3535

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).
3838

3939
## Input Fields Explained
4040

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.
4242
- ``Reference Measurement Folder``: The measurement folder that contains the reference data.
4343
- ``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.
4445

4546
## Simulation Mode
4647

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 <span class="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 <span class="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 <span class="warning-colored">no checks</span>, and this must be consistent across all measurements since plotting will fail if knob names are inconsistent.
4852

4953
## Properties File
5054

@@ -54,12 +58,14 @@ The ``Properties File`` is a CSV file that contains the crossing angles used in
5458
<span style="color: #339AF0;">MATCH,</span> <span style="color: green;">KNOB</span>
5559
</div>
5660
<div style="height: 24px;"></div>
57-
Where <span style="background: var(--md-code-bg-color); color: #339AF0; font-family: monospace; font-size: 0.95em; border: 1px solid var(--color-background-border); padding: 2px 6px; border-radius: 0px;">MATCH</span> is the name of the measurement folder, and <span style="background: var(--md-code-bg-color); color: green; font-family: monospace; font-size: 0.95em; border: 1px solid var(--color-background-border); padding: 2px 6px; border-radius: 0px;">KNOB</span> is the value of the crossing angle knob for that measurement.
61+
Where <span style="background: var(--md-code-bg-color); color: #339AF0; font-family: monospace; font-size: 0.95em; border: 1px solid var(--color-background-border); padding: 2px 6px; border-radius: 0px;">MATCH</span> is the name of the measurement folder, and <span style="background: var(--md-code-bg-color); color: green; font-family: monospace; font-size: 0.95em; border: 1px solid var(--color-background-border); padding: 2px 6px; border-radius: 0px;">KNOB</span> is the corresponding value of the relevant crossing angle knob.
5862

5963
## Running the Analysis
6064

61-
<span class="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+
<span class="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.
6266

6367
## Other Features
6468

65-
- <span class="guilabel">Validate Knob</span>: <span class="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+
- <span class="rdtfeeddown_guilabel">Validate Knob</span>: <span class="warning-colored">Not required</span> unless you want to check that the crossing angle knob name exists in the `Timber` database for the measurement.
70+
71+
[omc_homepage]: https://pylhc.github.io/packages/omc3/about.html

docs/guis/rdt_feeddown/validation.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
</center>
88
</figure>
99

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.
1111

1212
## Input Fields Explained
1313

14-
- <span class="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-
- <span class="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+
- <span class="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+
- <span class="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.
1616

1717
## Plotting Tabs Explained
1818

1919
!!! 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.
2121

2222
```text
2323
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
3535

3636
This tab displays the RDT as a function of crossing angle for a BPM of your choice.
3737

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.
4040
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.
4242

4343
=== "RDT"
4444

@@ -49,7 +49,7 @@ The [Validation](validation.md){.tab-link} tab of the GUI provides a way to load
4949
</center>
5050
</figure>
5151

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.
5353

5454
=== "RDT shift"
5555

@@ -60,6 +60,6 @@ The [Validation](validation.md){.tab-link} tab of the GUI provides a way to load
6060
</center>
6161
</figure>
6262

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.
6464

6565

0 commit comments

Comments
 (0)