User guide updates rdtfeeddown #202
Conversation
sashaj5454
added
Type: Documentation
There was a problem hiding this comment.
Nice GUI! Felt intimidating the one time I saw it, much better after a read through :)
I came at this with the perspective of someone who's never used it once, or really done your measurements. Some of the questions might be naive but maybe that's for the best.
Few corrections / suggestions as well.
| @@ -1 +1,28 @@ | |||
| # The RDT Feeddown GUI | |||
| # The RDTfeeddown GUI | |||
|
|
|||
There was a problem hiding this comment.
Would be nice to start with a sentence or two explaining the purpose of this GUI first, e.g. which kind of measurements it is meant to be used for.
Then, the command to start it, and finally an image of what it looks like once opened. Just ordering of things.
| ```bash | ||
| python -m pip install omc3 | ||
| ``` |
There was a problem hiding this comment.
Surely this isn't the command to start it?
| <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. | ||
|
|
||
| <img src="../../assets/images/rdtfeeddown_gui/errorlog.png" alt="Error Log Icon" width="20"> : shows the error log for debugging. |
There was a problem hiding this comment.
A little sentence about this first would be nice as well.
| - [Input](input.md){.rdtfeeddown_tab-link} tab: for how to input files to produce an analysable format. | ||
| - [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. | ||
| - [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. |
There was a problem hiding this comment.
I'm not sure formatting these words as icons helps here. I did not pick up that they were clickable links before inspecting the PR content for instance.
Might be better as simply links?
| 2. ``Manual Input``: Manually enter file paths in the provided fields within the GUI (except for measurement folders). | ||
|
|
||
| !!! warning "Input Format Warning" | ||
| All folder inputs should be in the form used for the results directory of measurements in the [OMC analysis tools](omc_homepage). |
There was a problem hiding this comment.
Wants square brackets here for the link to work:
| All folder inputs should be in the form used for the results directory of measurements in the [OMC analysis tools](omc_homepage). | |
| All folder inputs should be in the form used for the results directory of measurements in the [OMC analysis tools][omc_homepage]. |
| </center> | ||
| </figure> | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Square brackets again
| 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. | |
| 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. |
|
|
||
| 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. | ||
|
|
||
| !!! warning "Response Behaviour Assumption Warning" |
There was a problem hiding this comment.
Already a warning admonition :)
| !!! warning "Response Behaviour Assumption Warning" | |
| !!! warning "Response Behaviour Assumption" |
| 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. | ||
|
|
||
| !!! warning "Response Behaviour Assumption Warning" | ||
| This assumes a linear response! |
There was a problem hiding this comment.
Does that mean in your experience it limits to a specific RDT order for instance?
|
|
||
| **Main Features:** | ||
|
|
||
| - ``Reference Folder``: Select the reference measurement folder containing the measurement data with the corrector strength applied and the reference crossing angle. |
There was a problem hiding this comment.
Is it the same reference folder as in the "input" tab? Could be nice to specify
|
|
||
| - ``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. | ||
|
|
||
| - <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. |
There was a problem hiding this comment.
Could you add a word on the naming convention / the file I should expect to be written from running this?
Just some preliminary documentation for the RDTfeeddown GUI in its current form.