Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Julia HepMC3 project #1662

Merged
merged 5 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions _gsocprojects/2025/project_JuliaHEP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
project: JuliaHEP
title: JuliaHEP
layout: default
logo: juliahep/juliaheplogo.png
description: |
The [JuliaHEP](https://hepsoftwarefoundation.org/activities/juliahep.html) working group brings together a community of developers and users of Julia in Particle Physics, with the aim of improving the sharing of knowledge and expertise, as well as unify effort in developing Julia packages useful for the community.
---

{% include gsoc_project.ext %}
64 changes: 64 additions & 0 deletions _gsocproposals/2025/proposal_JuliaHepMC3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Julia Interfaces to HepMC3
layout: gsoc_proposal
project: JuliaHEP
year: 2025
organization:
- CERN
difficulty: medium
duration: 175
mentor_avail: June-July- August
---

## Description

In high-energy physics experiments at [CERN](https://home.cern/) it is necessary to simulate physics events in order to compare predicted observations with those that the LHC experiments actually observe. A key piece of the software chain used to do that is the [HepMC3](https://arxiv.org/abs/1912.08005) event record library, which encodes the output from physics event generators in a standard way, so that they can be used by downstream detector simulation and analysis codes.

There is now [increasing interest](https://doi.org/10.1007/s41781-023-00104-x) in using [Julia](https://julialang.org/) as a language for HEP software, as it combines the ease of programming in interactive languages, e.g., Python, with the speed of compiled language, such as C++. As part of building up the ecosystem of supporting packages for Julia in high-energy physics, developing interfaces to read, manipulated and write HepMC3 event records in Julia is the aim of this project.

## Task ideas

This project would develop a wrapper library for [HepMC3](https://gitlab.cern.ch/hepmc/HepMC3) allowing the HepMC3 data objects and methods, in C++, to be called from Julia.

It would utilise the general underlying wrapper interfaces in [CxxWrap](https://github.com/JuliaInterop/CxxWrap.jl) and the automated wrapper code generator [WrapIt!](https://github.com/grasph/wrapit) to allow for as easy and maintainable an interface as possible.

A key outcome would be a set of unit tests and examples, based on the HepMC3 ones, demonstrating how to use the library and proving that the code is correct.

## Expected results and milestones

- Reading of HepMC3 event files
- Particularly the ASCII format will be targeted first
- Access to event data structures
- Access to particle properties
- Navigation of the event and the vertices between parent and child particles
- Access to run information
- Update of HepMC3 data structures
- Creation of new HepMC3 events
- Re-serialisation of these events to file
- Initially ASCII
- Documentation and examples on how to use the Julia interfaces
- HepMC3.jl package registered in the Julia general registry
- Extension of serialisation to ROOT format (stretch goal)

## Requirements

- Programming experience in C++
- Prior experience in Julia (very advantageous)
- A background understanding of high-energy physics (advantageous)

## Evaluation Exercise

TDB
vvolkl marked this conversation as resolved.
Show resolved Hide resolved

## Mentors

- **[Graeme Stewart](mailto:[email protected])**
- [Mateusz Fila](mailto:[email protected])

## Links

- [Julia Programming Language](https://julialang.org/)
- [JuliaHEP HSF Group](https://hepsoftwarefoundation.org/workinggroups/juliahep.html)
- [HepMC3 Repository](https://gitlab.cern.ch/hepmc/HepMC3)
- [CxxWrap](https://github.com/JuliaInterop/CxxWrap.jl)
- [WrapIt!](https://github.com/grasph/wrapit)
2 changes: 2 additions & 0 deletions gsoc/2025/mentors.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ layout: plain
* Andy Buckley [[email protected]](mailto:[email protected]) UofGlasgow
* Vipul Cariappa [[email protected]](mailto:[email protected]) CompRes
* Chris Gutschow [[email protected]](mailto:[email protected]) UCLondon
* Mateusz Fila [[email protected]](mailto:[email protected]) CERN
* Aaron Jomy [[email protected]](mailto:[email protected]) CERN/CompRes
* Stephan Lachnit [[email protected]](mailto:[email protected]) DESY
* David Lange [[email protected]](mailto:[email protected]) CompRes
Expand All @@ -18,6 +19,7 @@ layout: plain
* Alexander Penev [[email protected]](mailto:[email protected]) CompRes/University of Plovdiv, BG
* Mayank Sharma [[email protected]](mailto:[email protected]) UMich
* Simon Spannagel [[email protected]](mailto:[email protected]) DESY
* Graeme Stewart [[email protected]](mailto:[email protected]) DESY
* Martin Vasilev [[email protected]](mailto:[email protected]) University of Plovdiv, BG
* Vassil Vassilev [[email protected]](mailto:[email protected]) CompRes
* Valentin Volkl [[email protected]](mailto:[email protected]) CERN