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

Add initial CITATION.cff file #45

Merged
merged 3 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
28 changes: 28 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
cff-version: 1.2.0
title: JetReconstruction.jl
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Graeme Andrew
family-names: Stewart
email: [email protected]
affiliation: CERN
orcid: 'https://orcid.org/0000-0003-0182-7088'
- given-names: Atell
family-names: Krasnopolski
email: [email protected]
orcid: 'https://orcid.org/0009-0009-9336-0219'
- given-names: Philippe
family-names: Gras
email: [email protected]
orcid: 'https://orcid.org/0000-0002-3932-5967'
- given-names: Benedikt
family-names: Hegner
email: [email protected]
affiliation: CERN
orcid: 'https://orcid.org/0009-0009-2020-1620'
repository-code: 'https://github.com/JuliaHEP/JetReconstruction.jl'
abstract: Jet reconstruction (reclustering) with Julia
license: MIT
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Algorithms used are based on the C++ FastJet package (<https://fastjet.fr>,
[hep-ph/0512210](https://arxiv.org/abs/hep-ph/0512210),
[arXiv:1111.6097](https://arxiv.org/abs/1111.6097)), reimplemented natively in Julia.

The algorithms include anti-${k}_\text{T}$, Cambridge/Achen and inclusive $k_\text{T}$.
The algorithms include anti-${k}_\text{T}$, Cambridge/Aachen and inclusive $k_\text{T}$.

### Interface

Expand All @@ -26,7 +26,7 @@ cs = jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +, strat
- The `PseudoJet` type from this package, or a 4-vector from `LorentzVectorHEP` are suitable (and have the appropriate definitions)
- `p` - the transverse momentum power used in the $d_{ij}$ metric for deciding on closest jets, as $k^{2p}_\text{T}$. Different values of $p$ then give different reconstruction algorithms:
- `-1` gives anti-$`{k}_\text{T}`$ clustering (default)
- `0` gives Cambridge/Achen
- `0` gives Cambridge/Aachen
- `1` gives inclusive $k_\text{T}$
- `R` - the cone size parameter; no particles more geometrically distance than `R` will be merged (default 1.0)
- `recombine` - the function used to merge two pseudojets (default is a simple 4-vector addition of $`(E, \mathbf{p})`$)
Expand Down
4 changes: 2 additions & 2 deletions examples/jetreco.jl
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ parse_command_line(args) = begin
default = 0.4

"--power"
help = "Distance measure momentum power (-1 - antikt; 0 - Cambridge/Achen; 1 - inclusive k_t)"
help = "Distance measure momentum power (-1 - antikt; 0 - Cambridge/Aachen; 1 - inclusive k_t)"
arg_type = Int
default = -1

Expand Down Expand Up @@ -220,7 +220,7 @@ parse_command_line(args) = begin
action = :store_true

"--dump"
help = "Write list of recontructed jets to a JSON formatted file"
help = "Write list of reconstructed jets to a JSON formatted file"

"--info"
help = "Print info level log messages"
Expand Down
Loading