jpata commited on
Commit
0acee68
·
verified ·
1 Parent(s): f337266

Document downloading hosted event scenes for local regeneration

Browse files
Files changed (1) hide show
  1. images/event_displays/README.md +15 -6
images/event_displays/README.md CHANGED
@@ -72,18 +72,27 @@ cover the five families above.
72
 
73
  ## Regeneration
74
 
75
- From the repository root:
76
 
77
  ```bash
78
  PYTHONPATH=. MPLCONFIGDIR=/tmp/pf-mpl .venv/bin/python scripts/create_reconstruction_event_assets.py
79
  ```
80
 
81
- To rerender the saved scenes without the original detector files:
 
82
 
83
  ```bash
84
- PYTHONPATH=. MPLCONFIGDIR=/tmp/pf-mpl .venv/bin/python scripts/create_reconstruction_event_assets.py --from-scenes
 
 
 
 
 
 
85
  ```
86
 
87
- Use `--source cld=/path/to/file.root` to override a source, `--event` to select a
88
- different event, and `--detectors` to choose families. ColliderML accepts an
89
- aligned raw-shard directory and optional `--colliderml-parquet` for saved clusters.
 
 
 
72
 
73
  ## Regeneration
74
 
75
+ From a checkout of the particleflow repository with locally available detector data:
76
 
77
  ```bash
78
  PYTHONPATH=. MPLCONFIGDIR=/tmp/pf-mpl .venv/bin/python scripts/create_reconstruction_event_assets.py
79
  ```
80
 
81
+ To reproduce the published events without the original detector files, download
82
+ the extracted scenes and render them locally:
83
 
84
  ```bash
85
+ hf download jpata/particleflow \
86
+ --include "images/event_displays/*/event_0_scene.json.gz" \
87
+ --include "images/event_displays/manifest.json" \
88
+ --local-dir local_test_data/event_assets
89
+
90
+ PYTHONPATH=. MPLCONFIGDIR=/tmp/pf-mpl .venv/bin/python scripts/create_reconstruction_event_assets.py \
91
+ --from-scenes --output-dir local_test_data/event_assets/images/event_displays
92
  ```
93
 
94
+ Use `--revision <commit>` with `hf download` to pin an asset version. The manifest
95
+ records scene SHA-256 hashes, source collections, event identifiers and display settings.
96
+ Use `--source cld=/path/to/file.root` to override a raw source, `--event` to select
97
+ an event and `--detectors` to choose families. ColliderML also accepts
98
+ `--colliderml-parquet` for saved clusters.