Summary and Schedule
Welcome to the EIC Tutorial on Reconstruction Algorithms in JANA2!
This tutorial shows you how to build algorithms and plugins in JANA2 to expand and use the ePIC reconstruction software (EICrecon).
Prerequisites
Please take a look at the Setup page for necessary prerequisites for this lesson.
| Setup Instructions | Download files required for the lesson | |
| Duration: 00h 00m | 1. Introduction | Where does EICrecon fit into the ePIC software ecosystem? |
| Duration: 00h 05m | 2. Work Environment for ePIC Reconstruction Software | How do I setup a development copy of the EICrecon repository? |
| Duration: 00h 25m | 3. Creating a plugin to make custom histograms/trees |
Why should a I make a custom plugin? How do I create a custom plugin? |
| Duration: 01h 00m | 4. Creating or modifying a JANA factory in order to implement a reconstruction algorithm | How to write a reconstruction algorithm in EICrecon? |
| Duration: 01h 35m | 5. Contributing code changes to the EICrecon repository | How do I submit code to the EICrecon repository? |
| Duration: 01h 55m | Finish |
The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.
In advance of the training session, please ensure that
- You have a GitHub account (sign up here)
- Your GitHub account is a member of the EIC organization on GitHub
- Email the EICUG SWG conveners with your GitHub account to be added
- You have some basic familiarity with Unix shell and Git
- Software Carpentry Unix Shell training (required)
- Software Carpentry Basic Git training (recommended)
- You have singularity, apptainer, or docker (on Mac) installed and
working
-
module load singularity(on most JLab or BNL systems) - you should at a minimum be able to run either of the following
commands and open a shell:
singularity run docker://alpinedocker run --rm -it alpine
- Software Carpentry Incubator Singularity training (optional)
- HEP Software Foundation Docker training (optional)
-
- You have completed the Setting Up
Your EIC Environment tutorial and can start
eic-shell