eic.github.io/_documentation/tutorials.md

0001 ---
0002 title: ePIC Tutorials
0003 description: epicTutorials
0004 name: tutorials
0005 layout: default
0006 ---
0007
0008 {% include layouts/title.md %}
0009
0010 #### Future tutorials schedule:
0011
0012 #### Please join the [Mattermost Software Tutorials](https://chat.epic-eic.org/main/channels/software-tutorials) channel for updates/announcements and questions about tutorials.
0013
0014 #### Note that the tutorials as presented below are not intended to be followed in a strict sequence. New users should start with the "Setting up an enviornment" tutorial.  Beyond this, we encourage users to pick and choose the tutorials on topics they want to explore.
0015
0016 #### Current tutorials are summarised in the table below -
0017
0018 | Tutorial | Difficulty | Tags | Description | Resources |
0019 | --- | --- | --- | --- | --- |
0020 | [Setting up an environment](https://eic.github.io/tutorial-setting-up-environment) | Beginner | \[Setup\] \[Environment\] | Get started with the ePIC software environment | [Video 1](https://www.youtube.com/watch?v=Y0Mg24XLomY) • [Video 2](https://www.youtube.com/watch?v=5HmzFnYW4W4) |
0021 | [Analysis and simulation output](https://eic.github.io/tutorial-analysis) | Beginner/Advanced | \[Analysis\] \[Data\] | Learn how to analyze simulation data | [Video](https://youtu.be/O7lPhc7Z3bM) [Video2](https://york-ac-uk.zoom.us/rec/share/Z2siwQKbRl8CTe7AnRc7AAyYci_uptQqGNkXKLF3BA9aB03u3JCUPswZ-zZWr8Py.MswdoCLv5C1cixJk) (=8c.B&C!) |
0022 | [Simulating detectors](https://eic.github.io/tutorial-geometry-development-using-dd4hep/) | Expert | \[Simulation\] \[Detector\] \[DD4hep\] | Development of detector geometry using DD4hep | [Video](https://youtu.be/k9Egs602GuM) |
0023 | [Modifying geometry and digitization](https://eic.github.io/tutorial-modifying-geometry-digitization-etc) | Advanced | \[Geometry\] \[Digitization\] | Learn to customize detector configurations | \- |
0024 | [Understanding simulation output](https://eic.github.io/tutorial-understanding-sim-output) | Advanced | \[Simulation\] \[Data\] | Deep dive into simulation data structure | [Video](https://york-ac-uk.zoom.us/rec/share/QHWRkE5C5IabdfyzE3-WOK-HatCX3xGxmRkE8kJ7GJITw1GIognlfK4gjO-FaAuM.UchWVkbM66-a2IE3) (jn*#sp0^) |
0025 | [Getting started with physics analysis](https://indico.bnl.gov/event/27123/) | Advanced | \[Physics\] \[Analysis\] | Physics analysis introduction | [Video](https://york-ac-uk.zoom.us/rec/share/9fYHihz2oN59tSZy1kxWpi6HnDj57Xjj9Oa4ayCZUEF5YMpLNyJe9vtT-dgLtd0s.20twdCnPqJcukofE) (fVjNB#8.) |
0026 | [Inclusive kinematics reconstruction](https://eic.github.io/tutorial-kinematic-reconstruction/) | Advanced | \[Reconstruction\] \[Kinematics\] | Learn kinematics reconstruction techniques | [Video](https://york-ac-uk.zoom.us/rec/share/611M8rfKm1SZookd8JyyqcoRVLiDoajy7m3hwOo7SqSK9Lu2b8Gr_nsJ1LIbt7z0.G5HvcdHCGNEmyA2O) (Z09g&#6A) |
0027 | [Reconstruction algorithms](https://eic.github.io/tutorial-reconstruction-algorithms) | Expert | \[Algorithms\] \[Reconstruction\] | Study different reconstruction approaches | [Video 1](https://youtu.be/Fjs8pyS47_A) • [Video 2](https://youtu.be/WkePQZZVufc) |
0028 | [Developing benchmarks](https://eic.github.io/tutorial-developing-benchmarks) | Expert | \[Benchmarking\] \[Performance\] | Learn to create performance benchmarks | \- |
0029 | [Simulations with npsim and geant4](https://eic.github.io/tutorial-simulations-using-npsim-and-geant4/) | Advanced | \[Simulation\] \[Geant4\] \[npsim\] | Run simulations with different frameworks | [Video 1](https://www.youtube.com/watch?v=QjjD1_wjLIw) • [Video 2](https://www.youtube.com/watch?v=WqSQ4m_esUw) |
0030 | [Reconstruction framework](https://eic.github.io/tutorial-jana2/) | Expert | \[Framework\] \[JANA2\] \[Reconstruction\] | Working with the JANA2 reconstruction framework | [Video 1](https://www.youtube.com/watch?v=Ly2Zh1AGUEc) • [Video 2](https://youtu.be/9blKFZS-qMk) |
0031 | [Analysis bootcamp](https://github.com/eic/python-analysis-bootcamp) | Advanced | \[Python\] \[Analysis\] \[Bootcamp\] | Python-based analysis techniques | \- |
0032
0033 ### Tutorial Categories
0034
0035 *   **Setup**: Environment configuration and basic setup
0036 *   **Simulation**: Creating and running simulations
0037 *   **Analysis**: Working with and analyzing data
0038 *   **Reconstruction**: Techniques for event reconstruction
0039 *   **Geometry**: Detector geometry specification and modification
0040 *   **Framework**: Software framework components and usage
0041
0042 ---
0043
0044 ##### [Setting up an environment](https://eic.github.io/tutorial-setting-up-environment)
0045 [![EnvSS](/assets/images/tutorials/SetupEnvSS.png){: width="60%" }](https://eic.github.io/tutorial-setting-up-environment)
0046 [![video1](/assets/images/tutorials/Vid1Env.png){: width="18%" }](https://www.youtube.com/watch?v=Y0Mg24XLomY)
0047 [![video2](/assets/images/tutorials/Vid2Env.png){: width="18%" }](https://www.youtube.com/watch?v=5HmzFnYW4W4)
0048
0049 ##### [Analysis and working with the simulation output](https://eic.github.io/tutorial-analysis)
0050 [![AnaTutSS](/assets/images/tutorials/AnaTutSS.png){: width="60%" }](https://eic.github.io/tutorial-analysis)
0051 [![video1](/assets/images/tutorials/AnalysisThumbVid.png){: width="18%" }](https://youtu.be/O7lPhc7Z3bM)
0052
0053 ##### [Simulating detectors and their readout](https://eic.github.io/tutorial-geometry-development-using-dd4hep/)
0054 [![GeoDevSS](/assets/images/tutorials/GeoDevSS.png){: width="60%" }](https://eic.github.io/tutorial-geometry-development-using-dd4hep/)
0055 [![video1](/assets/images/tutorials/GeomThumbVid.png){: width="18%" }](https://youtu.be/k9Egs602GuM)
0056
0057 ##### [Modifying geometry, digitization, and anything else](https://eic.github.io/tutorial-modifying-geometry-digitization-etc)
0058 [![ModGeoTutSS](/assets/images/tutorials/ModGeoTutSS.png){: width="60%" }](https://eic.github.io/tutorial-modifying-geometry-digitization-etc)
0059
0060 ##### [Understanding the Simulation Output](https://eic.github.io/tutorial-understanding-sim-output)
0061 [![UnderSimOutTutSS](/assets/images/tutorials/UnderSimOutTutSS.png){: width="60%" }](https://eic.github.io/tutorial-understanding-sim-output/)
0062
0063 ##### [Getting Started With a Physics Analysis](https://indico.bnl.gov/event/27123/)
0064
0065 ##### [Inclusive Kinematics Reconstruction](https://eic.github.io/tutorial-kinematic-reconstruction/)
0066 [![UnderSimOutTutSS](/assets/images/tutorials/InclusiveKinRecTutSS.png){: width="60%" }](https://eic.github.io/tutorial-kinematic-reconstruction/)
0067
0068 ##### [Reconstruction algorithms](https://eic.github.io/tutorial-reconstruction-algorithms)
0069 [![ReconAlgTutSS](/assets/images/tutorials/ReconAlgTutSS.png){: width="60%" }](https://eic.github.io/tutorial-reconstruction-algorithms)
0070 [![video1](/assets/images/tutorials/algThumbVidpt1.png){: width="18%" }](https://youtu.be/Fjs8pyS47_A)
0071 [![video2](/assets/images/tutorials/algThumbVidpt2.png){: width="18%" }](https://youtu.be/WkePQZZVufc)
0072
0073 ##### [Developing benchmarks](https://eic.github.io/tutorial-developing-benchmarks)
0074 [![BenchmarkTutSS](/assets/images/tutorials/BenchmarkTutSS.png){: width="60%" }](https://eic.github.io/tutorial-developing-benchmarks)
0075
0076 ##### [Simulations using npsim and geant4](https://eic.github.io/tutorial-simulations-using-npsim-and-geant4/)
0077 [![SimTutSS](/assets/images/tutorials/SimTutSS.png){: width="60%" }](https://eic.github.io/tutorial-simulations-using-npsim-and-geant4/)
0078 [![video1](/assets/images/tutorials/SimVid1.png){: width="18%" }](https://www.youtube.com/watch?v=QjjD1_wjLIw)
0079 [![video2](/assets/images/tutorials/SimVid2.png){: width="18%" }](https://www.youtube.com/watch?v=WqSQ4m_esUw)
0080
0081 ##### [Reconstruction framework](https://eic.github.io/tutorial-jana2/)
0082 [![ReconTutSS](/assets/images/tutorials/ReconTutSS.png){: width="60%" }](https://eic.github.io/tutorial-jana2/)
0083 [![video1](/assets/images/tutorials/RecVid1.png){: width="18%" }](https://www.youtube.com/watch?v=Ly2Zh1AGUEc)
0084 [![video2](/assets/images/tutorials/RecVid2.png){: width="18%" }](https://youtu.be/Ly2Zh1AGUEc https://youtu.be/9blKFZS-qMk)
0085
0086 ##### [Analysis bootcamp](https://github.com/eic/python-analysis-bootcamp)
0087 [![AnaBootcampSS](/assets/images/tutorials/AnaBootcampSS.png){: width="50%" }](https://github.com/eic/python-analysis-bootcamp)