Back to home page

EIC code displayed by LXR

 
 

    


Warning, /tutorial-reconstruction-algorithms/instructors/instructor-notes.md is written in an unsupported language. File is not indexed.

0001 ---
0002 title: "Instructor Notes"
0003 ---
0004 
0005 This lesson assumes learners already have a working `eic-shell` environment and a checkout of
0006 [EICrecon](https://github.com/eic/EICrecon); make sure they have completed the
0007 [Setup](../learners/setup.md) page before the session, since building EICrecon from scratch can take
0008 a while.
0009 
0010 ## Emphasis
0011 
0012 - The single most important conceptual point is the split between framework-independent
0013   **algorithms** (`src/algorithms`) and framework-facing **factories** (`src/factories`). Keep
0014   returning to it — most of the later episodes are variations on this theme.
0015 - `JOmniFactory` is the only factory base class learners need to write new code. Mention the older
0016   base classes only so learners recognize them in existing code.
0017 
0018 ## Pacing
0019 
0020 - Episodes 02–07 build up a single running example (the electron finder). Encourage learners to keep
0021   their own EICrecon checkout open and edit along, rather than only reading.
0022 - The exercises are cumulative: each one extends the factory/algorithm from the previous episode.
0023   If a learner falls behind, the final code in episode 07 ("Putting everything together") can be
0024   used as a reference to catch up.