-
Notifications
You must be signed in to change notification settings - Fork 22
docs: JOSS paper #337
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
Open
APN-Pucky
wants to merge
23
commits into
paper
Choose a base branch
from
draft
base: paper
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+735
−0
Open
docs: JOSS paper #337
Changes from 5 commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
086a78b
init paper
APN-Pucky fbdfdd3
Copy strucutre from vector
APN-Pucky 520bf1f
fix: mixup of files
APN-Pucky 0126fc4
Some sentence
APN-Pucky 56384fd
XML example explain
APN-Pucky 91b303b
put me first
APN-Pucky 274ee42
update tags
APN-Pucky aed69d6
add joss ci
APN-Pucky c17e32d
fix: loc
APN-Pucky cebf3c4
add xml example of format
APN-Pucky 7d79a97
add parameter table
APN-Pucky 9c757b4
separate unit
APN-Pucky 01a89bc
reverse cite
APN-Pucky 4ab8a13
Cite MCs
APN-Pucky 7c4f22b
Statement of need done?
APN-Pucky 70f559d
More text
APN-Pucky 5846c5f
v2 and v3
APN-Pucky a32eb84
++TODO
APN-Pucky a4d15a3
say what we support
APN-Pucky 05976e9
looks complete
APN-Pucky 1eb10f0
review
APN-Pucky 994e4f7
more
APN-Pucky 64c3f2a
ok
APN-Pucky File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| @inproceedings{Boos:2001cv, | ||
| author = "Boos, E. and others", | ||
| title = "{Generic User Process Interface for Event Generators}", | ||
| booktitle = "{2nd Les Houches Workshop on Physics at TeV Colliders}", | ||
| eprint = "hep-ph/0109068", | ||
| archivePrefix = "arXiv", | ||
| reportNumber = "FERMILAB-CONF-01-496-T", | ||
| month = "9", | ||
| year = "2001" | ||
| } | ||
|
|
||
| @article{Buckley:2019xhk, | ||
| author = {Buckley, Andy and Ilten, Philip and Konstantinov, Dmitri and L{\"o}nnblad, Leif and Monk, James and Pokorski, Witold and Przedzinski, Tomasz and Verbytskyi, Andrii}, | ||
| title = "{The HepMC3 event record library for Monte Carlo event generators}", | ||
| eprint = "1912.08005", | ||
| archivePrefix = "arXiv", | ||
| primaryClass = "hep-ph", | ||
| reportNumber = "MPP-2019-258, MCNET-19-27, LU-TP 19-58", | ||
| doi = "10.1016/j.cpc.2020.107310", | ||
| journal = "Comput. Phys. Commun.", | ||
| volume = "260", | ||
| pages = "107310", | ||
| year = "2021" | ||
| } | ||
|
|
||
| @article{Alwall:2006yp, | ||
| author = "Alwall, J. and others", | ||
| title = "{A Standard format for Les Houches event files}", | ||
| eprint = "hep-ph/0609017", | ||
| archivePrefix = "arXiv", | ||
| reportNumber = "FERMILAB-PUB-06-337-T, CERN-LCGAPP-2006-03", | ||
| doi = "10.1016/j.cpc.2006.11.010", | ||
| journal = "Comput. Phys. Commun.", | ||
| volume = "176", | ||
| pages = "300--304", | ||
| year = "2007" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: "pylhe: A Lightweight Python interface to read Les Houches Event files" | ||
| tags: | ||
| - python | ||
| - high energy physics | ||
| authors: | ||
| - name: Matthew Feickert | ||
| orcid: 0000-0003-4124-7862 | ||
| equal-contrib: true | ||
| affiliation: 1 | ||
| - name: Lukas Heinrich | ||
| orcid: 0000-0002-4048-7584 | ||
| equal-contrib: true | ||
| affiliation: 2 | ||
| - name: Eduardo Rodrigues | ||
| orcid: 0000-0003-2846-7625 | ||
| equal-contrib: true | ||
| affiliation: 3 | ||
| - name: Alexander Puck Neuwirth | ||
| orcid: 0000-0002-2484-1328 | ||
| equal-contrib: true | ||
| affiliation: "4, 5" | ||
|
|
||
| affiliations: | ||
| - name: University of Wisconsin-Madison | ||
| index: 1 | ||
| - name: Technical University of Munich | ||
| index: 2 | ||
| - name: University of Liverpool | ||
| index: 3 | ||
| - name: University of Milan Bicocca | ||
| index: 4 | ||
| - name: INFN Milan Bicocca | ||
| index: 5 | ||
| date: 6 November 2025 # APN TODO: update date | ||
| bibliography: paper.bib | ||
| --- | ||
|
|
||
| # Summary | ||
| <!-- APN TODO: check that all references in paper.bib are cited in the text --> | ||
| Some history/introduction history of different formats. HEPEVT -> LHEF -> HepMC -> HDF5? (since its binary maybe in the future? Unlike hepmc/lhe no need to gzip!) | ||
|
|
||
| The format is used by major Monte Carlo event generators such as MadGraph, POWHEG, Sherpa, HERWIG, Pythia ... <!-- APN TODO add references here--> | ||
| ... | ||
|
|
||
| Format is XML-like where the free text is designed to be easily parsed in fortran <!-- APN TODO: copy example form jupyter notebook 00_*.ipynb --> | ||
|
|
||
| ```xml | ||
| ``` | ||
|
|
||
| # Statement of need | ||
|
|
||
| ... | ||
|
|
||
| ## Impact | ||
|
|
||
| ... | ||
|
|
||
| # Acknowledgements | ||
|
|
||
| We would additionally like to thank the contributors of pylhe and the Scikit-HEP community for their support. | ||
|
|
||
| # Reference | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like you should be first author here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I totally agree. I am not familiar with the format but if the list items will match to an ordered list of authors a standard way would be to have Alexander as first and then everyone else in alphabetic order by family name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, that's how it ends up working in the render.
Example: https://github.com/scikit-hep/pyhf/blob/bc66d82e180f804324fcd7f40fbe9085a29f6a28/docs/JOSS/paper.md?plain=1#L10-L22 ->
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I added their action to render the PDF and upload it as an artifact. https://github.com/scikit-hep/pylhe/actions/runs/19242110752