A flurry of adjustments and some additional content#252
Conversation
…ined, no AFS needed
fsoubelet
added
Type: Documentation
fsoubelet
left a comment
fsoubelet
left a comment
There was a problem hiding this comment.
Just a few comments to help guide during your review. Thank so much zensical for warning about invalid refs etc at build time now :)
|
|
||
| The GUIs can be started from your development environment or via deployed `.jnlp` from the archives: | ||
| <!-- TODO: Add SbS and RDT Feeddown GUIs here when pages are ready. --> | ||
| <!-- TODO: Add RDT Feeddown GUI here when pages are ready. --> |
There was a problem hiding this comment.
Because SbS is not a full GUI to start in and of itself, it comes from the BetaBeat GUI now.
| /afs/cern.ch/eng/sl/lintrack/LHC_commissioning2022/ | ||
| ``` | ||
|
|
||
| <!-- TODO: also one entry for IR5 RWS measurements --> |
| ??? tip "Results Visualization" | ||
|
|
||
| Various results graphs and the scripts to make them are available in `lintrack`: | ||
|
|
||
| ``` | ||
| /afs/cern.ch/eng/sl/lintrack/LHC_commissioning2025/ | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Folder does not exist. I guess if I don't make them... 🤷♂️
| This section documents the physics and methods that underpin the OMC team's optics measurement activities. | ||
| The connecting thread across all methods is the extraction of optics quantities (optics functions, dispersion, coupling, resonance driving terms etc) from turn-by-turn BPM data, and their comparison to a reference model to identify and correct lattice imperfections. |
There was a problem hiding this comment.
Whole page was depressingly empty, so I wrote a few very quick word to introduce different sections. Eager for feedback on these pages the most.
| !!! tip "Primary Reference" | ||
| The algorithm and its derivations are described in [Malina et al., IPAC2022][malina_harpy]{target=_blank}: *Harpy: A Fast, Simple and Accurate Harmonic Analysis with Error Propagation*. |
There was a problem hiding this comment.
I wrote a quick overview of the main points behind harpy's workflow in this page, based on both the referenced IPAC paper and the code itself. Very open to feedback on this page.
| - IRNL Corrections: | ||
| - About: packages/irnl/about.md | ||
| - ↪ On Github: https://github.com/pylhc/irnl_rdt_correction | ||
| - MESS: | ||
| - About: packages/mess/about.md | ||
| - ↪ On Github: https://github.com/pylhc/MESS |
There was a problem hiding this comment.
Were just duplicates of their GitHub readmes.
| - ↪ irnl-corrections: https://github.com/pylhc/irnl_rdt_correction | ||
| - ↪ madx-scripts: https://github.com/pylhc/MESS |
| # - Linear IR Optics: measurements/physics/ir_linear_optics.md | ||
| # - Nonlinear IR Optics: measurements/physics/ir_nonlinear_optics.md | ||
| # - 3D-Kicks: measurements/physics/threedkicks.md |
There was a problem hiding this comment.
I'd rather not leave completely empty pages...
If someone feels like writing them ;)
| @@ -1,30 +1,33 @@ | |||
| # The OMC Python Packages | |||
|
|
|||
| | Package | Description | Version | Documentation | Wiki | | |||
There was a problem hiding this comment.
This page is an ugly diff!
Basically, I split the table into two: a first one with our workhorse packages and a second one with adjacent stuff.
See the CI build to view the new page, it's much easier.
| Changes from the nominal scenario in your simulation could be including errors tables, orbit bumps, speculative magnet errors, additional elements etc. | ||
| It is also easy for the reader to follow along if starting from measurements files. | ||
|
|
||
| ??? example "Generating the Example Data" |
There was a problem hiding this comment.
This big negative diff is thanks to pylhc/MESS#21
Now the admonition points to the files there, which is cleaner and also allows accessing them without AFS access.
1 participant
This PR is an implementation of a long list of "fixes" for things I noticed while I was looking through every page to check the
zensicalbuilds from #237.It is difficult to make a summary since most changes range from "typo" to "update something outdated" to "clarify that" etc. For now, I have left the
Changes.mdfile that lists some of those, as an indication for the reviewer, if it helps. It will be removed before merging.There are a few more substantial changes, namely removing (commenting out from the nav) some pages in the
Physicssection, and writing a little something in some others that were empty (harpy, optics, etc). They should jump out to the eye in the diffs since it's a full blown page.I recommend having a look at the build from time to time for a better idea of what these changes result into :)
For me to remember:
Changes.mdfile