Skip to content

Commit

Permalink
Fixes for README on GitHub
Browse files Browse the repository at this point in the history
Some of the LaTeX expressions were not
rendering correctly, so try the $` expr `$ syntax
  • Loading branch information
graeme-a-stewart committed Apr 23, 2024
1 parent 0753d2e commit f56b441
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ cs = jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +, strat
- Any type that supplies the methods `pt2()`, `phi()`, `rapidity()`, `px()`, `py()`, `pz()`, `energy()` can be used
- These methods have to be defined in the namespace of this package, i.e., `JetReconstruction.pt2(::T)`
- 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}$
- `-1` gives anti-${k}_\text{T}$ clustering (default)
- `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
- `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})$)
- `recombine` - the function used to merge two pseudojets (default is a simple 4-vector addition of $`(E, \mathbf{p})`$)
- `strategy` - the algorithm strategy to adopt, as described below (default `JetRecoStrategy.Best`)

The object returned is a `ClusterSequence`, which internally tracks all merge steps.
Expand Down Expand Up @@ -65,7 +65,7 @@ Generally one can use the `jet_reconstruct` interface, shown above, as the *Best
Another option, if one wishes to use a specific strategy, is to call that strategy's interface directly, e.g.,

```julia
# N2Plain
# For N2Plain strategy called directly
plain_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +)
```

Expand All @@ -75,7 +75,7 @@ Note that there is no `strategy` option in these interfaces.

See the `examples/jetreco.jl` script for a full example of how to call jet reconstruction.

```julia
```sh
julia --project=. examples/jetreco.jl --maxevents=100 --nsamples=1 --strategy=N2Plain test/data/events.hepmc3
...
julia --project=. examples/jetreco.jl --maxevents=100 --nsamples=1 --strategy=N2Tiled test/data/events.hepmc3
Expand Down

0 comments on commit f56b441

Please sign in to comment.