HLT2 line tutorial
Partly for the upcoming hackathon and partly because it'd generally be nice to have, we should have a tutorial on authoring HLT2 lines.
The style is Starterkit-like, with the goal being that someone can read the tutorial and end up with a new functioning HLT2 line and a solid understanding of how to write their own. They should also understand where to go to understand related points (the reconstruction, PyConf, running the tests, etc.).
Some general points to cover:
- Code structure
- Using Python modules and packages
- Defining an
all_lines
registry in each module, and where to add your registry to the list of all HLT2 registries.
-
Conventions
- Coding style and naming conventions (for files, functions, and line names)
- Debugging
- Looking and the control and data flow (with graphs)
- Algorithm instantiation traceback (!224 (closed))
- Overview of deduplication techniques in the framework
- (Probably belongs more naturally in the PyConf docs, so should consider putting the details there and linking to it, but should at least summarise the core ideas)
Work ongoing in !264 (merged).