Morgan Taylor commited on
Commit
53040dd
·
1 Parent(s): 83880a1

edit readme for simplicity

Browse files
Files changed (1) hide show
  1. README.md +3 -18
README.md CHANGED
@@ -120,7 +120,7 @@ python scripts/piv_vs_hwa_paper.py \
120
  ```
121
 
122
  These exact commands, run against the shipped `reference_results/`, reproduce the paper
123
- figures byte-for-byte on the authors' machine (fonts permitting: the scripts prefer
124
  CMU Serif and fall back to DejaVu). Quote the `--inst-labels` arguments exactly as shown
125
  (single quotes) so your shell does not eat the `$` characters.
126
 
@@ -212,10 +212,7 @@ modes explore worker×thread trade-offs beyond the paper's sweep — see
212
  `pivtools-bench scaling --help`.)
213
 
214
  Throughput numbers are hardware-dependent: the paper's peak of 117 pairs/s was
215
- measured on a 192-core dual-EPYC node, and your core count sets your ceiling. The
216
- scaling *shape* — near-linear until the memory bandwidth of the machine saturates —
217
- is the reproducible claim. On a cluster, wrap this same command in your scheduler
218
- of choice; nothing about it is scheduler-specific.
219
 
220
  ## Tier 3 — re-derive the calibration models
221
 
@@ -234,9 +231,7 @@ pivtools-cli detect-stereo --source ./tc/calibration/stereo --camera-pair 1,2 \
234
 
235
  The synthetic boards are rendered through the same camera models that rendered the
236
  particle images, so the recovered calibration corresponds exactly to the imaging system
237
- (`calibration/stereo/ground_truth.npz` holds the true cameras; expected recovery:
238
- stereo angle ≈ 89.9° vs the true 90.0°, RMS < 0.1 px). Detection writes proof figures
239
- beside the model.
240
 
241
  The experimental case uses a uniform scale-factor model rather than a fitted camera. The
242
  shipped model (`calibration/experimental/calibration/Cam1/scale_factor_planar/model/`)
@@ -308,17 +303,7 @@ experimental figure needs:
308
  | `lplus` | wire length in wall units (45.6) |
309
  | `nu_air` | kinematic viscosity (m²/s) |
310
 
311
- The figure plots the uncorrected variance deliberately: at l+ ≈ 46 the wire attenuates
312
- the near-wall peak, and the comparison discusses that rather than hiding it behind a
313
- correction.
314
 
315
- ## Image orientation
316
-
317
- There are no masks: the stereo renders fill the full frame and the planar images are
318
- full-field. Both synthetic geometries read physically — the channel wall is at the bottom
319
- row, fast flow at the top. The stereo renders have a single deterministic vertical flip
320
- composed into both the images and the calibration boards, so calibration and images are
321
- consistent. Do not flip anything downstream.
322
 
323
  ## Provenance
324
 
 
120
  ```
121
 
122
  These exact commands, run against the shipped `reference_results/`, reproduce the paper
123
+ figures (fonts permitting: the scripts prefer
124
  CMU Serif and fall back to DejaVu). Quote the `--inst-labels` arguments exactly as shown
125
  (single quotes) so your shell does not eat the `$` characters.
126
 
 
212
  `pivtools-bench scaling --help`.)
213
 
214
  Throughput numbers are hardware-dependent: the paper's peak of 117 pairs/s was
215
+ measured on a 192-core dual-EPYC node, and your core count sets your ceiling.
 
 
 
216
 
217
  ## Tier 3 — re-derive the calibration models
218
 
 
231
 
232
  The synthetic boards are rendered through the same camera models that rendered the
233
  particle images, so the recovered calibration corresponds exactly to the imaging system
234
+ (`calibration/stereo/ground_truth.npz`) holds the true cameras.
 
 
235
 
236
  The experimental case uses a uniform scale-factor model rather than a fitted camera. The
237
  shipped model (`calibration/experimental/calibration/Cam1/scale_factor_planar/model/`)
 
303
  | `lplus` | wire length in wall units (45.6) |
304
  | `nu_air` | kinematic viscosity (m²/s) |
305
 
 
 
 
306
 
 
 
 
 
 
 
 
307
 
308
  ## Provenance
309