Skip to content

Commit ce95e7f

Browse files
graeme-a-stewartgraeme-a-stewart
authored
Update input files to Zstd compression (#167)
1 parent 28a3e0d commit ce95e7f

File tree

56 files changed

+166
-134
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+166
-134
lines changed

‎README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,17 @@ Note that there is no `strategy` option in these interfaces.
8686

8787
### Examples
8888

89-
In the examples directory there are a number of example scripts.
89+
In the examples directory there are a number of example scripts (note there is a
90+
specific `Project.toml` for `examples`).
9091

9192
See the `jetreco.jl` script for an example of how to call jet reconstruction.
9293

9394
```sh
94-
julia --project=examples examples/jetreco.jl --algorithm=AntiKt test/data/events.pp13TeV.hepmc3.gz
95+
julia --project jetreco.jl --algorithm=AntiKt ../test/data/events.pp13TeV.hepmc3.zst
9596
...
96-
julia --project=examples examples/jetreco.jl --algorithm=Durham test/data/events.eeH.hepmc3.gz
97+
julia --project jetreco.jl --algorithm=Durham ../test/data/events.eeH.hepmc3.zst
9798
...
98-
julia --project=examples examples/jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 test/data/events.pp13TeV.hepmc3.gz
99+
julia --project jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 ../test/data/events.pp13TeV.hepmc3.zst
99100
...
100101
```
101102

‎docs/src/examples.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ browsed directly on
66
[GitHub](https://github.com/JuliaHEP/JetReconstruction.jl/tree/main/examples).
77

88
*Note:* because of extra dependencies in these scripts, one must use the
9-
`Project.toml` file in the `examples` directory.
9+
`Project.toml` file in the `examples` directory (or from `examples/FEATURE`
10+
where there is a further dependency, e.g., for visualisation).
11+
12+
In the following examples we assume that these are being run from the directory
13+
where the examples script is. Adjust the paths if you run from a different
14+
location.
1015

1116
## Standalone Basic Reconstruction Examples
1217

@@ -17,11 +22,11 @@ perform a jet reconstruction, with different algorithms and (optionally)
1722
strategy, producing exclusive and inclusive jet selections.
1823

1924
```sh
20-
julia --project=examples examples/jetreco.jl --algorithm=AntiKt test/data/events.pp13TeV.hepmc3.gz
25+
julia --project jetreco.jl --algorithm=AntiKt ../test/data/events.pp13TeV.hepmc3.zst
2126
...
22-
julia --project=examples examples/jetreco.jl --algorithm=Durham test/data/events.eeH.hepmc3.gz
27+
julia --project jetreco.jl --algorithm=Durham ../test/data/events.eeH.hepmc3.zst
2328
...
24-
julia --project=examples examples/jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 test/data/events.pp13TeV.hepmc3.gz
29+
julia --project jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 ../test/data/events.pp13TeV.hepmc3.zst
2530
...
2631
```
2732

@@ -35,7 +40,7 @@ profiling). Use the `--help` option to see usage. e.g., to extract timing
3540
performance for the AntiKt algorithm using the tiled strategy:
3641

3742
```sh
38-
julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3
43+
julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.pp13TeV.hepmc3.zst
3944
```
4045

4146
## Visualisation
@@ -54,7 +59,7 @@ This is a 3D plot where all the initial energy deposits are visualised, with
5459
colours that indicate in which final cluster the deposit ended up in.
5560

5661
```sh
57-
julia --project visualise-jets.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.png
62+
julia --project visualise-jets.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.zst test-pp.png
5863
```
5964

6065
### `visualise-jets.ipynb` and `visualise-jets-nb.ipynb`
@@ -72,7 +77,7 @@ Performs jet reconstruction and then produces and animation of the process,
7277
showing how the jets merge from their different constituents.
7378

7479
```sh
75-
julia --project animate-reconstruction.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.mp4
80+
julia --project animate-reconstruction.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.zst test-pp.mp4
7681
```
7782

7883
## EDM4hep

‎examples/benchmark.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
trials=${1:-16}
55

66
echo "pp 14TeV Tiled"
7-
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.gz -S N2Tiled -m $trials
7+
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.zst -S N2Tiled -m $trials
88

99
echo "pp 14 TeV Plain"
10-
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.gz -S N2Plain -m $trials
10+
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.zst -S N2Plain -m $trials
1111

1212
echo "ee H Durham"
13-
julia --project instrumented-jetreco.jl --algorithm=Durham ../test/data/events.eeH.hepmc3.gz -m $trials
13+
julia --project instrumented-jetreco.jl --algorithm=Durham ../test/data/events.eeH.hepmc3.zst -m $trials

‎examples/constituents/jetreco-constituents-nb.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Perform a simple reconstruction example and show how to retrieve constituent jet
1414

1515
# ╔═╡ 79f24ec1-a63e-4e96-bd67-49661125be66
1616
input_file = joinpath(dirname(pathof(JetReconstruction)), "..", "test", "data",
17-
"events.pp13TeV.hepmc3.gz")
17+
"events.pp13TeV.hepmc3.zst")
1818

1919
# ╔═╡ 7d7a8b11-19b3-4b83-a0b1-8201b74b588e
2020
events = read_final_state_particles(input_file)

‎examples/constituents/jetreco-constituents.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ logger = ConsoleLogger(stdout, Logging.Info)
99
global_logger(logger)
1010

1111
input_file = joinpath(dirname(pathof(JetReconstruction)), "..", "test", "data",
12-
"events.pp13TeV.hepmc3.gz")
12+
"events.pp13TeV.hepmc3.zst")
1313
events = read_final_state_particles(input_file)
1414

1515
# Event to pick

‎examples/substructure/jet-grooming.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using JetReconstruction
33

44
input_file = joinpath(dirname(pathof(JetReconstruction)),
5-
"..", "test", "data", "events.pp13TeV.hepmc3.gz")
5+
"..", "test", "data", "events.pp13TeV.hepmc3.zst")
66
events = read_final_state_particles(input_file)
77

88
# Event to pick

‎examples/substructure/jet-tagging.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using JetReconstruction
33

44
input_file = joinpath(dirname(pathof(JetReconstruction)),
5-
"..", "test", "data", "events.pp13TeV.hepmc3.gz")
5+
"..", "test", "data", "events.pp13TeV.hepmc3.zst")
66
events = read_final_state_particles(input_file)
77

88
# Event to pick

‎examples/test.sh‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
#! /bin/sh
22
# Simple test file to check that examples are running correctly
33
echo "pp 14TeV Tiled benchmark"
4-
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.gz -S N2Tiled -m 16
4+
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.zst -S N2Tiled -m 16
55

66
echo "pp 14 TeV Plain profile"
7-
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.gz -S N2Plain -m 2 --profile test
7+
julia --project instrumented-jetreco.jl --algorithm=AntiKt -R 0.4 ../test/data/events.pp13TeV.hepmc3.zst -S N2Plain -m 2 --profile test
88

99
echo "pp 14TeV CA"
10-
julia --project instrumented-jetreco.jl --algorithm=CA -R 1.0 ../test/data/events.pp13TeV.hepmc3.gz
10+
julia --project instrumented-jetreco.jl --algorithm=CA -R 1.0 ../test/data/events.pp13TeV.hepmc3.zst
1111

1212
echo "pp 14TeV Kt"
13-
julia --project instrumented-jetreco.jl --algorithm=Kt -R 1.0 ../test/data/events.pp13TeV.hepmc3.gz
13+
julia --project instrumented-jetreco.jl --algorithm=Kt -R 1.0 ../test/data/events.pp13TeV.hepmc3.zst
1414

1515
echo "ee H Durham allocation test"
16-
julia --project instrumented-jetreco.jl --algorithm=Durham --alloc ../test/data/events.eeH.hepmc3.gz
16+
julia --project instrumented-jetreco.jl --algorithm=Durham --alloc ../test/data/events.eeH.hepmc3.zst
1717

1818
echo "pp basic reco test"
19-
julia --project jetreco.jl --algorithm=CA -R 1.0 ../test/data/events.pp13TeV.hepmc3.gz
19+
julia --project jetreco.jl --algorithm=CA -R 1.0 ../test/data/events.pp13TeV.hepmc3.zst
2020

2121
echo "ee basic reco test"
22-
julia --project jetreco.jl --algorithm=EEKt -R 1.0 -p -1.0 ../test/data/events.eeH.hepmc3.gz
22+
julia --project jetreco.jl --algorithm=EEKt -R 1.0 -p -1.0 ../test/data/events.eeH.hepmc3.zst
2323

‎examples/visualisation/test.sh‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#! /bin/sh
22
# Simple test file to check that examples are running correctly
33
echo "pp visualisation"
4-
julia --project visualise-jets.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.png
4+
julia --project visualise-jets.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.zst test-pp.png
55

66
echo "e+e- visualisation"
7-
julia --project visualise-jets.jl -A Durham ../../test/data/events.eeH.hepmc3.gz test-ee.png
7+
julia --project visualise-jets.jl -A Durham ../../test/data/events.eeH.hepmc3.zst test-ee.png
88

99
echo "pp animation"
10-
julia --project animate-reconstruction.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.mp4
10+
julia --project animate-reconstruction.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.zst test-pp.mp4
1111

1212
echo "e+e- animation"
13-
julia --project animate-reconstruction.jl -A Durham ../../test/data/events.eeH.hepmc3.gz test-eeH.mp4
13+
julia --project animate-reconstruction.jl -A Durham ../../test/data/events.eeH.hepmc3.zst test-eeH.mp4

‎examples/visualisation/visualise-jets-nb.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ md"Jet radius parameter"
5252

5353
# ╔═╡ 79f24ec1-a63e-4e96-bd67-49661125be66
5454
input_file = joinpath(dirname(pathof(JetReconstruction)), "..", "test", "data",
55-
"events.pp13TeV.hepmc3.gz")
55+
"events.pp13TeV.hepmc3.zst")
5656

5757
# ╔═╡ 7d7a8b11-19b3-4b83-a0b1-8201b74b588e
5858
events::Vector{Vector{PseudoJet}} = read_final_state_particles(input_file,

0 commit comments

Comments
 (0)