Skip to content

Commit f56b441

Browse files
Fixes for README on GitHub
Some of the LaTeX expressions were not rendering correctly, so try the $` expr `$ syntax
1 parent 0753d2e commit f56b441

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ cs = jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +, strat
2424
- Any type that supplies the methods `pt2()`, `phi()`, `rapidity()`, `px()`, `py()`, `pz()`, `energy()` can be used
2525
- These methods have to be defined in the namespace of this package, i.e., `JetReconstruction.pt2(::T)`
2626
- The `PseudoJet` type from this package, or a 4-vector from `LorentzVectorHEP` are suitable (and have the appropriate definitions)
27-
- `p` - the transverse momentum power used in the $d_{ij}$ metric for deciding on closest jets, as $k^{2p}_\text{T}$
28-
- `-1` gives anti-${k}_\text{T}$ clustering (default)
27+
- `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:
28+
- `-1` gives anti-$`{k}_\text{T}`$ clustering (default)
2929
- `0` gives Cambridge/Achen
3030
- `1` gives inclusive $k_\text{T}$
3131
- `R` - the cone size parameter; no particles more geometrically distance than `R` will be merged (default 1.0)
32-
- `recombine` - the function used to merge two pseudojets (default is a simple 4-vector addition of $(E, \mathbf{p})$)
32+
- `recombine` - the function used to merge two pseudojets (default is a simple 4-vector addition of $`(E, \mathbf{p})`$)
3333
- `strategy` - the algorithm strategy to adopt, as described below (default `JetRecoStrategy.Best`)
3434

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

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

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

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

78-
```julia
78+
```sh
7979
julia --project=. examples/jetreco.jl --maxevents=100 --nsamples=1 --strategy=N2Plain test/data/events.hepmc3
8080
...
8181
julia --project=. examples/jetreco.jl --maxevents=100 --nsamples=1 --strategy=N2Tiled test/data/events.hepmc3

0 commit comments

Comments
 (0)