User guide

This section contains documentation of the scripts distributed with professor. The scripts are listed in the order of a typical work cycle.

Note that there may be scripts which are not documented here: at the time of writing the prof-envelopes and prof-plotcorrelations scripts fall into this category. However, all the Professor scripts have names starting with prof-, and so typing this and using your shell’s tab completion facility is a handy way to get a list of all available programs. All of the Professor scripts have built-in documentation via the --help flag.

Main programs

• Sample parameter points – prof-sampleparams
• Creating run combination files – prof-runcombs
• Plotting MC envelope histograms – prof-envelopes
• Creating response function parameterizations – prof-interpolate
• Interactive parameterisation GUI – prof-I
• Finding optimal parameter values – prof-tune
• Visualize the scatter of minimization results – prof-plotresultscatter
• Plotting parameter correlations – prof-plotcorrelations
• Observable sensitivities – prof-sensitivities

• Standard Professor script command-line options

Helper programs

• Creating observable weight files – prof-lsobs
• Plotting parameterised histograms – prof-ipolhistos
• Comparing tune performance – prof-comparetunes
• Line scan verification – prof-scanchi2
• Viewing parameterisation details – prof-showipol
• Viewing tune result details – prof-showminresults
• Visualize deviations between MC and reference plots – prof-plotpulls
• Parallelize computations – prof-batchtune
• Merge minimisation results in one file – prof-mergeminresults

File formats

• Run combination file format
• Weights file syntax

Interactive usage

Todo

Give instructions and examples how to setup the Professor mode for IPython and how to do stuff interactively with Professor. E.g. filtering result lists.