running list of docs to write

tomeichlersmith commented 1 year ago

I think writing up some pages about various topics/tasks will aid in transfer of knowledge to whomever is aligning in the future. It will also help me personally understand things better.

General Documentation

[ ] hps-mc setup
[ ] summary of millepede paper and link to it
[ ] vocabulary (residual, unbiased residual, uvw coordinates)
[x] uvw coordinate reference (include diagram in PF's slides) #41
[ ] references to charged particle tracking

"First Principles" Conclusions

These types of connections can be derived from first principles but can be quickly summarized in physical measurements.

[ ] tu movement causes <ures> shift
[ ] rw movement causes <ures> vs v shift
[ ] out of plane movements (tw or rv) cause <ures> vs u shift

Mini Study Summaries

I'm imagining a catalogue of mini studies (examples below but in general X movements cause Y in plots) so that future folks aligning don't have to redo studies unless necessary. HPS-specific.

[ ] rotating front layers shift vertex z
[ ] back layers affect momentum value/resolution the most?
[ ] tw movements in front affect d0 more while the same movement in back affects p more @sarahgaiser
[ ] ...? others dug up from old presenations?

tomeichlersmith commented 1 year ago

I've started a branch cli-doc which uses sphinx_click and some fancy typer nonsense to generate a reference manual from the CLI help. https://github.com/tiangolo/typer/issues/200#issuecomment-795873331 This will hopefully improve our doc website and help avoid having to have CLI functions handled by autodoc.

tomeichlersmith commented 1 year ago

Document detailing how track parameters are defined in LCIO: https://bib-pubdb1.desy.de/record/81214/files/LC-DET-2006-004%5B1%5D.pdf