diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..e99cbad --- /dev/null +++ b/CITATION.cff @@ -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: graeme.andrew.stewart@cern.ch + affiliation: CERN + orcid: 'https://orcid.org/0000-0003-0182-7088' + - given-names: Atell + family-names: Krasnopolski + email: delta_atell@protonmail.com + orcid: 'https://orcid.org/0009-0009-9336-0219' + - given-names: Philippe + family-names: Gras + email: philippe.gras@cern.ch + orcid: 'https://orcid.org/0000-0002-3932-5967' + - given-names: Benedikt + family-names: Hegner + email: benedikt.hegner@cern.ch + 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 diff --git a/README.md b/README.md index c8cff34..b5f0e3d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Algorithms used are based on the C++ FastJet package (, [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 @@ -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})`$) diff --git a/examples/jetreco.jl b/examples/jetreco.jl index f4d4aa2..e656529 100644 --- a/examples/jetreco.jl +++ b/examples/jetreco.jl @@ -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 @@ -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"