User guide updates rdtfeeddown #202

sashaj5454 · 2025-08-29T12:50:01Z

Just some preliminary documentation for the RDTfeeddown GUI in its current form.

* add image for kmod gui landing page * rework Kmod main GUI page * remove all previous kmod pages as they are vastly outdated * remove outdated supporting images * file rename * pages for later * and in the website layout too * written circuit selection and settings for kmod, with supporting image * end of modulating section * no need for a page for retrieval, merge with analysis * attempts uv in CI * use uv in the deploy workflow too * retrieving modulations * analyzing modulations * mention auto logging * quick linting of rws procedure, add prab paper ref * linting fixes * simplify measurement procedure page for Kmod * typo fix * better suggestion

* need trailing line * alt tag in images * alt tag and spaces before code block * center figure * alt tag and lines in admonitions blocks * trailing line * empty lines and bullet lists linting * empty lines * empty lines * empty lines * trailing spaces * trailing spaces * fix todo * empty lines * define sshutle link * no kmod special as OP develops it now * remove from navigation too * alt text and center figures * trailing spaces * multiple empty lines, trailing spaces and eol at eof fixes in all logbook files * trailing spaces * eol at eof * trailing spaces * eol at eof * multiple empty lines, trailing spaces and eol at eof fixes * do not include weirdass AI pictures in the website * remove assets as well * alt tag and center figure * properly close center tag * html for figure * specify code fence language * multiple empty lines, trailing spaces and eol at eof fixes * multiple empty lines, trailing spaces and eol at eof fixes * eol at eof * eol at eof * explicitely refer to felix carlier * empty lines * empty lines * empty lines, alt tags and 2 spaces for highlighting * alt tags and centered * trailing spaces * eol at eof * trailing spaces * fix relative link * fix relative anchor links * fix relative anchor links * remove problematic anchor link * fix link for new kmod app * remove another broken anchor link * fix broken rel link since files move by josch * fix broken rel link since files move by josch * fix broken rel link since files move by josch * and refer to the proper tag * include alt tag for each image entry and reformat table * headers consistency and proper pip invocation command * eol at eof * spaces around code fences * empty lines * headers and list style * strip end space in code fence * spaces around code fences * trailing spaces and empty lines around code fence blocks * trailing spaces and headers consistency * proper pip invocation * and ref * and from navigation * eol at eof * trailing spaces and empty lines around code fence blocks * trailing spaces * trailing spaces * eol at eof and empty space around code block * eol at eof and empty space around code block * eol at eof and empty space around code block * trailing spaces * eol at eof * trailing spaces and empty lines around code fence blocks * empty lines * trailing spaces, empty lines, deduplicate headers * no punctuation in headers * eol at eof * little arrow last * use headers as the numbered list would reset anyway * remove trailing punctuation in header * empty lines * remove forgotten html artefact * imports sorting * imports sorting, quick formatting * minor typing, import future annotations * be explicit in what is replaced, via naming to avoid confusion. Type checker was complaining * a little type hinting * linting, formatting, eol at eof * ruff formatting again * future annotations * types and ruff formatting * escape pip * proper pip invocation * proper pip invocation

* decapole studies at injection is a 2023 note * folder and page for chroma gui, first section * added to naviation * add default view on chroma gui, include figure * extraction part, with supporting files * new header * set option to show copy button for code blocks: * put bounds on requirements * specify step size * cleaning section done, with supporting files * chromaticity section * corrections section and supporting file, change a few admonition types * add mention and links of chroma gui to main GUIs page * we can afford some letters

Co-authored-by: Felix Soubelet <19598248+fsoubelet@users.noreply.github.com>

…ng to make it more specific

fsoubelet

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.

fsoubelet · 2025-09-04T07:55:08Z

docs/guis/rdt_feeddown/gui.md

@@ -1 +1,28 @@
-# The RDT Feeddown GUI
+# The RDTfeeddown GUI
+


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.

fsoubelet · 2025-09-04T07:55:20Z

docs/guis/rdt_feeddown/gui.md

+```bash
+python -m pip install omc3
+```


Surely this isn't the command to start it?

fsoubelet · 2025-09-04T07:56:13Z

docs/guis/rdt_feeddown/gui.md

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


A little sentence about this first would be nice as well.

fsoubelet · 2025-09-04T07:57:36Z

docs/guis/rdt_feeddown/gui.md

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


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?

fsoubelet · 2025-09-04T08:02:37Z

docs/guis/rdt_feeddown/input.md

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


Wants square brackets here for the link to work:

Suggested change

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

fsoubelet · 2025-09-04T08:26:39Z