Merge branch 'JuliaHEP:main' into substructure

Author: sattwamo

docs/src/examples.md

@@ -8,7 +8,7 @@ browsed directly on
 *Note:* because of extra dependencies in these scripts, one must use the
 `Project.toml` file in the `examples` directory.
 
-## Standalone Examples
+## Standalone Basic Reconstruction Examples
 
 ### `jetreco.jl`
 
@@ -38,24 +38,43 @@ performance for the AntiKt algorithm using the tiled strategy:
 julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3
 ```
 
+## Visualisation
+
+This subdirectory contains examples showing how to use built in support for
+visualising jets - either a final reconstruction state or an animation of the
+reconstruction process.
+
+Particularly here the heavy Makie dependency is contained in the `Project.toml`
+file for these examples only.
+
 ### `visualise-jets.jl`
 
 This script will produce a PNG/PDF showing the results of a jet reconstruction.
 This is a 3D plot where all the initial energy deposits are visualised, with
 colours that indicate in which final cluster the deposit ended up in.
 
-### `visualise-jets.ipynb`
+```sh
+julia --project visualise-jets.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.png
+```
+
+### `visualise-jets.ipynb` and `visualise-jets-nb.ipynb`
+
+Similar to `visualise-jets.jl` these notebooks will produce a visualisation of
+jet reconstruction in the browser. This is a 3D plot where all the initial
+energy deposits are visualised, with colours that indicate in which final
+cluster the deposit ended up in.
 
-Similar to `visualise-jets.jl` this notebook will produce a visualisation of jet
-reconstruction in the browser. This is a 3D plot where all the initial energy
-deposits are visualised, with colours that indicate in which final cluster the
-deposit ended up in.
+The first example is a Jupyter notbook, the second runs in Pluto.
 
 ### `animate-reconstruction.jl`
 
 Performs jet reconstruction and then produces and animation of the process,
 showing how the jets merge from their different constituents.
 
+```sh
+julia --project animate-reconstruction.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.mp4
+```
+
 ## EDM4hep
 
 The `examples/EDM4hep` folder contains examples of using EDM4hep reconstructed

examples/Project.toml

@@ -1,16 +1,10 @@
 [deps]
 ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
-CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 FlameGraphs = "08572546-2f56-4bcf-ba4e-bab62c3a3f89"
-GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 JetReconstruction = "44e8cb2c-dfab-4825-9c70-d4808a591196"
 LorentzVectorHEP = "f612022c-142a-473f-8cfd-a09cf3793c6c"
-Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
-Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
-PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
 Profile = "9abbd945-dff8-562f-b5e8-e1ebf5ef1b79"
 ProfileSVG = "132c30aa-f267-4189-9183-c8a63c7e05e6"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 StatProfilerHTML = "a8a75453-ed82-57c9-9e16-4cd1196ecbf5"

examples/README.md

@@ -1,7 +1,7 @@
 # JetReconstruction.jl Examples
 
-This directory has a number of example files that show how to used the
-`JetReconstruction.jl` package.
+This directory and subdirectories have a number of example files that show how
+to used the `JetReconstruction.jl` package.
 
 Because of extra dependencies in these scripts, one must use the `Project.toml`
 file in this directory.
@@ -20,20 +20,3 @@ strategy, producing exclusive and inclusive jet selections.
 This is a more sophisticated example that allows performance measurements to be
 made of the reconstruction, as well as profiling (flamegraphs and memory
 profiling).
-
-## `visualise-jets.jl`
-
-This script will produce a PNG/PDF showing the results of a jet reconstruction.
-This is a 3D plot where all the initial energy deposits are visualised, with
-colours that indicate in which final cluster the deposit ended up in.
-
-## `visualise-jets.ipynb`
-
-This notebook will produce a visualisation of jet reconstruction in the browser.
-This is a 3D plot where all the initial energy deposits are visualised, with
-colours that indicate in which final cluster the deposit ended up in.
-
-## `animate-reconstruction.jl`
-
-Performs jet reconstruction and then produces and animation of the process,
-showing how the jets merge from their different constituents.

examples/benchmark.sh

@@ -0,0 +1,11 @@
+#! /bin/sh
+#
+# Quick and dirty set of benchmarks for the most important cases
+echo "pp 14TeV Tiled"
+julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.gz -S N2Tiled -m 16
+
+echo "pp 14 TeV Plain"
+julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.gz -S N2Plain -m 16
+
+echo "ee H Durham"
+julia --project instrumented-jetreco.jl --algorithm=Durham ../test/data/events.eeH.hepmc3.gz -m 16